API Reference Overview

Welcome to the CDR.fyi API reference documentation. This section provides detailed information about our API endpoints, including request and response formats, example code snippets, and error handling.

Base URL

All API endpoints are relative to the following base URL: https://api.cdr.fyi/v1

Authentication

All API requests must be authenticated with a bearer token. Refer to the Authentication section for details on how to obtain and use access tokens.

Request Format

Unless otherwise specified, all API requests should be made with the Content-Type header set to application/json.

curl -H "Content-Type: application/json" -H "Authorization: Bearer YOUR_ACCESS_TOKEN" https://api.cdr.fyi/v1/endpoint

Response Format

API responses are returned in JSON format. Successful responses will have a 2xx status code, while errors will have a 4xx or 5xx status code.

Example of a Successful Response

{
  "data": {
    "id": "abc123",
    "name": "Example Resource"
  }
}

Example of an Error Response

{
  "error": {
    "code": 404,
    "message": "Resource not found"
  }
}

Pagination

Some API endpoints support pagination. Refer to the Custom Headers section for details on how to use pagination headers.

API Endpoints

Orders
Suppliers
Marketplaces
Purchasers
Projects (Beta)

​Base URL

​Authentication

​Request Format

​Response Format

​Example of a Successful Response

​Example of an Error Response

​Pagination

​API Endpoints