Skip to main content

What is the Sandbox?

The Sandbox provides mock API endpoints that return deterministic test data. Use these endpoints to develop and test your integration without consuming your API quota or waiting for real blockchain queries.
SANDBOX: All data returned by sandbox endpoints is mock data for testing purposes only. Do not use sandbox responses for production decisions.

Sandbox vs Production

FeatureSandboxProduction
DataMock/deterministicReal blockchain data
Response timeInstant1-10 seconds
API quotaNot countedCounted
Base URLSameSame
Endpoint prefix/api/v2/sandbox//api/v2/

Available Sandbox Endpoints

All production endpoints have sandbox equivalents. Simply add /sandbox/ after /api/v2/:

Score Endpoints

Sandbox EndpointProduction EquivalentDescription
GET /sandbox/score/address/{address}/score/address/{address}Mock credit score
POST /sandbox/score/address/{address}/score/address/{address}Mock enhanced score
GET /sandbox/score//score/Mock aggregated score
GET /sandbox/score/batch//score/batch/Mock batch individual scores

Report Endpoints

Sandbox EndpointProduction EquivalentDescription
GET /sandbox/report/address/{address}/report/address/{address}Mock comprehensive report
POST /sandbox/report/address/{address}/report/address/{address}Mock enhanced report
GET /sandbox/report//report/Mock aggregated report
GET /sandbox/report/address/{address}/summary/report/address/{address}/summaryMock summary report
GET /sandbox/report/address/{address}/chain/{chain_id}/report/address/{address}/chain/{chain_id}Mock single-chain report
GET /sandbox/report/address/{address}/chain/{chain_id}/summary/report/address/{address}/chain/{chain_id}/summaryMock chain summary
GET /sandbox/report/address/{address}/total/usd/report/address/{address}/total/usdMock portfolio value
GET /sandbox/report/address/{address}/chain/{chain_id}/total/usd/report/address/{address}/chain/{chain_id}/total/usdMock chain portfolio

Deterministic Responses

Sandbox responses are deterministic based on the address provided:
  • The same address always returns the same mock data
  • Different addresses return different (but consistent) mock scores
  • This allows you to test various scenarios reliably

When to Use the Sandbox

Development

Build and test your integration without using real API quota

CI/CD Testing

Run automated tests against consistent mock data

Demo Applications

Build demos without depending on real blockchain data

UI Development

Design and test your UI with various score scenarios

Example Workflow

1

Develop with Sandbox

Use sandbox endpoints while building your integration
curl "https://api.credprotocol.com/api/v2/sandbox/score/address/0x123..." \
  -H "Authorization: Bearer YOUR_API_KEY"
2

Test Edge Cases

Test different addresses to see various score ranges
3

Switch to Production

Simply remove /sandbox/ from the URL to use production endpoints
curl "https://api.credprotocol.com/api/v2/score/address/0x123..." \
  -H "Authorization: Bearer YOUR_API_KEY"

Test Addresses

Mock scores are generated deterministically from the address. Here are example addresses for testing specific scenarios:
AddressApproximate ScoreClassification
0x0000000000000000000000000000000000000001~850Excellent
0x0000000000000000000000000000000000000002~720Good
0x0000000000000000000000000000000000000003~550Fair
0x0000000000000000000000000000000000000004~400Low
The actual mock score is calculated using the last 8 characters of the address, so any address will produce a consistent, deterministic result.