Web API

From ARK Wiki
Jump to navigation Jump to search


ARK's Web API is used by the client to get various information, for example the list of official servers or latest news. Each endpoint can be accessed by sending a simple HTTP GET request.  ARK: Survival Evolved does not support HTTPS, but  ARK: Survival Ascended does. Some endpoints are suffixed by a ".ini" extension, but their content is not in the format of an INI file. Endpoint names are case sensitive. All API endpoints are hosted on the official ARK website: for  ARK: Survival Evolved at arkdedicated.com, and for  ARK: Survival Ascended at cdn2.arkdedicated.com/asa/.

Version (ASE)

For  ARK: Survival Evolved: http://arkdedicated.com/version
For  ARK: Survival Ascended: N/A

This endpoint returns the current latest game version as a simple string.

Example: the URL http://arkdedicated.com/version returns:

358.17

Major version (ASE)

For  ARK: Survival Evolved: http://arkdedicated.com/version/major
For  ARK: Survival Ascended: N/A

If you are only interested in the major version number, use this endpoint instead. Game versions that differ in minor version numbers but share the same major version number should be compatible (in terms of connecting, mods, save games, etc.).

Example: the URL http://arkdedicated.com/version/major returns:

358

Official servers status (ASE/ASA)

For  ARK: Survival Evolved: http://arkdedicated.com/officialserverstatus.ini
For  ARK: Survival Ascended: https://cdn2.arkdedicated.com/asa/officialserverstatus.ini

This endpoint contains the text typically displayed in the upper left hand corner of the in-game ark server browser on  ARK: Survival Evolved, and just below the ark servers listing on  ARK: Survival Ascended. It displays the health and current version of all the official Ark servers. The return text is formatted in ArkML.

Examples: 

ARK Official Server Network Status: <RichColor Color="1, 0, 0, 1">Offline (v358.17)</>
<RichColor Color="1, 0, 0, 1">When playing on our Official Server Network, please be sure to abide by our Code of Conduct: ark.gg/CoC</>

ARK Official Server Network Status: <RichColor Color="0, 1, 0, 1">Online (v35.11)</>

Official tribute enabled (ASE/ASA)

For  ARK: Survival Evolved: http://arkdedicated.com/officialtributeenabled.html
For  ARK: Survival Ascended: https://cdn2.arkdedicated.com/asa/officialtributeenabled.html

This endpoint specifies if tribute (transfers) are enabled on the Official Server Network. It typically returns a single digit which acts as a boolean: 0 (disabled) or 1 (enabled).

Featured (ASA)

For  ARK: Survival Evolved: N/A
For  ARK: Survival Ascended: https://cdn2.arkdedicated.com/asa/info/featured.ini (Default), https://cdn2.arkdedicated.com/asa/info/featured.{LANG}.ini (Language-specific).

