برچسب‌ها

فهرست برچسب‌های دارایی

GEThttps://api.arzdigital.com/v1/tags

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

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

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

GET/v1/tags

curl -sS "https://api.arzdigital.com/v1/tags?limit=10" \
  -H "X-API-Key: YOUR_API_KEY"

نمونه پاسخ200

{
  "status": "success",
  "meta": {
    "count": 2
  },
  "data": [
    {
      "slug": "mineable",
      "name": "Mineable",
      "display_name": "Mineable",
      "type": null
    },
    {
      "slug": "sha-256",
      "name": "SHA-256",
      "display_name": "SHA-256",
      "type": {
        "slug": "consensus",
        "name": "Consensus",
        "display_name": "Consensus"
      }
    }
  ]
}

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

پارامترها

limitintegerکوئری
تعداد ردیف در هر صفحه.
پیش‌فرض: 100محدوده: 1 – 1000
offsetintegerکوئری
تعداد ردیف‌هایی که از ابتدا رد می‌شوند.
پیش‌فرض: 0محدوده: 0 – …
sortstringکوئری
پیش‌فرض: id_asc
relevanceid_ascid_desccreated_at_asccreated_at_descupdated_at_ascupdated_at_desc
searchstringکوئری
slugstringکوئری
namestringکوئری
typestringکوئری
اسلاگ نوع برچسب.

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

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

پاسخ

یک صفحه از برچسب‌ها.

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

statusstring
metaobject
اگر count نیامده باشد، سرویس داده تعداد ردیف‌های برگشتی را گزارش نکرده است.
meta.countinteger
تعداد ردیف‌هایی که هزینه این درخواست بر اساس آن حساب شده، یعنی طول data.
dataarray
data[].slugstring
data[].namestring
data[].display_namestring | null
data[].typeobject | null
data[].type.slugstring
data[].type.namestring
data[].type.display_namestring | null

هدرهای پاسخ

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

خطاها

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

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