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

Networks

List networks

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

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 – …
  • sortstringQuery
    Default: id_asc
    id_ascid_descname_ascname_desccreated_at_asccreated_at_descupdated_at_ascupdated_at_desc
  • slugstringQuery
  • namestringQuery

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 networks.
Response fields (21)
  • 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[].namestring
  • data[].display_namestring | null
  • data[].logo_urlstring | null
  • data[].native_assetobject | null
  • data[].native_asset.slugstring
  • data[].native_asset.symbolstring
  • data[].native_asset.namestring
  • data[].native_asset.fa_symbolstring | null
  • data[].native_asset.display_namestring | null
  • data[].native_asset.descriptionstring | null
  • data[].native_asset.signstring | null
  • data[].native_asset.typestring
  • data[].native_asset.colorstring | null
  • data[].native_asset.verifiedboolean
  • data[].native_asset.deprecatedboolean
  • data[].native_asset.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