Quickstart

1. Create an account

Go to orbitalhq.xyz/api and sign in with Discord or a wallet. Signing in with a wallet is free and sends no transaction.

In the dashboard, create an API key. Keys start with orbt_live_ and are shown once, so save yours right away. You can have up to 5.

To try the API for free, create a test key instead. Test keys start with orbt_test_ and return sample data, not real results.

Send your key in the Authorization header:

curl -H "Authorization: Bearer YOUR_KEY" "https://api.orbitalhq.xyz/public-api/v1/users/jack"

{
  "id": "12",
  "handle": "jack",
  "name": "jack",
  "followers": 12491430,
  "verified": true,
  "created_at": "2006-03-21T20:50:14.000Z"
}

Every response tells you what the call cost and what you have left:

X-Credits-Cost: 1
X-Credits-Remaining: 9849

Long calls: add async=true to get a job id right away, then fetch the result from /jobs/{id}. Results are kept for 1 hour. A server restart can cancel a running job, and its credits are refunded.
Pagination: when a response has next_cursor, pass it back unchanged as cursor.
Repeat calls: the same call within 5 minutes is free, except for very large responses. Add fresh=true to force a new one, which is charged again.
Price control: on calls priced by account size, max_cost refuses the call for free if it would cost more than you set.
Your usage: GET /usage shows calls and credits per endpoint per day. GET /me shows your balance. Both are free.