{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"bdd6c32e-63d7-4a15-a99d-0c21a2d91786","name":"HellHub API","description":"## What is the purpose of this API?\n\nThe HellHub API is a community-driven project that strives to provide easy access to the [Helldivers 2 ](https://store.steampowered.com/app/553850/HELLDIVERS_2/) data. This project is part of the [HellHub Collective](https://github.com/hellhub-collective/api) and democratically approved by the ministry of development.\n\n[<img src=\"https://run.pstmn.io/button.svg\">](https://app.getpostman.com/run-collection/33840175-bdd6c32e-63d7-4a15-a99d-0c21a2d91786?action=collection/fork&source=rip_markdown&collection-url=entityId=33840175-bdd6c32e-63d7-4a15-a99d-0c21a2d91786&entityType=collection&workspaceId=e406a520-6ab3-409f-814d-982957037cbb#?env%5BProduction%5D=W3sia2V5IjoiYXBpX3VybCIsInZhbHVlIjoiaHR0cHM6Ly9hcGktaGVsbGh1Yi1jb2xsZWN0aXZlLmtveWViLmFwcCIsImVuYWJsZWQiOnRydWUsInR5cGUiOiJkZWZhdWx0Iiwic2Vzc2lvblZhbHVlIjoiaHR0cHM6Ly9hcGktaGVsbGh1Yi1jb2xsZWN0aXZlLmtveWViLmFwcCIsInNlc3Npb25JbmRleCI6MH1d)\n\n## Fair use limitations\n\nTo enforce fair use, we have implemented a rate limiter. The HellHub API has a rate limit of **200 requests per minute**. To avoid hitting rate limits in your clients check the following headers in your response:\n\n- `X-Rate-Remaining`: The number of requests remaining.\n- `X-Rate-Limit`: The maximum number of requests per minute.\n- `X-Rate-Reset`: The time at which the current rate limit resets.\n- `X-Rate-Count`: The number of requests made in the current minute.\n    \n\nWe reserve the right to block any IP address that uses the API in a way that is not fair to other users, or that is trying to abuse the system.\n\n## Query documentation\n\nOur API allows you to query the data in a flexible way. You can filter, sort, select fields, include relations, and paginate the results. Don't want to deal with query construction? No problem! Try our [TypeScript SDK](https://github.com/hellhub-collective/sdk).\n\n### Filtering results\n\nFilter results by using the `filters` query parameter. Let's say you want to get all the planets that contain \"creek\" in their name. You can do it like this:\n\n``` bash\n/api/planets?filters[name][contains]=creek\n\n ```\n\nAs you can see, we use square brackets to specify the field we want to filter by. In this case, we are filtering by the `name` field. The `contains` operator checks if the field contains the specified value. If you need to provide an array for an operator you would use it like this:\n\n``` bash\n/api/planets?filters[name][in][0]=Earth&filters[name][in][1]=Mars\n\n ```\n\n#### Available operators\n\n| Operator | Description |\n| --- | --- |\n| not | Field does **not** match a value. |\n| equals | Field does match a value. |\n| in | Field has one of the values. |\n| notIn | Field does **not** have one of the values. |\n| lt | Field is less than value. |\n| gt | Field is greater than value. |\n| lte | Field is less or equal to value. |\n| gte | Field is greater or equal to value. |\n| search | Full text search |\n| contains | Field contains value. |\n| endsWith | Field ends with value. |\n| startsWith | Field starts with value. |\n\n### Sorting results\n\nSort results by using the `sort` query parameter. Let's say you want to get all the planets sorted by their name in descending order. You can do it like this:\n\n```\n/api/planets?sort[name]=desc\n\n ```\n\n### Selecting fields\n\nPrevent over-fetching: You can select only the fields you need by using the `fields` query parameter. Let's say you want to get only the name and id of all the planets. You can do it like this:\n\n```\n/api/planets?fields[0]=name&fields[1]=id\n\n ```\n\n### Including relations\n\nIinclude relations of the results by using the `include` query parameter. Let's say you want to get all the planets and include their sector and biome. You can do it like this:\n\n```\n/api/planets?include[0]=sector&include[1]=biome\n\n ```\n\n### Paginating results\n\nPaginate through results by using the `start` and `limit` query parameters. Let's say you want to get the second page of planets with a limit of 10 per page. You can do it like this:\n\n```\n/api/planets?start=10&limit=10\n\n ```\n\n## Using data inside your application\n\nIf you are using [TypeScript](https://github.com/microsoft/TypeScript) you. may want to consider using our type safe and autocomplete ready [HellHub SDK](https://github.com/hellhub-collective/sdk). You can use the exported `HellHub` class to interact with the HellHub API. For example, you can use the `planets` method to retrieve a single or a list of planets:\n\n``` typescript\nimport HellHub from \"@hellhub-collective/sdk\";\n// get the planet with id 1\nconst response = await HellHub.planets(1);\n// get a list of all planets\nconst response = await HellHub.planets();\n// get a list of planets with a filter and limit\nconst response = await HellHub.planets({\n  limit: 15,\n  filters: { name: { $contains: \"Earth\" } },\n});\n\n ```\n\n## Scripting, tests and automation\n\nIf you are building a terminal application or want easy access to a visual representation of the data inside our API you can use our [CLI](https://github.com/hellhub-collective/cli). Check it out:\n\n<img src=\"https://raw.githubusercontent.com/hellhub-collective/cli/main/assets/example-response.png\" alt=\"Displaying%20statistics%20for%20all%20planets%20that%20contain%20the%20letter%20(a)\">\n\nWe also provide a \\`--raw\\` flag for each command that allows you to output pure JSON that can be used by your script for testing or automation purposes.\n\n## Disclaimer\n\nThe unofficial game API was not explicitly made usable by Arrowhead Game Studios for third parties and thus may be subject to change at any time. This project will be updated to reflect any changes to the data source.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":true,"owner":"33840175","team":6120183,"collectionId":"bdd6c32e-63d7-4a15-a99d-0c21a2d91786","publishedId":"2sA35Bd54w","public":true,"publicUrl":"https://documenter-api.postman.tech/view/33840175/2sA35Bd54w","privateUrl":"https://go.postman.co/documentation/33840175-bdd6c32e-63d7-4a15-a99d-0c21a2d91786","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"BEAE0B"},"documentationLayout":"classic-single-column","customisation":{"metaTags":[{"name":"description","value":"Effortlessly access Helldivers 2 data. Get information about planets, stratagems, orders, and more. Easy to use, open source and requires no authentication."},{"name":"title","value":"HellHub API - Use Helldivers 2 data in your apps"}],"appearance":{"default":"dark","themes":[{"name":"dark","logo":"https://content.pstmn.io/5b8efe12-1016-4504-9a6d-47f67376b1f3/bG9nby5wbmc=","colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FFE900"}},{"name":"light","logo":"https://content.pstmn.io/5b8efe12-1016-4504-9a6d-47f67376b1f3/bG9nby5wbmc=","colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"BEAE0B"}}]}},"version":"8.10.1","publishDate":"2024-03-26T08:32:51.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"HellHub API - Use Helldivers 2 data in your apps","description":"Effortlessly access Helldivers 2 data. Get information about planets, stratagems, orders, and more. Easy to use, open source and requires no authentication."},"logos":{"logoLight":"https://content.pstmn.io/5b8efe12-1016-4504-9a6d-47f67376b1f3/bG9nby5wbmc=","logoDark":"https://content.pstmn.io/5b8efe12-1016-4504-9a6d-47f67376b1f3/bG9nby5wbmc="}},"statusCode":200},"environments":[{"name":"Production","id":"b5fe7787-3251-41fa-b1d4-7fdb24007887","owner":"33840175","values":[{"key":"api_url","value":"https://api-hellhub-collective.koyeb.app","enabled":true,"type":"default"},{"key":"datasource_url","value":"https://api.live.prod.thehelldiversgame.com/api","enabled":true,"type":"default"}],"published":true}],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/1d15b0c74bf915e91792031f6bed80e3df8714bcffa3f765b511de8a0b1e6b6e","favicon":""},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"},{"label":"Production","value":"33840175-b5fe7787-3251-41fa-b1d4-7fdb24007887"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/2sA35Bd54w"}