پلتفرم‌های طلا

فهرست دارایی‌هایی که یک پلتفرم طلا عرضه می‌کند

GEThttps://api.arzdigital.com/v1/gold-platforms/{slug}/assets

X-API-Key در هدراعتبار چطور کار می‌کند

مصرف اعتبار: هر درخواست موفق به ازای هر ۱۰۰ ردیف که برمی‌گرداند ۱ اعتبار مصرف می‌کند و عدد به بالا گرد می‌شود. مثلاً ۲۵۰ ردیف برابر ۳ اعتبار است.

پاسخ خالی و هر نوع خطا هزینه‌ای ندارد.

GET/v1/gold-platforms/igolden/assets

curl -sS "https://api.arzdigital.com/v1/gold-platforms/igolden/assets" \
  -H "X-API-Key: YOUR_API_KEY"

نمونه پاسخ200

{
  "status": "success",
  "data": [
    {
      "slug": "gold-gerami-18",
      "symbol": "GOLD18",
      "name": "18 Karat Gram Gold",
      "fa_name": "طلای ۱۸ عیار",
      "display_name": "18 Karat Gram Gold",
      "type": "commodity",
      "logo_url": "https://cdn.arz.digital/cr-odin/img/assets/gold-gerami-18/64x64.png",
      "capabilities": [
        "online_buy",
        "online_sell",
        "gold_wallet",
        "internal_transfer",
        "physical_redemption"
      ],
      "minimum_purchase_irt": null,
      "minimum_redemption_mg": 10000,
      "buy_fee_percent": 1,
      "sell_fee_percent": 1
    },
    {
      "slug": "silver-ounce",
      "symbol": "XAG",
      "name": "Silver",
      "fa_name": "انس نقره",
      "display_name": "Silver",
      "type": "commodity",
      "logo_url": "https://cdn.arz.digital/cr-odin/img/assets/silver-ounce/64x64.png",
      "capabilities": [
        "online_buy",
        "online_sell",
        "gold_wallet",
        "internal_transfer",
        "physical_redemption"
      ],
      "minimum_purchase_irt": null,
      "minimum_redemption_mg": 10000,
      "buy_fee_percent": 1,
      "sell_fee_percent": 1
    }
  ]
}

این کدها را از سرور خود اجرا کنید. API هدر CORS نمی‌فرستد، پس مرورگر جلوی درخواست را می‌گیرد.

پارامترها

slugstringمسیرالزامی
اسلاگ پلتفرم طلا، مانند igolden.
نمونه: igolden

هدرهای درخواست

X-API-Keystringالزامی
کلید API شما. آن را در هر درخواست در این هدر بفرستید. کلید در نشانی درخواست پذیرفته نمی‌شود.
Accept-Languagestring
زبان نام‌ها و توضیحات، مانند fa-IR. اگر زبان پشتیبانی نشود، پاسخ با en-US برمی‌گردد.

پاسخ

دارایی‌های پلتفرم، همراه با شرایط عرضه هر کدام.

فیلدهای پاسخ (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
خدماتی که پلتفرم برای این دارایی ارائه می‌دهد، مانند online_buy یا physical_redemption.
data[].minimum_purchase_irtnumber | null
کمترین مبلغ خرید، به تومان.
data[].minimum_redemption_mgnumber | null
کمترین مقدار تحویل فیزیکی، به میلی‌گرم.
data[].buy_fee_percentnumber | null
data[].sell_fee_percentnumber | null

هدرهای پاسخ

X-Credits-Charged
اعتباری که این درخواست مصرف کرد. برای هر پاسخی غیر از ۲۰۰، مقدارش 0 است.
X-Credits-Remaining
موجودی حساب پس از این درخواست، بدون احتساب اعتباری که درخواست‌های هنوز در حال اجرا کنار گذاشته‌اند. فقط وقتی منفی است که حساب پس از یک اصلاح دستی بدهکار باشد.
X-RateLimit-Limit
تعداد درخواست مجاز این کلید در هر دقیقه.
X-RateLimit-Remaining
تعداد درخواستی که در بازه فعلی باقی مانده است.
X-RateLimit-Reset
زمانی که دوباره جا برای درخواست باز می‌شود، به ثانیه یونیکس.

خطاها

bad_requesterror_code 1001
یکی از پارامترها جا افتاده، قالبش درست نیست یا خارج از محدوده است.

خطاها هیچ‌وقت هزینه ندارند. خطاها