List the chains open for new operations

GET

/chains

const url = 'https://example.com/v2/chains';
const options = {method: 'GET', headers: {'X-CowriePay-Key': '<X-CowriePay-Key>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/v2/chains \
  --header 'X-CowriePay-Key: <X-CowriePay-Key>'

Returns the chains currently enabled on your network (a live key sees enabled mainnet chains, a test key sees enabled testnet chains), each with its supported assets. Only enabled chains are returned, so you can render a chain/asset picker without discovering a paused chain through a 422 CHAIN_NOT_ENABLED on wallet and withdrawal creation. Stays in lock-step with those create endpoints (both read the same enablement flag).

Authorizations

ApiKeyAuth

Responses

200

The enabled chains for your network.

application/json

object

network

required

The network your key operates on (from the key prefix).

string

Allowed values: testnet mainnet

chains

required

Array<object>

object

chain

required

Base protocol, as you send it when creating a wallet/withdrawal.

string

Allowed values: TRON BSC ETH

assets

required

The assets supported on this chain.

Array<string>

Allowed values: USDT_TRON USDT_BSC USDT_ETH USDC_ETH EURC_ETH ETH BNB

Example

{
  "network": "testnet",
  "chains": [
    {
      "chain": "BSC",
      "assets": [
        "USDT_BSC",
        "BNB"
      ]
    },
    {
      "chain": "TRON",
      "assets": [
        "USDT_TRON"
      ]
    }
  ]
}

401

Invalid or revoked API key / HMAC signature mismatch

application/json

object

error

required

Human-readable message, for display/logging. Do NOT branch on this text.

string

code

required

Stable, machine-readable error code, branch on this, not the message. Common values: VALIDATION_ERROR, INVALID_JSON, PAYLOAD_TOO_LARGE, MISSING_AUTH_HEADERS, INVALID_SIGNATURE, TIMESTAMP_EXPIRED, REPLAY_DETECTED, INVALID_API_KEY, IP_NOT_ALLOWED, API_KEY_EXPIRED, WORKSPACE_INACTIVE, INSUFFICIENT_SCOPE, NOT_FOUND, CONFLICT, UNPROCESSABLE, INSUFFICIENT_BALANCE, INVALID_DESTINATION_ADDRESS, DESTINATION_IS_INTERNAL, CHAIN_NOT_ENABLED, FAUCET_ONLY_SANDBOX, FAUCET_ADDRESS_NOT_FOUND, FAUCET_INVALID_ASSET, FAUCET_AMOUNT_OVER_CAP, FAUCET_RATE_LIMITED, FAUCET_TOO_MANY_ITEMS, FAUCET_DUPLICATE_ASSET, FAUCET_NATIVE_REQUIRES_DEPOSIT, FAUCET_NATIVE_BUDGET_EXCEEDED, FAUCET_DISPENSER_EXHAUSTED, WITHDRAWAL_NOT_CANCELLABLE, IDEMPOTENCY_CONFLICT, IDEMPOTENCY_MISMATCH, IDEMPOTENCY_KEY_INVALID, FEATURE_NOT_AVAILABLE, RATE_LIMITED, DATABASE_ERROR, INTERNAL_ERROR, UNAUTHORIZED, FORBIDDEN, UNSUPPORTED_MEDIA_TYPE, WITHDRAWALS_FROZEN, WORKSPACE_NOT_FOUND, SYSTEM_WORKSPACE_PROTECTED, FAUCET_INVALID_AMOUNT, FAUCET_NO_ASSETS, FAUCET_NOT_SANDBOX. Most failures do NOT carry a business code. 326 throw sites raise a generic one (VALIDATION_ERROR, NOT_FOUND, UNPROCESSABLE, UNAUTHORIZED, CONFLICT, FORBIDDEN) against 46 named public codes, so a generic code is the common case and a named one is the exception. Branch on code; treat error as human text that may be reworded. The full catalogue, with causes and next steps, is the Error codes guide.

string

Example

{
  "error": "Insufficient balance. Available: 10.000000, Requested: 50.000000",
  "code": "INSUFFICIENT_BALANCE"
}