GraphQL is for Nexar migration only
Use the GraphQL API only as a drop-in replacement for Nexar's GraphQL when migrating existing integrations. For new projects and full platform capabilities, use the REST API— it's the actively maintained, modern interface.
Errors
HTTP status codes for auth, billing error codes in GraphQL extensions, and example error payloads.
GraphQL returns errors in the standard errors array. Billing and auth failures include an extensions object with a machine-readable code and HTTP status.
Authentication
Every request must include Authorization: Bearer <YOUR API KEY HERE>. See Authentication for how to create a key.
| Condition | HTTP status |
|---|---|
| Missing API key | 401 |
| Invalid, revoked, or expired key | 401 |
| Auth service unavailable | 503 |
Billing error codes
extensions.code | extensions.status | Meaning |
|---|---|---|
usage_limit_exceeded | 402 | Monthly API unit quota exhausted |
subscription_required | 403 | Paid endpoints require an active subscription |
rate_limit_exceeded | 429 | Monthly API request (anti-abuse) cap hit — see Rate limits |
billing_unavailable | 503 | Billing service unreachable or misconfigured |
Example error shape:
JSON
1{2 "errors": [3 {4 "message": "Monthly API usage limit reached. Upgrade your plan or wait for reset.",5 "extensions": {6 "code": "usage_limit_exceeded",7 "status": 402,8 "api_usage": {9 "remaining": 0,10 "monthly_limit": 2500011 }12 }13 }14 ]15}Search warnings
Search queries (supSearchMpn, supSearch) may return warnings on the result set instead of failing — for example when a filter or sort option is not yet implemented. Treat warnings as signals that part of the request was ignored or partially applied.
Next
- Rate limits & usage — per-minute throttle and usage metering
- Usage billing — which queries are paid vs free
- Make your first query — successful response shape
- REST errors — REST API error envelope