Quickstart

Get started with Cred Protocol API in under 5 minutes

Prerequisites

Before you begin, you’ll need:

• A Cred Protocol account (sign up here)
• An API key from your Dashboard

Get Your API Key

1. Log in to Dashboard

   Go to app.credprotocol.com and log in to your account.

2. Navigate to API Keys

   Click on API Keys in the sidebar to access your API key management.

3. Create a New Key

   Click Create API Key, give it a name, and copy your new API key.

   Store your API key securely. You won’t be able to see it again after creation.

Make Your First Request

Get a Credit Score

Use the following request to get a credit score for an Ethereum address:

cURL

curl -X GET "https://api.credprotocol.com/api/v2/score/address/vitalik.eth" \
  -H "Authorization: Bearer YOUR_API_KEY"

Example Response

{
  "address": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
  "score": 847,
  "decile": 7,
  "range": "very_good",
  "model_version": "andromeda_1.0",
  "timestamp": "2024-01-15T10:30:00Z"
}

Understanding the Response

Field	Description
address	The resolved Ethereum address
score	Credit score between 300-1000
decile	Score decile (1-10)
range	Score range (low, fair, good, very_good, excellent)
model_version	Scoring model version (currently “andromeda_1.0”)
timestamp	When the score was calculated

Test with Sandbox

Before integrating with production data, use our sandbox endpoints to test your integration:

cURL

curl -X GET "https://api.credprotocol.com/api/v2/sandbox/score/address/0x742d35Cc6634C0532925a3b844Bc9e7595f0Ab17" \
  -H "Authorization: Bearer YOUR_API_KEY"

Sandbox endpoints return deterministic mock data and don’t count against your API quota.

Next Steps

Credit Reports

Generate comprehensive credit reports

Identity Verification

Verify on-chain identity attestations

Error Handling

Learn how to handle API errors

Authentication

Deep dive into API authentication