List networks

GET/v1/networks

The enabled networks of the key’s environment (testnets for a test key). A publishable key may call this operation (x-publishable-key); it is one of the few on this API that accept one.

Authorization

Send your API key as a bearer token in the Authorization header. Secret API key: Authorization: Bearer ctp_live_sk_…. A publishable key (ctp_…_pk_…) is accepted by these operations only, which serve reference data: getRate, listAssets, listNetworks (each marked x-publishable-key: true). Every other operation refuses it with 403 publishable_key_not_allowed, whatever Origin the request carries: that header binds browsers, not other clients, and nothing on this API relies on it.

Query parameters

Name	Type	Description
limit	integer	Number of items to return (1 to 100). Default 50. Minimum 1, maximum 100.
starting_after	string	Return items after this id: pass next_cursor of the previous page. At most 100 characters.

Example request

cURL

curl "https://api.ctpeway.com/v1/networks" \
  -H "Authorization: Bearer $CTPEWAY_API_KEY"

Node SDK

import { CtpeWay } from '@ctpeway/sdk';

const ctpeway = new CtpeWay(process.env.CTPEWAY_API_KEY);

const result = await ctpeway.networks.list();

Response

200 OK

Field	Type	Description
data	array of objects
data[].id	string	24 hexadecimal characters.
data[].slug	string
data[].family	string	One of evm, bitcoin, solana, tron.
data[].chain_id optional	integer
data[].caip2	string
data[].display_name	string
data[].native_asset	string
data[].explorer_tx_url optional	string	URL template containing {txHash}.
data[].confirmation_rule	string	How the network decides that a payment is confirmed: confirmations counts blocks on top of it (confirmations_required); finalized and safe wait for the network’s own finality, whatever the count. One of confirmations, finalized, safe.
data[].confirmations_required	integer	With confirmation_rule: "confirmations": how many confirmations a payment needs. With finalized or safe the network’s own finality decides and this is only the depth used if that cannot be read: do not count towards it.
data[].estimated_confirmation_seconds optional	integer	The expected time from sending a payment until it counts as confirmed. With confirmation_rule: "confirmations": confirmations_required × the network’s block interval. With finalized or safe: the usual time until a block carries that tag. An estimate, not a promise. Absent when there is no figure for the network.
data[].faucet_url optional	string	Test networks: where to get test coins.
data[].explorer_address_url optional	string	URL template of a block explorer’s page for an address, containing {address}.
data[].livemode	boolean
has_more	boolean	Whether more items exist after this page.
next_cursor	string or null	Pass as starting_after to get the next page; null on the last page.

{
  "data": [
    {
      "id": "0123456789abcdef01234567",
      "slug": "string",
      "family": "evm",
      "chain_id": 0,
      "caip2": "string",
      "display_name": "string",
      "native_asset": "string",
      "explorer_tx_url": "string",
      "confirmation_rule": "confirmations",
      "confirmations_required": 0,
      "estimated_confirmation_seconds": 0,
      "faucet_url": "string",
      "explorer_address_url": "string",
      "livemode": true
    }
  ],
  "has_more": true,
  "next_cursor": "string"
}

The values are placeholders generated from the schema. They show the shape, not real data.

Errors

A failed request answers with the error format described under Errors.

Besides the codes any endpoint can return, this endpoint can answer with these code values:

• invalid_cursor