ArzDigital API
فارسیSign inSign up
ArzDigital API

Trading pairs

List the top pair of each exchange

GEThttps://api.arzdigital.com/v1/pairs/top
X-API-Key headerHow credits work

For the base or quote you name, the most traded pair on each exchange. Send at least one of base, quote, base_symbol or quote_symbol; without one the call returns 1001. With provider_kind=gold_platform it returns one pair per gold platform, highest trust score first, and names the platform in source.exchange.

Credit use: Each successful call costs 1 credit for every 100 rows it returns, rounded up. For example, 250 rows cost 3 credits.

An empty result and any error cost nothing.

Parameters

  • limitintegerQuery
    Page size.
    Default: 100Range: 1 – 1000
  • offsetintegerQuery
    Rows to skip.
    Default: 0Range: 0 – …
  • contract_typestringQuery
    spototcfuturesperpetualoptionsindexdex
  • searchstringQuery
  • namestringQuery
  • exchangestringQuery
    Exchange slug.
  • exchange_countrystringQuery
  • basestringQuery
    Base asset slug.
  • quotestringQuery
    Quote asset slug.
  • base_symbolstringQuery
  • quote_symbolstringQuery
  • base_exchange_symbolstringQuery
  • quote_exchange_symbolstringQuery
  • financial_providerstringQuery
  • provider_kindstringQuery
    currency_exchangegold_platform
  • deprecatedbooleanQuery

Request headers

  • X-API-KeystringRequired

    Your API key. Send it in this header on every call; it is not accepted in the URL.

Response

One page of top pairs.
Response fields (59)
  • statusstring
  • metaobject
    Absent count means the data service did not report how many rows it returned.
  • meta.countinteger
    Rows this call was charged for, the length of data.
  • dataarray
  • data[].contract_typestring
  • data[].namestring
  • data[].deprecatedboolean
  • data[].trading_urlstring
  • data[].baseobject
  • data[].base.slugstring
  • data[].base.symbolstring
  • data[].base.namestring
  • data[].base.typestring
  • data[].base.verifiedboolean
  • data[].base.colorstring | null
  • data[].base.deprecatedboolean
  • data[].base.logo_urlstring | null
  • data[].base.exchange_symbolstring
    The symbol used on the exchange.
  • data[].quoteobject
  • data[].quote.slugstring
  • data[].quote.symbolstring
  • data[].quote.namestring
  • data[].quote.typestring
  • data[].quote.verifiedboolean
  • data[].quote.colorstring | null
  • data[].quote.deprecatedboolean
  • data[].quote.logo_urlstring | null
  • data[].quote.exchange_symbolstring
    The symbol used on the exchange.
  • data[].pricenumber
  • data[].price_irtnumber
  • data[].price_in_quotenumber
  • data[].buy_fee_percentnumber | null
  • data[].sell_fee_percentnumber | null
  • data[].sourceobject
    Where the pair trades. Only gold-platform top pairs carry it, with the platform in exchange.
  • data[].source.slugstring
  • data[].source.namestring
  • data[].source.deprecatedboolean
  • data[].source.exchangeobject
  • data[].source.exchange.slugstring
  • data[].source.exchange.namestring
  • data[].source.exchange.fa_namestring | null
  • data[].source.exchange.colorstring | null
  • data[].source.exchange.deprecatedboolean
  • data[].source.exchange.logo_urlstring | null
  • data[].source.exchange.trust_scorenumber | null
  • data[].source.exchange.metaobject
  • data[].source.exchange.meta.descriptionstring | null
  • data[].source.exchange.meta.statusstring | null
  • data[].source.exchange.meta.countrystring | null
  • data[].source.exchange.meta.citystring | null
  • data[].source.exchange.meta.rankinteger | null
  • data[].source.exchange.meta.trust_scorenumber | null
  • data[].source.exchange.meta.license_statusstring | null
  • data[].source.exchange.meta.custody_modelstring | null
  • data[].source.exchange.meta.physical_redemption_statusstring | null
  • data[].source.exchange.meta.requires_kycboolean | null
  • data[].source.exchange.meta.buy_fee_percentnumber | null
  • data[].source.exchange.meta.sell_fee_percentnumber | null
  • data[].source.exchange.meta.linksobject

Response headers

  • X-Credits-Charged
    Credits this call cost. 0 on every non-200 response.
  • X-Credits-Remaining
    Account balance after this call, not counting what calls still in flight have set aside. Negative only for an account in debt after an adjustment.
  • X-RateLimit-Limit
    Requests per minute allowed for this key.
  • X-RateLimit-Remaining
    Requests left in the current window.
  • X-RateLimit-Reset
    Unix seconds at which the window has room again.

Errors

  • bad_requesterror_code 1001
    A parameter is missing

Errors are never charged. Errors