دارایی‌ها

دریافت تاریخچه شاخص‌های یک دارایی

GEThttps://api.arzdigital.com/v1/assets/{slug}/metrics

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

type را بفرستید، به همراه range یا هر سه پارامتر from، to و interval. در حالت from، to و interval بازه حداکثر ۱۰۰۰ نقطه را در خود جا می‌دهد.

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

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

GET/v1/assets/bitcoin/metrics

curl -sS "https://api.arzdigital.com/v1/assets/bitcoin/metrics?type=market_cap&range=7d" \
  -H "X-API-Key: YOUR_API_KEY"

نمونه پاسخ200

{
  "status": "success",
  "data": [
    {
      "time": 1793982000,
      "value": 1515627046896.06
    },
    {
      "time": 1793982300,
      "value": 1521337024131.88
    },
    {
      "time": 1793982600,
      "value": 1521486005547.19
    },
    {
      "time": 1793982900,
      "value": 1524507955857.99
    }
  ]
}

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

پارامترها

slugstringمسیرالزامی
اسلاگ دارایی، مانند bitcoin.
نمونه: bitcoin
typestringکوئریالزامی
شاخص موردنظر. volume_market_cap_ratio به صورت درصد برمی‌گردد.
circulating_supplydominancevolumemarket_capvolume_market_cap_ratio
rangestringکوئری
بازه‌ای که به همین لحظه ختم می‌شود. نمی‌توان آن را همراه با from، to یا interval فرستاد.
1d7d1m3m6m1yall
fromintegerکوئری
ابتدای بازه، به ثانیه یونیکس. به to و interval هم نیاز دارد.
tointegerکوئری
انتهای بازه، به ثانیه یونیکس. به from و interval هم نیاز دارد.
intervalstringکوئری
فاصله نقاط. به from و to هم نیاز دارد.
مقادیر مجاز (11)
5m30m2h6h12h1d2d3d7d30d60d

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

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

پاسخ

نقاط شاخص.

فیلدهای پاسخ (4)

statusstring
dataarray
data[].timeinteger
ثانیه یونیکس.
data[].valuenumber

هدرهای پاسخ

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

خطاها

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

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