Skip to main content

​
Base URL

All API requests should be made to: 
https://api.credprotocol.com

​
Authentication

All API endpoints require authentication using a Bearer token. Include your API key in the Authorization header: 
Authorization: Bearer YOUR_API_KEY
Get your API key from the Dashboard.

​
API Endpoints

The Cred Protocol API is organized into the following categories:

​
Score Endpoints

EndpointMethodDescription
/api/v2/score/{address}GETGet credit score for a single address
/api/v2/score/batchGETGet credit scores for multiple addresses
/api/v2/score/boosted/{address}GETGet boosted score with off-chain data

​
Report Endpoints

EndpointMethodDescription
/api/v2/report/{address}GETGet comprehensive credit report
/api/v2/report/{address}/{chain_id}GETGet chain-specific report

​
Identity Endpoints

EndpointMethodDescription
/api/v2/identity/{address}GETGet identity attestations

​
Sandbox Endpoints

EndpointMethodDescription
/api/v2/sandbox/score/{address}GETGet mock credit score
/api/v2/sandbox/report/{address}GETGet mock credit report

​
Request Format

​
Path Parameters

Some endpoints accept path parameters (e.g., {address}). These support:
  • Ethereum addresses: 0x742d35Cc6634C0532925a3b844Bc9e7595f0Ab17
  • ENS names: vitalik.eth

​
Query Parameters

Query parameters should be URL-encoded and appended to the URL: 
GET /api/v2/score/batch?addresses=0x123...,0x456...

​
Response Format

All responses are returned in JSON format: 
{
  "address": "0x...",
  "score": 750,
  "classification": "Very Good",
  "model": "andromeda",
  "cached": false,
  "timestamp": "2024-01-15T10:30:00Z"
}

​
Common Response Fields

FieldTypeDescription
addressstringThe resolved Ethereum address
cachedbooleanWhether the response was served from cache
timestampstringISO 8601 timestamp of the response

​
Rate Limiting

API requests are rate-limited based on your plan:
PlanRequests/MonthRate Limit
Free1,00010 req/min
Growth50,000100 req/min
ProUnlimited1,000 req/min
When you exceed the rate limit, you’ll receive a 429 Too Many Requests response.

​
Caching

Responses are cached for 5 minutes per address to optimize performance. The cached field in responses indicates whether the data was served from cache. To force a fresh calculation, wait for the cache to expire or contact support for cache invalidation.

​
Error Handling

See the Error Handling Guide for detailed information on handling API errors.

​
Common Error Codes

CodeDescription
400Bad Request - Invalid parameters
401Unauthorized - Invalid or missing API key
404Not Found - Address not found or invalid
429Too Many Requests - Rate limit exceeded
500Internal Server Error

​
SDKs & Libraries

Coming soon:
  • JavaScript/TypeScript SDK
  • Python SDK
  • Go SDK
In the meantime, you can use any HTTP client to interact with the API.