StalkChain Data
StalkChain Data API

Account & status


Data source health (keyless)

GET
https://data.stalkchain.com
/api/v1/tools/stalkchain_health

Data source health (keyless) › Responses

200

{ data, notes?, credits, meta }

No data returned

Data source health (keyless)

POST
https://data.stalkchain.com
/api/v1/tools/stalkchain_health

Is the API up or down. Liveness, loaded trader count and uptime, plus the state of every data source behind the tools (ok, degraded, or down with when to retry). Use when a call just failed and you need to say whether the service is down or the request was wrong. Free, no key needed, 0 credits.

Data source health (keyless) › Request Body optional

Data source health (keyless) › Responses

{ data, notes?, credits, meta }

No data returned

the provider account & credit balance

GET
https://data.stalkchain.com
/api/v1/tools/stalkchain_account

the provider account & credit balance › Responses

200

{ data, notes?, credits, meta }

No data returned

the provider account & credit balance

POST
https://data.stalkchain.com
/api/v1/tools/stalkchain_account

How many credits do I have left. The account behind the active key: plan, credits remaining, monthly allowance, how much is used this month, prepaid top-ups, expiry. Use when asked about the balance, quota, plan, how many calls are left, or before starting an expensive workflow. For what this conversation alone has spent, use stalkchain_usage. Costs 0 credits.

the provider account & credit balance › Request Body optional

the provider account & credit balance › Responses

{ data, notes?, credits, meta }

No data returned

Session credit usage & key pool

GET
https://data.stalkchain.com
/api/v1/tools/stalkchain_usage

Session credit usage & key pool › query Parameters

clearCache
​boolean

Also clear the in-memory response cache

Also clear the in-memory response cache

Session credit usage & key pool › Responses

200

{ data, notes?, credits, meta }

No data returned

Session credit usage & key pool

POST
https://data.stalkchain.com
/api/v1/tools/stalkchain_usage

What has this session cost so far. A local ledger with no API call: credits spent in this conversation, which tools were hit, cache hit rate, keys exhausted or invalid, and the documented price table. Use when asked what something cost, how much has been used up, or to budget the rest of the work. For the ACCOUNT balance rather than this session, use stalkchain_account. Costs 0 credits.

Session credit usage & key pool › Request Body optional

clearCache
​boolean

Also clear the in-memory response cache

Session credit usage & key pool › Responses

{ data, notes?, credits, meta }

No data returned