API ارزدیجیتال
Englishورودثبت‌نام
API ارزدیجیتال

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

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

GEThttps://api.arzdigital.com/v1/gold-platforms
X-API-Key در هدراعتبار چطور کار می‌کند

هر ردیف همان جزئیاتی را دارد که GET /v1/gold-platforms/{slug} برمی‌گرداند.

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

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

پارامترها

  • limitintegerکوئری
    تعداد ردیف در هر صفحه.
    پیش‌فرض: 100محدوده: 1 – 1000
  • offsetintegerکوئری
    تعداد ردیف‌هایی که از ابتدا رد می‌شوند.
    پیش‌فرض: 0محدوده: 0 – …
  • sortstringکوئری
    پیش‌فرض: id_asc
    مقادیر مجاز (12)
    id_ascid_descname_ascname_descrank_ascrank_desctrust_score_asctrust_score_desccreated_at_asccreated_at_descupdated_at_ascupdated_at_desc
  • searchstringکوئری
    جست‌وجو در ابتدای اسلاگ و نام.
  • slugstringکوئری
  • statusstringکوئری
    activeinactivetemporarily_unavailableunknown
  • countrystringکوئری
  • citystringکوئری
  • asset_slugstringکوئری
    فقط پلتفرم‌هایی که این دارایی را عرضه می‌کنند.
  • deprecatedbooleanکوئری
  • license_statusstringکوئری
    verifiedprovider_claimunverified
  • capabilitystringکوئری
    online_buyonline_sellgold_walletinternal_transferphysical_redemptionphysical_deliverycustom_price_orderinstallment_purchase
  • custody_modelstringکوئری
    bank_vaultprivate_vaultprovider_inventorythird_party_custodianunknown
  • physical_redemption_statusstringکوئری
    activeinactivetemporarily_unavailableunknown
  • requires_kycbooleanکوئری

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

  • X-API-Keystringالزامی

    کلید API شما. آن را در هر درخواست در این هدر بفرستید. کلید در نشانی درخواست پذیرفته نمی‌شود.

  • Accept-Languagestring
    زبان نام‌ها و توضیحات، مانند fa-IR. اگر زبان پشتیبانی نشود، پاسخ با en-US برمی‌گردد.

پاسخ

یک صفحه از پلتفرم‌های طلا.
فیلدهای پاسخ (55)
  • statusstring
  • metaobject
    اگر count نیامده باشد، سرویس داده تعداد ردیف‌های برگشتی را گزارش نکرده است.
  • meta.countinteger
    تعداد ردیف‌هایی که هزینه این درخواست بر اساس آن حساب شده، یعنی طول data.
  • dataarray
  • 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 یا 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 یا unverified.
  • data[].custody_modelstring | null
  • data[].physical_redemption_statusstring | null
  • data[].requires_kycboolean | null
  • data[].supported_assetsarray
    اسلاگ دارایی‌هایی که پلتفرم عرضه می‌کند.
  • data[].capabilitiesarray
    همه خدماتی که پلتفرم برای دارایی‌هایش ارائه می‌دهد.
  • data[].minimum_purchase_irtnumber | null
    کمترین مبلغ خرید، به تومان.
  • data[].minimum_redemption_mgnumber | null
    کمترین مقدار تحویل فیزیکی، به میلی‌گرم.
  • 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
    خدماتی که پلتفرم برای این دارایی ارائه می‌دهد، مانند online_buy یا physical_redemption.
  • data[].assets[].minimum_purchase_irtnumber | null
    کمترین مبلغ خرید، به تومان.
  • data[].assets[].minimum_redemption_mgnumber | null
    کمترین مقدار تحویل فیزیکی، به میلی‌گرم.
  • 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
    سال تأسیس به همان شکلی که پلتفرم اعلام کرده است، اغلب به تقویم شمسی.
  • data[].last_verified_atstring | null

هدرهای پاسخ

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

خطاها

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

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