This endpoint returns the data (text and image links) that gets displayed in the left panel on  ARK: Survival Ascended main menu.
The language-specific endpoint is supposed to return the featured data translated in given {LANG} language. Replace {LANG} with a 2-letters language code (for example https://cdn2.arkdedicated.com/asa/info/featured.fr.ini will return French translated version of the featured data).

Example of returned data: 

featured=((ImagePath="https://cdn2.arkdedicated.com/media/mods/ASA_Svartalfheim_FeaturedPanel_872x900.png",EntryWidgetTemplate="CTA",PipWidgetTemplate="DEFAULT",EntryData="",OnClickedAction="mod::962796",ShowForPlatforms="PC"),(ImagePath="https://cdn2.arkdedicated.com/media/mods/ASA_PotionsPlus_FeaturedPanel_872x900.png",EntryWidgetTemplate="CTA",PipWidgetTemplate="DEFAULT",EntryData="",OnClickedAction="mod::965454",ShowForPlatforms="PC"),(ImagePath="https://cdn2.arkdedicated.com/media/mods/Steamboat_ASA-Featured_900.png",EntryWidgetTemplate="CTA",PipWidgetTemplate="DEFAULT",EntryData="",OnClickedAction="mod::967226"),(ImagePath="https://cdn2.arkdedicated.com/media/mods/Structure_Cosmetics.png",EntryWidgetTemplate="CTA",PipWidgetTemplate="DEFAULT",EntryData="",OnClickedAction="mod::968943"),(ImagePath="https://cdn2.arkdedicated.com/media/mods/Mickey_minnie_costume_v2.png",EntryWidgetTemplate="CTA",PipWidgetTemplate="DEFAULT",EntryData="",OnClickedAction="mod::968851"),(ImagePath="https://cdn2.arkdedicated.com/media/mods/Krazy_cosmetics.png",EntryWidgetTemplate="CTA",PipWidgetTemplate="DEFAULT",EntryData="",OnClickedAction="mod::972492"))

News (ASE/ASA)

For  ARK: Survival Evolved: http://arkdedicated.com/news.ini
For  ARK: Survival Ascended: https://cdn2.arkdedicated.com/asa/info/news.ini (Default), https://cdn2.arkdedicated.com/asa/info/news.{LANG}.ini (Language-specific).

This endpoint returns the latest Ark news data.

On  ARK: Survival Evolved:
The data gets displayed in the upper right hand corner of the main menu, it is formatted in ArkML. The text is not processed any further by the game, but from current observations additional data can be parsed from it. After parsing the ArkML, each news entry is separated by two carriage return line feeds (\r\n\r\n). Each entry begins with a date string, followed by a colon, and ends with the entry's text. The date string consists of the full month name followed by a space and then the day of the month with no leading characters. In strftime format, the date can be represented as %B %-d.
Example of returned data: 

<RichColor Color="1, 0.65, 0, 1">Discover Rhyniognatha, a super-sized creature with a set of unique abilities. From producing quick-hardening resin to being capable of carrying large objects around your base, these versatile creatures provide an unparalleled enhancement to your tribe's defenses.</>

<RichColor Color="1, 1, 0, 1">ARK: The Animated Series</><RichColor Color="0.2, 1, 1, 1">has released its Season 1 trailer! Watch it at </><RichColor Color="1, 1, 0, 1">youtube.com/survivetheark</>

<RichColor Color="0.9, 0.9, 0.9, 1">Experience everything that the ARK franchise has to offer in the definitive </><RichColor Color="1, 0.85, 0, 1">Ultimate Survivor Edition</><RichColor Color="0.9, 0.9, 0.9, 1">! Containing all DLC and ARK content, tame and ride primeval creatures as you explore savage lands and travel together on the greatest Dinosaur-filled adventure of all time.</>

<RichColor Color="0.2, 1, 1, 1">Excited to announce: </><RichColor Color="1, 1, 1, 1">ARK II multiplayer sandbox survival game starring Vin Diesel as Santiago!</>

<RichColor Color="0.2, 1, 1, 1">Follow @survivetheark on Twitter and join us on Discord at discord.gg/playark for the latest news!</>

On  ARK: Survival Ascended:
The data gets displayed in the right panel of the main menu. The language-specific endpoint is supposed to return the news data translated in given {LANG} language. Replace {LANG} with a 2-letters language code (for example https://cdn2.arkdedicated.com/asa/info/news.fr.ini will return French translated version of the news data). Each news entry is composed of the following elements:

  • ImagePath: An image URL.
  • EntryWidgetTemplate: The type of UI widget used by the client to render the news. There are 4 types currently supported:
    • NEWS: This is the most common news entry UI, it will display an image (image link must be specified in ImagePath element) and some text under it (text must be specified in EntryData element).
    • CTA: This news entry UI will only display an image (image link must be specified in ImagePath element).
    • NEWS_LIST: This news entry UI will only display some text (text must be specified in EntryData element).
    • SERVER_STATUS: This news entry UI will display an image (image link must be specified in ImagePath element) and the server status/version under it. Server status/version must be specified in EntryData element with the following format: EntryData="{Status}|{Version}" (where {Status} represent the server status string and where {Version} represent the server version string).
  • PipWidgetTemplate: The type of UI button associated to each news entry. Currently there is only one type of UI button supported: DEFAULT
  • EntryData: The text data associated to the news entry.
  • OnClickedAction: The action to perform when user clicks on the news entry. Currently there are 2 types of actions supported:
    • mod::{ModID}: This action will open a mod page in the game client by ID (replace {ModID} with the mod ID).
    • LINK::{URL}: This action will open a URL in the web browser (replace {URL} with the URL).

Example of returned data: 

news=((ImagePath="https://cdn2.arkdedicated.com/media/mods/ASA_Gigantoraptor_FeaturedPanel_872x900.jpg",EntryWidgetTemplate="CTA",PipWidgetTemplate="DEFAULT",EntryData="",OnClickedAction="mod::975282"),(ImagePath="https://cdn2.arkdedicated.com/media/crunch/CommunityCrunch398_InGame.jpg",EntryWidgetTemplate="NEWS",PipWidgetTemplate="DEFAULT",EntryData="Community Crunch 398|Check out the latest Community Crunch for an update on The Center, the first look at the Oasisaur Dossier, and more!",OnClickedAction="LINK::https://survivetheark.com/index.php?/articles.html/community-crunch-398-an-update-on-the-center-oasisaur-dossier-and-more-r2252/"),(ImagePath="https://cdn2.arkdedicated.com/media/promo/ASA_Social_ArkathonAnnouncement_872x900.jpg",EntryWidgetTemplate="CTA",PipWidgetTemplate="DEFAULT",EntryData="",OnClickedAction="LINK::https://arkathon.curseforge.com/"),(ImagePath="https://cdn2.arkdedicated.com/media/keyart/ASA_KeyArt_WithLogo_FINAL_tiny.jpg",EntryWidgetTemplate="NEWS",PipWidgetTemplate="DEFAULT",EntryData="Code of Conduct|When playing on our Official Server Network, please be sure to abide by our Code of Conduct available at ark.gg/CoC",OnClickedAction="LINK::https://survivetheark.com/index.php?/code-of-conduct/"),(ImagePath="https://cdn2.arkdedicated.com/media/promo/ASA_SOTF_NewsPanel_NowLive_872x494.jpg",EntryWidgetTemplate="NEWS",PipWidgetTemplate="DEFAULT",EntryData="ARK: Survival of the Fittest!|SOTF is live for crossplay on PC, Xbox and PlayStation! SOTF pits up to 60 combatants against each other in a fast-paced, action-packed struggle for survival, where players are ultimately pushed into an epic final showdown leading their Dinosaur Armies into battle."))

Official PvP cosmetic whitelist (ASA)

For  ARK: Survival Evolved: N/A
For  ARK: Survival Ascended: https://cdn2.arkdedicated.com/asa/OfficialCosmeticWhitelist.txt

This endpoint contains the list of IDs of whitelisted cosmetic mods for official  ARK: Survival Ascended PvP servers.

Official PvE cosmetic whitelist (ASA)

For  ARK: Survival Evolved: N/A
For  ARK: Survival Ascended: https://cdn2.arkdedicated.com/asa/OfficialPVECosmeticWhitelist.txt

This endpoint contains the list of IDs of whitelisted cosmetic mods for official  ARK: Survival Ascended PvE servers.

Global administrators (ASE)

For  ARK: Survival Evolved: http://arkdedicated.com/globaladmins.txt
For  ARK: Survival Ascended: N/A

This endpoint contains the list of server admins for official  ARK: Survival Evolved servers.

Global administrators (ASE, Snail Games)

For  ARK: Survival Evolved: http://arksnail.snail.com/globaladmins.txt
For  ARK: Survival Ascended: N/A

This endpoint contains the list of server admins for official  ARK: Survival Evolved servers Snail Games manages.

Ban list (ASE/ASA)

For  ARK: Survival Evolved: 

Steam: http://arkdedicated.com/banlist.txt
Conquest: http://arkdedicated.com/conquestbanlist.txt Note: This endpoint has been said to not be updated anymore.
Playstation: http://arkdedicated.com/ps4banlist.txt
Xbox: http://arkdedicated.com/xboxbanlist.txt

For  ARK: Survival Ascended: 

https://cdn2.arkdedicated.com/asa/BanList.txt

These endpoints contains the list of accounts that are globally banned from the official server network.

Live tuning overloads (ASE/ASA)

For  ARK: Survival Evolved: http://arkdedicated.com/DefaultOverloads.json
For  ARK: Survival Ascended: https://cdn2.arkdedicated.com/asa/livetuningoverloads.json

This endpoint returns a JSON array containing various settings which are used to tune official servers. Unofficial servers can use the option CustomLiveTuningUrl (see Server configuration) to setup their own live tuning overloads. For more information on how to use this system check out the official announcement at https://survivetheark.com/index.php?/forums/topic/569366-server-configuration-live-tuning-system.

Dynamic configurations (ASE/ASA)

For  ARK: Survival Evolved: 

http://arkdedicated.com/dynamicconfig.ini
http://arkdedicated.com/pc_arkpocalypse_dynamicconfig.ini
http://arkdedicated.com/pc_smalltribes_dynamicconfig.ini
http://arkdedicated.com/xbox_arkpocalypse_dynamicconfig.ini
http://arkdedicated.com/xbox_smalltribes_dynamicconfig.ini
http://arkdedicated.com/ps4_arkpocalypse_dynamicconfig.ini
http://arkdedicated.com/ps4_smalltribes_dynamicconfig.ini
http://arkdedicated.com/pc_conquest_dynamicconfig.ini

For  ARK: Survival Ascended: 

https://cdn2.arkdedicated.com/asa/dynamicconfig.ini
https://cdn2.arkdedicated.com/asa/arkpocalypse_dynamicconfig.ini
https://cdn2.arkdedicated.com/asa/smalltribes_dynamicconfig.ini
https://cdn2.arkdedicated.com/asa/conquest_dynamicconfig.ini

These endpoints contain multipliers used for Official Evolution events.
Note: Classic should be using the "conquest" values.

Notification (ASE/ASA)

For  ARK: Survival Evolved: 

http://arkdedicated.com/pcnotification.html
http://arkdedicated.com/notification.html(xbox)[citation needed]
http://arkdedicated.com/ps4notification.html
http://arkdedicated.com/switchnotification.html

For  ARK: Survival Ascended: 

https://cdn2.arkdedicated.com/asa/notification.html

Platform-specific endpoints for in-game server-wide announcements.

Bad words (ASE/ASA)

For  ARK: Survival Evolved: http://arkdedicated.com/badwords.txt
For  ARK: Survival Ascended: https://cdn2.arkdedicated.com/asa/badwords.txt

This endpoint returns the list of words that are censored in the game chat of offcial servers.
Unofficial servers can use option BadWordListURL (see Server configuration) to setup their own Bad Words list.

Good words (ASE/ASA)

For  ARK: Survival Evolved: http://arkdedicated.com/goodwords.txt
For  ARK: Survival Ascended: https://cdn2.arkdedicated.com/asa/goodwords.txt

This endpoint returns the list of words that are not censored in the game chat of offcial servers.
Unofficial servers can use option BadWordWhiteListURL (see Server configuration) to setup their own Good Words list.

Official server list (ASA, All platforms)

For  ARK: Survival Evolved: N/A
For  ARK: Survival Ascended: https://cdn2.arkdedicated.com/servers/asa/officialserverlist.json

This endpoint returns a JSON array of objects. Each object represent an official  ARK: Survival Ascended server.

Example object: 

{
  "SessionName":"EU-PVP-TheIsland2233 - (v35.11)",
  "ModIDs":"927084,975282",
  "AllowDownloadItems":1,
  "SessionNameUpper":"EU-PVP-THEISLAND2233 - (V35.11)",
  "SessionID":"97ace55ee83346398a7c1f58f2d858c2",
  "IsOfficial":"1",
  "MaxPlayers":70,
  "Steelshield":1,
  "ClusterId":"PVPCrossplay",
  "Sandbox":"MISSING",
  "AllowDownloadChars":1,
  "NumPlayers":9,
  "Port":7779,
  "DayTime":"1203",
  "SOTFMatchStarted":false,
  "Name":"EU-PVP-TheIsland2233",
  "ModFileIDs":"5138778,5147739",
  "IP":"5.62.112.69",
  "ServerPing":193,
  "Service":"WinLiveService",
  "MinorBuildId":11,
  "HasPassword":false,
  "SessionIsPve":0,
  "MapName":"TheIsland_WP",
  "Battleye":1,
  "LatencyPort":"WinLiveLatecyCheckPort",
  "LastUpdated":1709718850570,
  "BuildId":35,
  "SearchHandle":"SearchHandle",
  "PlatformType":"PC+PS5+XSX",
  "GameMode":"TestGameMode_C"
}

Unofficial server list (ASA, All platforms)

For  ARK: Survival Evolved: N/A
For  ARK: Survival Ascended: https://cdn2.arkdedicated.com/servers/asa/unofficialserverlist.json

This endpoint returns a JSON array of objects. Each object represent an unofficial  ARK: Survival Ascended server.

Example object: 

{
  "SessionName":"Ark #32081 hosted by nitrado.net - (v35.11)",
  "AllowDownloadItems":1,
  "SessionNameUpper":"ARK #32081 HOSTED BY NITRADO.NET - (V35.11)",
  "SessionID":"5272afb0436d4063960a407de2f3eb07",
  "IsOfficial":"0",
  "MaxPlayers":20,
  "Steelshield":1,
  "ClusterId":"",
  "Sandbox":"MISSING",
  "AllowDownloadChars":1,
  "NumPlayers":0,
  "Port":5040,
  "DayTime":"220",
  "SOTFMatchStarted":false,
  "Name":"Ark #32081 hosted by nitrado.net",
  "IP":"217.114.196.34",
  "ServerPing":81,
  "Service":"WinLiveService",
  "MinorBuildId":11,
  "HasPassword":false,
  "SessionIsPve":0,
  "MapName":"TheIsland_WP",
  "Battleye":1,
  "LatencyPort":"WinLiveLatecyCheckPort",
  "LastUpdated":1709721178674,
  "BuildId":35,
  "SearchHandle":"SearchHandle",
  "PlatformType":"PC+PS5+XSX+WINGDK",
  "GameMode":"TestGameMode_C"
}

Official server hosts (ASE)

For  ARK: Survival Evolved: http://arkdedicated.com/officialservers.ini
For  ARK: Survival Ascended: N/A

This endpoint contains the list of official server hosts. The IP address of each server host is listed on a separate line, followed by a double forward slash (//) and then a short server name. Up to four game servers run on each official host. The query ports for each game server are on Steam's standard server port, plus 2, plus 4, and plus 6 (27015, 27017, 27019, 27021). See the server query protocol page to learn how to get information from them.
Note: This endpoint is not used directly by the game.

Official server list (ASE, Xbox)

For  ARK: Survival Evolved: http://arkdedicated.com/xbox/cache/officialserverlist.json
For  ARK: Survival Ascended: N/A

This endpoint returns a JSON array of objects. Each object represents an official  ARK: Survival Evolved Xbox server.

Example object (with IPs and domains stripped): 

{
  "AllowDownloadItems":1,
  "IP":"192.0.2.1",
  "Service":"https://example.com:89",
  "MinorBuildId":1,
  "MaxPlayers":70,
  "ClusterId":"XboxPrimitivePlusPVE",
  "Sandbox":"RETAIL",
  "MapName":"TheCenter",
  "SessionIsPve":1,
  "LatencyPort":9996,
  "AllowDownloadChars":1,
  "NumPlayers":3,
  "LastUpdated":1539545767997,
  "BuildId":1777,
  "Port":9992,
  "SearchHandle":"ec008fff-b668-4d34-88c6-f6c84c10334b",
  "DayTime":"19754",
  "Legacy":1,
  "GameMode":"GameMode_PrimitivePlus_C",
  "Name":"PVE-EU-XboxPrimitivePlus24",
  "SearchTags":["crossplayallowxbox"]
}

Unofficial server list (ASE, Xbox)

For  ARK: Survival Evolved: http://arkdedicated.com/xbox/cache/unofficialserverlist.json
For  ARK: Survival Ascended: N/A

This endpoint returns a JSON array of objects. Each object represents an unofficial  ARK: Survival Evolved Xbox server.

Official server list (ASE, Mobile)

For  ARK: Survival Evolved: http://arkdedicated.com/mobile/cache/officialserverlist.json
For  ARK: Survival Ascended: N/A

This endpoint returns a JSON array of objects. Each object represents an official  ARK: Survival Evolved Mobile server.

Example object: 

{
  "AllowDownloadItems":-2084667264,
  "Region":"NA",
  "IP":"34.241.86.216",
  "NPEnvironment":"[2a05:d018:b8b:6f00:cca0:866e:7335:8be]",
  "MinorBuildId":1,
  "MaxPlayers":60,
  "ClusterId":"{\r\n\t\"NumReservedSlots\": 60,\r\n\t\"NumReservedPlayers\": 1,\r\n\t\"ClusterId\": \"ark\",\r\n\t\"Difficulty\": \"Hard\",\r\n\t\"Mode\": \"PVE\",\r\n\t\"REGION\": \"EU\"\r\n}",
  "MapName":"M_TheIsland",
  "SessionIsPve":false,
  "NPSessionId":"26",
  "AllowDownloadChars":75,
  "NumPlayers":1,
  "LastUpdated":1535927396441,
  "BuildId":159,
  "Port":7810,
  "DayTime":"21:46",
  "GameMode":"ARK",
  "Name":"Gauntlet (PVE-Hard-EU)"
}

Unofficial server list (ASE, Mobile)

For  ARK: Survival Evolved: http://arkdedicated.com/mobile/cache/unofficialserverlist.json
For  ARK: Survival Ascended: N/A

This endpoint returns a JSON array of objects. Each object represents an unofficial  ARK: Survival Evolved Mobile server.

Official server list (ASE, Nintendo Switch)

For  ARK: Survival Evolved: http://arkdedicated.com/switch/cache/officialserverlist.json
For  ARK: Survival Ascended: N/A

This endpoint returns a JSON array of objects. Each object represents an official  ARK: Survival Evolved Switch server.
Note: Deprecated.

Unofficial server list (ASE, Nintendo Switch)

For  ARK: Survival Evolved: http://arkdedicated.com/switch/cache/unofficialserverlist.json
For  ARK: Survival Ascended: N/A

This endpoint returns a JSON array of objects. Each object represents an unofficial  ARK: Survival Evolved Switch server.
Note: Deprecated.

Official server list (ASE SOTF, Playstation)

For  ARK: Survival Evolved: http://arkdedicated.com/sotfps4/cache/officialserverlist.json
For  ARK: Survival Ascended: N/A

This endpoint returns a JSON array of objects. Each object represents an official  ARK: Survival Evolved Survival of the Fittest Playstation server.
Note: Deprecated.


Retrieved from "https://ark.wiki.gg/index.php?title=Web_API&oldid=536112"