Quickstart

Prerequisites

Before you begin, you’ll need:

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

Get Your API Key

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

Navigate to API Keys

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

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 -X GET "https://api.credprotocol.com/api/v2/score/address/vitalik.eth" \
  -H "Authorization: Bearer YOUR_API_KEY"

const response = await fetch('https://api.credprotocol.com/api/v2/score/address/vitalik.eth', {
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY'
  }
});

const data = await response.json();
console.log(data);

import requests

response = requests.get(
    'https://api.credprotocol.com/api/v2/score/address/vitalik.eth',
    headers={'Authorization': 'Bearer YOUR_API_KEY'}
)

data = response.json()
print(data)

Example Response

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

Or Use an SDK

If you’re gating access to a product rather than pulling raw scores, the SDKs wrap the trust-evaluation API (/v1/evaluate) — one call returns a 0–100 trust score, a tier, and pass/fail against a policy template. Framework middleware for Express, Hono, Next.js and FastAPI turns that into a one-line guard.

// npm install @cred-protocol/sdk
import { CredClient } from '@cred-protocol/sdk'

const cred = new CredClient({ apiKey: process.env.CRED_API_KEY })
const result = await cred.evaluate({
  walletAddress: 'vitalik.eth',
  policy: 'standard',
})
console.log(result.trustScore, result.trustTier, result.allPassed)

# pip install cred-protocol
from cred_protocol import CredClient

async with CredClient(api_key="cred_sk_...") as cred:
    result = await cred.evaluate(wallet_address="vitalik.eth", policy="standard")
    print(result.trust_score, result.trust_tier, result.all_passed)

See the SDK overview for the adapters and policy templates.

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 -X GET "https://api.credprotocol.com/api/v2/sandbox/score/address/0x742d35Cc6634C0532925a3b844Bc9e7595f0Ab17" \
  -H "Authorization: Bearer YOUR_API_KEY"

const response = await fetch(
  'https://api.credprotocol.com/api/v2/sandbox/score/address/0x742d35Cc6634C0532925a3b844Bc9e7595f0Ab17',
  {
    headers: {
      'Authorization': 'Bearer YOUR_API_KEY'
    }
  }
);

const data = await response.json();

import requests

response = requests.get(
    'https://api.credprotocol.com/api/v2/sandbox/score/address/0x742d35Cc6634C0532925a3b844Bc9e7595f0Ab17',
    headers={'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

SDKs

TypeScript, Python, and framework middleware

Machine Payments

Pay per request with x402 or MPP — no account needed

Get Started

Use Cases

Guides

On-Chain Reputation

Prerequisites

Get Your API Key

Make Your First Request

Get a Credit Score

Example Response

Or Use an SDK

Understanding the Response

Test with Sandbox

Next Steps

Credit Reports

Identity Verification

Error Handling

Authentication

SDKs

Machine Payments

​Prerequisites

​Get Your API Key

​Make Your First Request

​Get a Credit Score

​Example Response

​Or Use an SDK

​Understanding the Response

​Test with Sandbox

​Next Steps

Credit Reports

Identity Verification

Error Handling

Authentication

SDKs

Machine Payments

Prerequisites

Get Your API Key

Make Your First Request

Get a Credit Score

Example Response

Or Use an SDK

Understanding the Response

Test with Sandbox

Next Steps