Skip to main content
POST
/
api
/
v2
/
report
/
address
/
{address}
curl -X POST "https://api.credprotocol.com/api/v2/report/address/vitalik.eth" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Coinbase Account",
    "total_asset_usd": 75000,
    "total_collateral_usd": 25000,
    "count_transactions": 450
  }'

{
  "report": {
    "address": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
    "timestamp": "2024-01-15T10:30:00Z",
    "first_transaction": {
      "timestamp": 1438918251,
      "block_number": 46147,
      "chain_id": 1
    },
    "summary": {
      "total_asset_usd": 200000.50,
      "total_collateral_usd": 75000.00,
      "total_debt_usd": 15000.00,
      "count_transactions": 2906,
      "count_transfers": 1234
    },
    "additional": {
      "source": {
        "name": "Coinbase Account",
        "data": {
          "total_asset_usd": 75000,
          "total_collateral_usd": 25000,
          "count_transactions": 450
        }
      }
    },
    "chains": []
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.credprotocol.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Overview

Generates a comprehensive credit report that combines on-chain blockchain data with additional off-chain metrics you provide. This allows for more accurate credit assessments by including verified external data sources like centralized exchange balances or traditional financial data.
Off-chain data is added to the on-chain totals, providing a complete financial picture across both DeFi and traditional finance.

​
Path Parameters

​
address
string
required
Ethereum address or ENS name (e.g., vitalik.eth or 0x742d35Cc6634C0532925a3b844Bc454e4438f44e)

​
Request Body

​
name
string
required
Source name for the additional data (e.g., “Coinbase Account”, “Bank of America”, “Binance”)
​
total_asset_usd
number
Total value of off-chain assets in USD
​
total_collateral_usd
number
Total collateral value from off-chain sources in USD
​
total_debt_usd
number
Total debt/liabilities from off-chain sources in USD
​
count_transactions
integer
Number of verified off-chain transactions
​
count_transfers
integer
Number of verified off-chain transfers

​
Response

The response follows the same structure as the standard credit report, with an additional additional field containing the off-chain data source information.
​
report
object
The complete credit report object
​
report.address
string
The resolved Ethereum address (checksummed)
​
report.summary
object
Combined summary metrics (on-chain + off-chain totals)
​
report.additional
object
Off-chain data source information
​
report.additional.source.name
string
Name of the off-chain data source
​
report.additional.source.data
object
The off-chain metrics that were added
​
report.chains
array
Per-chain breakdown of on-chain data

​
Use Cases

Include balances from centralized exchanges like Coinbase, Binance, or Kraken to show complete crypto holdings beyond on-chain wallets.
Incorporate verified bank account balances or traditional credit data for a hybrid DeFi/TradFi credit assessment.
Lenders can request users provide off-chain data for more accurate creditworthiness evaluation and better loan terms.
Show the full financial picture when users have assets across multiple platforms and chains.
curl -X POST "https://api.credprotocol.com/api/v2/report/address/vitalik.eth" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Coinbase Account",
    "total_asset_usd": 75000,
    "total_collateral_usd": 25000,
    "count_transactions": 450
  }'

{
  "report": {
    "address": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
    "timestamp": "2024-01-15T10:30:00Z",
    "first_transaction": {
      "timestamp": 1438918251,
      "block_number": 46147,
      "chain_id": 1
    },
    "summary": {
      "total_asset_usd": 200000.50,
      "total_collateral_usd": 75000.00,
      "total_debt_usd": 15000.00,
      "count_transactions": 2906,
      "count_transfers": 1234
    },
    "additional": {
      "source": {
        "name": "Coinbase Account",
        "data": {
          "total_asset_usd": 75000,
          "total_collateral_usd": 25000,
          "count_transactions": 450
        }
      }
    },
    "chains": []
  }
}

​
Performance

  • Response Time: Typically 4-12 seconds
  • Caching: Not cached - recalculated on each request to include fresh off-chain data
  • Validation: All numeric values must be non-negative