Configs

Fetch site configuration data

Mapping Requests

You can use a mapping request to retrieve a mapping of symbols to related details. For example, you can send a request to pub:map:currency:label to map symbols to their verbose friendly names (e.g. BTC -> Bitcoin)

RequestDescription
pub:map:currency:symMap symbols to their API symbols (e.g. DSH -> DASH)
pub:map:currency:labelMaps symbols to their verbose friendly name (e.g. BTC -> Bitcoin
pub:map:currency:unitMaps symbols to their unit of measure (where applicable) (e.g. IOT -> MegaIOTA)
pub:map:currency:undlMaps derivatives symbols to their underlying currency (e.g. BTCF0 -> BTC)
pub:map:currency:poolMaps symbols to the underlying network/protocol they operate on (e.g. BAT -> ETH)
pub:map:currency:explorerMaps symbols to their recognised block explorer URLs (e.g. ETH -> https://etherscan.io)
pub:map:currency:tx:feeMaps currencies to their current withdrawal fee amount
pub:map:tx:methodMaps currencies to their appropriate method for API withdrawals (e.g. BTC -> bitcoin)

Listing Requests

You can use a listing request to retrieve lists of currencies, trading pairs, or leaderboard competitions.

RequestDescription
pub:list:pair:exchangeFetch a list of valid exchange trading pairs
pub:list:pair:marginFetch a list of valid margin trading pairs
pub:list:pair:futuresFetch a list of valid derivative pairs
pub:list:pair:securitiesFetch a list of vaid securities pairs
pub:list:currencyFetch a list of all currencies available on the platform
pub:list:competitionsFetch a list of all active leaderboard competitions

Info Requests

You can use an info request to fetch detailed information about pairs or transactions

RequestDescriptionMapping
pub:info:pairFetches an array of market information for each trading pair (WIP)[[PAIR, [PLACEHOLDER, PLACEHOLDER, PLACEHOLDER, MIN_ORDER_SIZE, MAX_ORDER_SIZE, PLACEHOLDER, PLACEHOLDER, PLACEHOLDER, INITIAL_MARGIN, MIN_MARGIN]]...]
pub:info:pair:futuresFetches an array of market information for each derivative trading pair (WIP)[[PAIR, [PLACEHOLDER, PLACEHOLDER, PLACEHOLDER, MIN_ORDER_SIZE, MAX_ORDER_SIZE, PLACEHOLDER, PLACEHOLDER, PLACEHOLDER, INITIAL_MARGIN, MIN_MARGIN]]...]
pub:info:tx:statusFetches an array showing the wallet status for each currency for deposits and withdrawals (1 = active, 0 = maintenance) Also shows if payment IDs are allowed for deposits and withdrawals (1 = allowed, 0 = not allowed)[METHOD, DEP_STATUS, WD_STATUS, PH, PH, PH, PH, PAYMENT_ID_DEP, PAYMENT_ID_WD, PH, PH, DEPOSIT_CONFIRMATIONS_REQUIRED]

Other Requests

Requests that aren't grouped in the Map, List, or Info categories.

RequestDescription
pub:spec:marginFetches lists of active haircuts and risk coefficients on margin pairs
pub:feesFetch derivatives fees config

Requesting multiple configurations

Instead of performing a request for each configuration item, it is possible to fetch multiple configurations in a single request. To do this, append each request into a single string separated by comma's without any spaces.

Example of a multi-request that will fetch both margin and exchange trading pairs:
pub:list:pair:exchange,pub:list:pair:margin

Ratelimit: 90 req/min

Language
Click Try It! to start a request and see the response here!