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

Gold platforms

Get one gold platform

GEThttps://api.arzdigital.com/v1/gold-platforms/{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
    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, with its assets, fees and contact details.
Response fields (53)
  • statusstring
  • dataobject
  • data.slugstring
  • data.kindstring
  • data.namestring
  • data.fa_namestring | null
  • data.display_namestring | null
  • data.descriptionstring | null
  • data.website_urlstring | null
  • data.logo_urlstring | null
  • data.statusstring | null
    active, inactive, temporarily_unavailable or unknown.
  • data.deprecatedboolean
  • data.countrystring | null
  • data.citystring | null
  • data.rankinteger | null
  • data.trust_scorenumber | null
  • data.asset_countinteger
  • data.created_atstring
  • data.updated_atstring
  • data.license_statusstring | null
    verified, provider_claim or unverified.
  • data.custody_modelstring | null
  • data.physical_redemption_statusstring | null
  • data.requires_kycboolean | null
  • data.supported_assetsarray
    Slugs of the assets the platform offers.
  • data.capabilitiesarray
    Everything the platform offers across its assets.
  • 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
  • data.assetsarray
  • data.assets[].slugstring
  • data.assets[].symbolstring
  • data.assets[].namestring
  • data.assets[].fa_namestring | null
  • data.assets[].display_namestring | null
  • data.assets[].typestring
  • data.assets[].logo_urlstring | null
  • data.assets[].capabilitiesarray
    What the platform offers for this asset, such as online_buy or physical_redemption.
  • data.assets[].minimum_purchase_irtnumber | null
    Smallest purchase in Toman.
  • data.assets[].minimum_redemption_mgnumber | null
    Smallest physical redemption in milligrams.
  • data.assets[].buy_fee_percentnumber | null
  • data.assets[].sell_fee_percentnumber | null
  • data.legal_namestring | null
  • data.license_numberstring | null
  • data.custodian_namestring | null
  • data.backing_claimstring | null
  • data.android_urlstring | null
  • data.ios_urlstring | null
  • data.phonestring | null
  • data.emailstring | null
  • data.addressstring | null
  • data.founded_atstring | null
    Founding year as the platform states it, often in the Persian calendar.
  • data.last_verified_atstring | 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