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

Exchanges

Get one exchange

GEThttps://api.arzdigital.com/v1/exchanges/{slug}
X-API-Key headerHow credits work

Credit use: Each successful call costs 1 credit, whatever it returns.

An empty result and any error cost nothing.

Parameters

  • slugstringPathRequired
    Exchange slug, such as wallex.
    Example: wallex

Request headers

  • X-API-KeystringRequired

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

  • Accept-Languagestring
    Language for translated names and descriptions, such as fa-IR. Unsupported values fall back to en-US.

Response

The exchange, with full metadata and its top pair.
Response fields (52)
  • statusstring
  • dataobject
  • data.slugstring
  • data.namestring
  • data.fa_namestring | null
  • data.descriptionstring | null
  • data.display_namestring | null
  • data.rankinteger | null
  • data.countrystring | null
  • data.colorstring | null
  • data.deprecatedboolean
  • data.logo_urlstring | null
  • data.asset_countinteger | null
  • data.pair_countinteger | null
  • data.service_to_irboolean
  • data.date_launchedstring
  • data.trust_scorenumber
  • data.typearray
  • data.volumenumber
    Reported 24-hour volume in USD.
  • data.volume_irtnumber
    Reported 24-hour volume in Toman.
  • data.volume_change_percent_24hnumber
  • data.liquiditynumber
  • data.volume_chart_urlstring
    URL of a rendered volume chart image. Can be empty.
  • data.metaobject
    Fees and, on detail responses, descriptions and socials.
  • data.meta.maker_feestring | number | null
  • data.meta.taker_feestring | number | null
  • data.meta.descriptionstring | null
  • data.meta.long_descriptionstring | null
  • data.meta.socialsobject
  • data.top_pairobject
  • data.top_pair.pair_namestring
  • data.top_pair.pricenumber
  • data.top_pair.price_irtnumber
  • data.top_pair.price_in_quotenumber
  • data.top_pair.volumenumber
  • data.top_pair.volume_percentagenumber
  • data.top_pair.base_volumenumber
  • data.top_pair.quote_volumenumber
  • data.top_pair.liquiditystring
  • data.top_pair.updated_atstring
  • data.top_pair.base_currencyobject
  • data.top_pair.base_currency.slugstring
  • data.top_pair.base_currency.symbolstring
  • data.top_pair.base_currency.namestring
  • data.top_pair.base_currency.fa_namestring | null
  • data.top_pair.base_currency.logo_urlstring | null
  • data.top_pair.quote_currencyobject
  • data.top_pair.quote_currency.slugstring
  • data.top_pair.quote_currency.symbolstring
  • data.top_pair.quote_currency.namestring
  • data.top_pair.quote_currency.fa_namestring | null
  • data.top_pair.quote_currency.logo_urlstring | null

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