Retrieve the master wallet of a network

GET/v1/master_wallets/{network}

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.

Path parameters

Name	Type	Description
`network` required	string	Network slug, e.g. `bsc`. At most 64 characters.

curl "https://api.ctpeway.com/v1/master_wallets/{network}" \
  -H "Authorization: Bearer $CTPEWAY_API_KEY"

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

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

const result = await ctpeway.balances.retrieve('<network>');

Response

200 OK

Field	Type	Description
`network`	string	Network slug.
`address`	string	Fund this address with the native coin to pay fees for token deposits.
`native_asset`	string
`balances`	array of objects
`balances[].asset`	string
`balances[].asset_id`	string	24 hexadecimal characters.
`balances[].contract` optional	string
`balances[].decimals`	integer
`balances[].amount`	string	Base units, as booked by the ledger. A whole number written as a string of digits.
`balances[].held`	string	Deposits of this asset that are confirmed and held in their addresses on this network (the master wallet cannot pay for their release yet, or a release guard applies). Not part of `amount`. A whole number written as a string of digits.
`balances[].pending`	string	Deposits of this asset that are confirmed and waiting their turn to be released, or being released now. Not part of `amount` yet. A whole number written as a string of digits.
`held_count`	integer	Settlements waiting on this network because the master wallet cannot pay for them.
`required_to_clear`	string	Native coin needed to release everything held, in base units. A whole number written as a string of digits.
`livemode`	boolean

{
  "network": "string",
  "address": "string",
  "native_asset": "string",
  "balances": [
    {
      "asset": "string",
      "asset_id": "0123456789abcdef01234567",
      "contract": "string",
      "decimals": 0,
      "amount": "1000000",
      "held": "1000000",
      "pending": "1000000"
    }
  ],
  "held_count": 0,
  "required_to_clear": "1000000",
  "livemode": true
}

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: