Documentation · Preview
Sandbox API docs
Documentation for a preview institutional sandbox API. The sandbox API itself is not live on nodetrail.io. No keys are issued here. No prices.
What the sandbox is
- A test API design that would answer from saved fixture snapshots only, with no live chain reads.
- Intended keys would start with nt_test_. Keys of any other shape, including nt_live_, would be refused.
- This documentation does not create, revoke, or accept keys. There is no team account or key desk on this site.
Authentication (draft)
If the sandbox were running, a key would be sent as a bearer token: Authorization: Bearer nt_test_... That flow is not available here.
Rate limits (preview draft values)
- Burst of 20 requests, refilling at 1 request each second.
- 1,000 requests a day (UTC).
- Over the limit: HTTP 429 with a Retry-After header. Responses would also carry X-RateLimit-* headers.
Specified endpoints (not live)
These paths are part of the preview specification. They are not served on nodetrail.io.
| Method | Path | What it would return |
|---|---|---|
| GET | /api/inst/sandbox/v1/ping | Key check |
| GET | /api/inst/sandbox/v1/assets | The fixture assets that can be checked |
| GET | /api/inst/sandbox/v1/check?chain=&address= | A fixture report with a content hash, sources, and what was not checked |
Example requests (specification only)
These examples use a placeholder host. They will not work against nodetrail.io.
export NT_KEY="nt_test_..." # a sandbox key, if one had been issued in a preview environment curl -s https://example.invalid/api/inst/sandbox/v1/ping -H "Authorization: Bearer $NT_KEY" curl -s https://example.invalid/api/inst/sandbox/v1/assets -H "Authorization: Bearer $NT_KEY" curl -s "https://example.invalid/api/inst/sandbox/v1/check?chain=base&address=0x0000000000000000000000000000000000000000" -H "Authorization: Bearer $NT_KEY"
Errors (draft)
| HTTP | code | Meaning |
|---|---|---|
| 401 | bad_key | Missing, unknown or malformed key |
| 401 | revoked | The key was revoked |
| 401 | live_key_rejected | Not a sandbox key |
| 404 | not_in_fixtures | No fixture for that chain and address |
| 429 | rate_limited | Slow down; see Retry-After |
Service targets (draft)
Targets only. Not an SLA. No uptime or latency is promised, and none is measured here. No prices.
- p95 response, fixture check: 300 ms (target, draft)
- Support first response: 4 hours (target, draft)