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

Rankings

List the top N assets by rank

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

Takes the n highest-ranked assets, then filters, sorts and pages within them.

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

  • nintegerQuery
    Size of the ranked set.
    Default: 100
    50100200500
  • limitintegerQuery
    Page size, at most n. Defaults to 50 when n is 50, otherwise 100.
    Range: 1 – 500
  • offsetintegerQuery
    Rows to skip.
    Default: 0Range: 0 – …
  • sortstringQuery
    Default: rank_asc
    Allowed values (41)
    id_ascid_descname_ascname_descrank_ascrank_desccreated_at_asccreated_at_descupdated_at_ascupdated_at_descdeprecated_at_ascdeprecated_at_descrelevanceprice_ascprice_descprice_change_1h_ascprice_change_1h_descprice_change_24h_ascprice_change_24h_descprice_change_7d_ascprice_change_7d_descprice_change_30d_ascprice_change_30d_descprice_change_3m_ascprice_change_3m_descprice_change_1y_ascprice_change_1y_descprice_change_ytd_ascprice_change_ytd_descprice_change_all_ascprice_change_all_descmarket_cap_ascmarket_cap_descmarket_cap_change_24h_ascmarket_cap_change_24h_descvolume_ascvolume_descvolume_change_24h_ascvolume_change_24h_descdominance_ascdominance_desc
  • slugstringQuery
  • symbolstringQuery
  • namestringQuery
  • typestringQuery
    Asset type, or all.
    Default: coin
    coinfiatindexcommodityall
  • verifiedbooleanQuery
  • deprecatedbooleanQuery
  • tagstringQuery
    Tag slug.

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

One page of top assets. meta.count is at most n.
Response fields (67)
  • 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[].slugstring
  • data[].symbolstring
  • data[].namestring
  • data[].signstring | null
  • data[].fa_symbolstring | null
  • data[].display_namestring | null
    Name in the requested language.
  • data[].descriptionstring | null
    Detail response only.
  • data[].typestring
  • data[].colorstring | null
  • data[].rankinteger | null
  • data[].verifiedboolean
  • data[].deprecatedboolean
  • data[].logo_urlstring | null
  • data[].urlsobject | null
    Link lists by kind, such as website and explorer.
  • data[].date_addedstring | null
  • data[].date_launchedstring | null
  • data[].max_supplynumber | null
  • data[].infinite_supplyboolean
  • data[].unitstring | null
  • data[].is_stableboolean
  • data[].metricsobject
    Latest market numbers. price is in USD, price_irt in Toman.
  • data[].metrics.pricenumber | null
  • data[].metrics.price_irtnumber | null
  • data[].metrics.price_change_percent_1hnumber | null
  • data[].metrics.price_change_percent_24hnumber | null
  • data[].metrics.price_change_percent_7dnumber | null
  • data[].metrics.price_change_percent_30dnumber | null
  • data[].metrics.price_change_percent_3mnumber | null
  • data[].metrics.price_change_percent_1ynumber | null
  • data[].metrics.price_change_percent_ytdnumber | null
  • data[].metrics.price_change_percent_allnumber | null
  • data[].metrics.price_change_percent_irt_1hnumber | null
  • data[].metrics.price_change_percent_irt_24hnumber | null
  • data[].metrics.price_change_percent_irt_7dnumber | null
  • data[].metrics.price_change_percent_irt_30dnumber | null
  • data[].metrics.price_change_percent_irt_3mnumber | null
  • data[].metrics.price_change_percent_irt_1ynumber | null
  • data[].metrics.price_change_percent_irt_ytdnumber | null
  • data[].metrics.price_change_percent_irt_allnumber | null
  • data[].metrics.circulating_supplynumber | null
  • data[].metrics.total_supplynumber | null
  • data[].metrics.market_capnumber | null
  • data[].metrics.market_cap_change_percent_24hnumber | null
  • data[].metrics.fully_diluted_market_capnumber | null
  • data[].metrics.fully_diluted_market_cap_change_percent_24hnumber | null
  • data[].metrics.volumenumber | null
  • data[].metrics.volume_change_percent_24hnumber | null
  • data[].metrics.dominancenumber | null
  • data[].metrics.last_updated_atstring | null
  • data[].tagsarray
  • data[].tags[].slugstring
  • data[].tags[].namestring
  • data[].tags[].display_namestring | null
  • data[].networksarray
    Detail response only.
  • data[].networks[].slugstring
  • data[].networks[].namestring
  • data[].networks[].display_namestring | null
  • data[].networks[].contract_addressstring | null
  • data[].walletsarray
    Detail response only.
  • data[].wallets[].slugstring
  • data[].wallets[].namestring
  • data[].wallets[].display_namestring | null
  • data[].wallets[].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