Getting Started with Candor's API


Welcome to Candor, where our Φ (Phi) score provides a comprehensive and transparent credit rating for blockchain addresses. Our state-of-the-art API offers unparalleled accuracy, deriving credit ratings from a myriad of on-chain metrics such as DeFi contracts interacted with, high gas transactions, NFT holdings, and the age of the address.

This guide will walk you through the process of integrating Candor's API into your application. From acquiring an API key to understanding token usage, we've got you covered.

Acquiring Your API Key

To get started, you'll need an API key which authenticates your access to our API services. Here's how to acquire one:

  • Sign Up If you haven't already, register for a Candor account.
  • Dashboard Head over to your Dashboard and navigate to the API section.
  • Generate API Key Click the "Generate New API Key" button.
  • Securely Store Your Key Save your API key in a secure location.
Note: Never share your API key publicly or embed it directly in client-side code.

Making Your First API Call

Once you've acquired your API key, making your first API call is a breeze. Use your favorite HTTP client and refer to our API documentation for the specific endpoints and parameters. Don't forget to include your API key in the header.

Retrieve Score

curl -X GET "" \
     -H "Authorization: Bearer your_api_key_here"

Expected Result

  "score": 750,
  "lastUpdated": "2021-08-01T00:00:00.000Z"

Token Usage and Pricing

Candor employs a token-based pricing model. Purchase tokens to pay for API calls at varying levels of depth—1 token for just the Φ score, 2 tokens for the Φ score and a quick report, and 5 tokens for a full report. This flexibility allows you to tailor your usage based on your needs.

We're thrilled to have you begin working with Candor's API and we are confident that our Φ score will add unparalleled value to your business or personal use case. If you have any further questions, feel free to consult our FAQ or reach out to customer support.