General
Endpoints
General
Introduction
Welcome to my API, this API is still under development and can change at any time.
Getting Started
All calls to the API should include a valid api key. Without a key you will not be able to retrieve data from the API. Example:
http://api.michel3951.com/api/v1/test?apikey=yourkey
This will return a JSON with a status, message and content.
{"status":200,"message":"OK","content":null}
Rate Limits
An user is allowed up to 60 request per minute, these requests go for all endpoints. If you need more then 60 requests, please contact me.
Endpoints
Defense Unit
Previously Defense Unit used dododex and gamepedia as primary source to get information and more. But since those sites do not have an API you'd have to scrape the website. So now Defense Unit has it's own API for taming and creature information
Knockout
The knockout endpoint will calculate the requirements to knock the creature out.
GET /api/v1/ark/knockoutThis endpoint is done and will not change in the near future.
Parameter | Description |
---|---|
creature * |
The full name of the creature (Including spaces). |
level |
The level of the creature, if not provided the default will be 150. |
* required |
Attribute | Type | Description | Example |
---|---|---|---|
status |
integer | The HTTP status code | 200 |
message |
string | The message that was returned from the request, this will contain an error if the status code does not equal 200 | "OK" |
content |
array | The array with requested data from this endpoint | [...] |
content.name |
string | The creature name | "Rex" |
content.level |
integer | The level of the creature | 120 |
content.violent |
boolean | Will return true if the creature is hostile | true |
content.knockout |
array | The array with knockout data | [...] |
content.knockout[index] |
object | A JSON object containing the weapon name, weapon damage, weapon torpor and amount of ammo | {...} |
{ "status": 200, "message": "OK", "content": { "name": "Rex", "level": 120, "violent": true, "knockout": [ { "name": "Bow (Tranq Arrow)", "torpor": 90, "damage": 20, "amount": 141 }, { "name": "Compound Bow (Tranq Arrow)", "torpor": 121.5, "damage": 27, "amount": 104 }, { "name": "Crossbow (Tranq Arrow)", "torpor": 157.5, "damage": 35, "amount": 81 }, { "name": "Longneck Rifle (Tranq Dart)", "torpor": 221, "damage": 26, "amount": 58 }, { "name": "Harpoon Launcher (Tranq Spear Bolt)", "torpor": 306, "damage": 36, "amount": 42 }, { "name": "Longneck Rifle (Shocking Tranq Dart)", "torpor": 522, "damage": 26, "amount": 25 }, { "name": "Bow (Toxicant Arrow)", "torpor": 182.5, "damage": 27, "amount": 70 }, { "name": "Crossbow (Toxicant Arrow)", "torpor": 182.5, "damage": 35, "amount": 70 } ] } }
Dossier
The dossier endpoint will provide a dossier for the given creature, along with an image of the dossier.
GET /api/v1/ark/dossierThis endpoint is done and will not change in the near future.
Parameter | Description |
---|---|
creature * |
The full name of the creature (Including spaces). |
* required |
Attribute | Type | Description | Example |
---|---|---|---|
status |
integer | The HTTP status code | 200 |
message |
string | The message that was returned from the request, this will contain an error if the status code does not equal 200 | "OK" |
content |
array | The array with requested data from this endpoint | [...] |
content.name |
string | The creature name | "Rex" |
content.text |
string | The text of this dossier | "\nWild\nArguably the deadliest creature on the Island, Tyrannosaurus dominum is a..." |
content.url |
string | The gamepedia URL to this dossier | "https://ark.gamepedia.com/Rex" |
content.image |
string | A string with the image of this dossier | "https://gamepedia.cursecdn.com/arksurvivalevolved_gamepedia/4/42/Dossier_Rex.png" |
{ "status": 200, "message": "OK", "content": { "name": "Rex", "text": "\nWild\nArguably the deadliest creature on the Island, Tyrannosaurus dominum is a killing machine. Active mostly when hunting for food or defending its nest, a good plan is to avoid every Tyrannosaurus.\nIt is pure power -- from its stomp to its tail. It is not able to intimidate every foe with its roar, but upon hearing it, it might scare the poop out of you - quite literally.\nDespite being a different sub-species of Tyrannosaurus, everyone I've met still refers to them as a 'Rex' or a 'T-Rex'. I've long since stopped trying to convince anyone, especially the few who I've encountered wearing Tyrannosaurus teeth as necklaces.\nDomesticated\nTaming a Tyrannosaurus is without a doubt the goal for any warlord or warring tribe. Tyrannosaurus is a fierce battle companion. There is a reason Tyrannosaurus is considered the king of dinosaurs (or in this genus, the 'lord'). Any tribe that manages to tame one has almost nothing to fear.\n", "url": "https://ark.gamepedia.com/Rex", "image": "https://gamepedia.cursecdn.com/arksurvivalevolved_gamepedia/4/42/Dossier_Rex.png" } }
Basic
The basic endpoint will return the basic information for a creature.
GET /api/v1/ark/basicThis endpoint is done and will not change in the near future.
Parameter | Description |
---|---|
creature * |
The full name of the creature (Including spaces). |
* required |
Attribute | Type | Description | Example |
---|---|---|---|
status |
integer | The HTTP status code | 200 |
message |
string | The message that was returned from the request, this will contain an error if the status code does not equal 200 | "OK" |
content |
array | A json object with the requested data from this endpoint | {...} |
content.name |
string | The creature name | "Rex" |
content.group |
string | The group this creature belongs to | "Dinosaurs" |
content.diet |
string | The diet this creature has | "Carnivore" |
content.temperament |
string | The temperament of this creature | "Aggressive" |
content.tameable |
boolean | Wether the creature can be tamed or not | true |
content.rideable |
boolean | Wether the creature is rideable or not | true |
content.breedable |
boolean | Wether the creature is breedable or not | true |
content.saddleLevel |
string | null | The player level that is required to craft the saddle. Will return null if the saddle cannot be crafted | "74" |
content.fecesSize |
string | null | The size of the feces. Will return null if the creature does not poop. | "Large" |
content.entityId |
string | The ID of this creature | "Rex_Character_BP_C" |
{ "status": 200, "message": "OK", "content": { "name": "Rex", "group": "Dinosaurs", "diet": "Carnivore", "temperament": "Aggressive", "tameable": true, "rideable": true, "breedable": true, "saddleLevel": "74", "fecesSize": "Large", "entityId": "Rex_Character_BP_C" } }
Kibble
The kibble endpoint will return the information for a kibble type.
GET /api/v1/ark/kibbleThis endpoint is done and will not change in the near future.
Parameter | Description |
---|---|
name * |
The name of the kibble (including spaces). |
* required |
Attribute | Type | Description | Example |
---|---|---|---|
status |
integer | The HTTP status code | 200 |
message |
string | The message that was returned from the request, this will contain an error if the status code does not equal 200 | "OK" |
content |
array | A json object with the requested data from this endpoint | {...} |
content.name |
string | The short name | "basic" |
content.fullName |
string | The full name | "Basic Kibble" |
content.creatures |
array | A list of creatures that drop the egg for this kibble | [...] |
content.preferred |
array | A list of creatures that eat this kibble | [...] |
content.recipe |
array | A list of items required to craft this kibble | [...] |
content.recipe[index] |
object | A json object of the item and quantity. | {...} |
{ "name": "basic", "fullName": "Basic Kibble", "creatures": [ "Dilophosaur", "Dodo", "Featherlight", "Kairuku", "Lystrosaurus", "Parasaur", "Vulture" ], "preferred": [ "Dilophosaur", "Dodo", "Featherlight", "Glowtail", "Kairuku", "Lystrosaurus", "Mesopithecus", "Parasaur", "Phiomia", "Vulture" ], "recipe": [ { "name": "Extra Small Egg", "quantity": 1 }, { "name": "Cooked Meat", "quantity": 1 }, { "name": "Amar Berry", "quantity": 10 }, { "name": "Mejoberry", "quantity": 5 }, { "name": "Tintoberry", "quantity": 10 }, { "name": "Fiber", "quantity": 5 }, { "name": "Water Skin (Full)", "quantity": 1 } ] }
Item
The item endpoint will return information about an item and the ingredients that are needed to craft the item
GET /api/v1/ark/itemThis endpoint is done and will not change in the near future.
Parameter | Description |
---|---|
name * |
The name of the item (including spaces). |
* required |
Attribute | Type | Description | Example |
---|---|---|---|
status |
integer | The HTTP status code | 200 |
message |
string | The message that was returned from the request, this will contain an error if the status code does not equal 200 | "OK" |
content |
array | A json object with the requested data from this endpoint | {...} |
content.name |
string | The name of the item | "Element" |
content.image |
string | A link with the image of this item | "url" |
content.level |
integer | The level the player needs to be to learn this item | 0 |
content.engramPoints |
integer | The amount of engram points that are required to learn this | 0 |
content.ingredients |
array | A list of resources that are required to make this item | [...] |
content.ingredients[index] |
object | A json object of the item and quantity. | {...} |
| array | An array of wokr areas where the item can be crafted in, will return null if the item can be crafted in the inventory | [...] |
content.prerequisite |
string | The engram that needs to be learned before you can craft this item, will return null if it can be crafted without a prerequiste | "Flare Gun" |
content.experience |
integer | The experience gained after crafting the item | 13 |
Saddle
The saddle endpoint will return information about an item and the ingredients that are needed to craft the saddle
GET /api/v1/ark/saddleThis endpoint is done and will not change in the near future.
Parameter | Description |
---|---|
name * |
The name of the item (including spaces). |
* required |
Attribute | Type | Description | Example |
---|---|---|---|
status |
integer | The HTTP status code | 200 |
message |
string | The message that was returned from the request, this will contain an error if the status code does not equal 200 | "OK" |
content |
array | A json object with the requested data from this endpoint | {...} |
content.name |
string | The name of the item | "Element" |
content.image |
string | A link with the image of this item | "url" |
content.level |
integer | The level the player needs to be to learn this item | 0 |
content.engramPoints |
integer | The amount of engram points that are required to learn this saddle | 0 |
content.ingredients |
array | A list of resources that are required to make this saddle | [...] |
content.ingredients[index] |
object | A json object of the item and quantity. | {...} |
| array | An array of work areas where the item can be crafted in, will return null if the item can be crafted in the inventory | [...] |
content.prerequisite |
string | The engram that needs to be learned before you can craft this item, will return null if it can be crafted without a prerequiste | "Flare Gun" |
content.experience |
integer | The experience gained after crafting the item | 13 |
Server
The server endpoint will return information about an official ARK server. There is no support for PC or PS4 as there are no official public API's for this.
There is no example response provided as the content may vary depending on the platform
GET /api/v1/ark/serverThis endpoint is done and will not change in the near future.
Parameter | Description |
---|---|
platform * |
The platform the server is on (xbox mobile or switch). |
name[] |
The name of the server. |
* required |
Attribute | Type | Description | Example |
---|---|---|---|
status |
integer | The HTTP status code | 200 |
message |
string | The message that was returned from the request, this will contain an error if the status code does not equal 200 | "OK" |
content |
array | A json object with the requested data from this endpoint | {...} |
/api/v1/ark/server?apikey=YOUR_API_KEY&platform=xbox&name[]=EU-PVP-XboxOfficial-Ragnarok344&name[]=EU-PVE-XboxOfficial-ScorchedEarth135