Providers

Active liquidity providers and engine breakdown (GET /v1/providers)

List liquidity providers

get

/v1/providers

Active CEX exchangers (engine: off-chain), active DEX exchangers (on-chain), and a single private provider when the private task queue is configured.

id is the slug used as provider on quote/swap. Inactive exchangers are omitted. status on each item is always active for this catalog.

aggregatedFrom / breakdown count those engine groups. KYC and legal fields are inherited from the admin provider catalog when a match exists.

Responses

200

Provider catalog plus engine counts

application/json

totalProvidersnumberRequired

Total number of providers in the response

Example: 6

aggregatedFromstring[]Required

Engine categories represented in the catalog

Example: ["on-chain","off-chain","private"]

breakdownobjectRequired

Count of providers per engine type

Example: {"on-chain":3,"off-chain":2,"private":1}

500

Failed to fetch aggregator info

application/json

get/v1/providers

GET /v1/providers HTTP/1.1
Host: api.yifi.io
Accept: */*

{
  "providers": [
    {
      "id": "quickex",
      "name": "Quickex",
      "logoUrl": "https://cdn.yifi.io/providers/quickex.svg",
      "engine": "off-chain",
      "status": "active",
      "kycLevel": 0,
      "kycLevelName": "No KYC",
      "legal": [
        {
          "docName": "Terms of Use",
          "docLink": "https://example.com/terms"
        }
      ],
      "description": "Non-custodial CEX with optional KYC"
    }
  ],
  "totalProviders": 6,
  "aggregatedFrom": [
    "on-chain",
    "off-chain",
    "private"
  ],
  "breakdown": {
    "on-chain": 3,
    "off-chain": 2,
    "private": 1
  }
}