Authorization header using the Bearer scheme on every call you make to the API. There are no cookies, OAuth flows, or session tokens — just a single header that identifies your account and enforces your plan’s rate limits.
Get your API key
1
Create an Orbscan account
Visit orbscan.com and sign up for a free account using your email address. Verify your email to activate the account.
2
Open Settings → API Keys
After logging in, click your avatar in the top-right corner and select Settings. From the left-hand navigation menu, choose API Keys.
3
Generate and copy your key
Click Generate New Key, give it a descriptive label (for example
dev-local or production-app), and confirm. Your key appears once only — copy it immediately and store it somewhere safe such as a password manager. If you lose it, revoke the old key and generate a new one.Pass your key in requests
Include your API key as a Bearer token in theAuthorization header of every request:
Authentication error codes
When something goes wrong with authentication, the API returns a standard HTTP error status alongside a JSON body that describes the problem.Example error response
Every API response includes rate limit headers so you can monitor your usage programmatically:
X-RateLimit-Limit is your total allowed requests per window, X-RateLimit-Remaining is how many you have left, and X-RateLimit-Reset is the Unix timestamp when the window resets.