What is the Resources API?
The term "API" is the abbreviation for "application programming interface" - on German: application programming interface. APIs generally allow for easy data and/or function exchange between different applications.
The Resources API allows you to retrieve your own up-to-date player data, as well as other up-to-date game data, almost in real time and evaluate it in your own "tools" (or third-party tools).
The API provides the data either as CSV or as JSON. Thanks to the API, you can, for example, keep your Excel or Google spreadsheets up-to-date at any time with very little effort.
The first tools of players are already emerging, which will support the API and thus enable very interesting evaluations regarding profitability, course history, etc.
Who is the API suitable for?
The API is above all an enrichment for all math and statistics enthusiasts, who already have their complex evaluation tables on their own, as well as the entire resources economy. And of course for all app/web developers who want to develop a great tool, or an info platform.
If you are not a friend of Excel/Googlesheets or databases, or are generally unambitious in the processing and display of raw data, you should wait until appropriate, pre-built tools, or spreadsheets are available to the public.
Please note...
... that if you entrust your API keys to a foreign tool, the developer of that tool can read or save your api key. It is at your own discretion who/which platform you entrust your key to. Even if no sensitive data such as e-mail, or passwords, or the current position can be read out via API and the API key, except for the API queries, has no further use, or account-technical context (and you could "crank up" most of the data using the Resources app), it wouldn't necessarily be beneficial if your api keys got into the wrong hands and your API credits were used up by a fun bird within minutes for "inexplicable reasons.
How do I get access to the API?
By acquiring so-called "API credits" in the InApp store, you get your own API key + a certain number of API credits via registration email, with which you can query the data.
A query costs an "API-credit".
.. but what exactly is a query?
For example, with a query you will receive a list with up-to-date and detailed information about all your conveyor systems. Or a list of your stock levels and stock levels. Or your log of your last sales and sales on the market within the last 30 days, or... Or...
What data can I query?
The API is expected to be extended by a few more queries. Currently, the following queries are possible:
- Amount of remaining API credits (this query does not cost API credits, of course!)
- List of your factories, factory stages and status
- Your stock levels, stock levels and account balance
- List of your special buildings and steps
- Your HQ progress
- List of your conveyor system with condition, boost, TU factor, attack malus, etc.
- Summary of conveyor system data by funded resources
- Your trading log of the last x days (max. 30 days)
- Player info such as points, level, world ranking, registration date
- Balance sheet information (inputs and expenses per day, max. last 30 days)
- Attack log
- Foreign maintenance log
- ID list incl. icon for all Resources Items, Factories, Spec Buildings and Conveyors incl. Names in all client languages
- Basic data production
- Basic data recycling
- Basic Data Factory Upgrade Costs
- Basic data Special building upgrade costs
- Current AI and market prices (almost in real time)
How do I ask?
The query works very simply with a query URL and GET parameters.