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

Gold platforms

List the assets a gold platform offers

GEThttps://api.arzdigital.com/v1/gold-platforms/{slug}/assets
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

  • slugstringPathRequired
    Gold platform slug, such as igolden.
    Example: igolden

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 platform's assets, with the terms it offers for each.
Response fields (14)
  • statusstring
  • dataarray
  • data[].slugstring
  • data[].symbolstring
  • data[].namestring
  • data[].fa_namestring | null
  • data[].display_namestring | null
  • data[].typestring
  • data[].logo_urlstring | null
  • data[].capabilitiesarray
    What the platform offers for this asset, such as online_buy or physical_redemption.
  • data[].minimum_purchase_irtnumber | null
    Smallest purchase in Toman.
  • data[].minimum_redemption_mgnumber | null
    Smallest physical redemption in milligrams.
  • data[].buy_fee_percentnumber | null
  • data[].sell_fee_percentnumber | 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