Quick start
You need an account, a key and one HTTP request.
1. Create an account and a key
Sign up and verify your e-mail. The free plan starts by itself. Then create a key on the keys page and save it somewhere safe, because it is shown only once.
2. Check your key
This call is free. It tells you your plan, balance and limits.
Paste a key to fill in the examples and try calls. It stays in this tab until you reload. It is never saved. Get a key
curl -sS "https://api.arzdigital.com/v1/key/info" \
-H "X-API-Key: YOUR_API_KEY"3. Make your first call
This asks for the top 10 assets by rank. It returns 10 rows, so it costs 1 credit.
curl -sS "https://api.arzdigital.com/v1/assets?limit=10&sort=rank_asc" \
-H "X-API-Key: YOUR_API_KEY"4. Read the response headers
Every response reports what the call cost and how much room you have left.
| Header | Meaning |
|---|---|
X-Credits-Charged | Credits this call cost. 0 on every non-200 response. |
X-Credits-Remaining | Account balance after this call, not counting what calls still in flight have set aside. Negative only for an account in debt after an adjustment. |
X-RateLimit-Limit | Requests per minute allowed for this key. |
X-RateLimit-Remaining | Requests left in the current window. |
X-RateLimit-Reset | Unix seconds at which the window has room again. |
Good to know
- Call the API from your server, not from a browser. The API sends no CORS headers, and a key in a web page is a key anyone can copy.
- Send the key only in the X-API-Key header. Keys are not accepted in the URL, because URLs end up in logs.
- Check the HTTP status first. On success the status field is the word success, and on an error it is an object with a code and a message.