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

رتبه‌بندی

فهرست N دارایی برتر بر اساس رتبه

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

ابتدا n دارایی با بالاترین رتبه انتخاب می‌شوند و فیلتر، مرتب‌سازی و صفحه‌بندی روی همان‌ها انجام می‌شود.

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

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

پارامترها

  • nintegerکوئری
    تعداد دارایی‌های رتبه‌بندی‌شده.
    پیش‌فرض: 100
    50100200500
  • limitintegerکوئری
    تعداد ردیف در هر صفحه، حداکثر برابر n. اگر n برابر ۵۰ باشد پیش‌فرض ۵۰ است و در غیر این صورت ۱۰۰.
    محدوده: 1 – 500
  • offsetintegerکوئری
    تعداد ردیف‌هایی که از ابتدا رد می‌شوند.
    پیش‌فرض: 0محدوده: 0 – …
  • sortstringکوئری
    پیش‌فرض: rank_asc
    مقادیر مجاز (41)
    id_ascid_descname_ascname_descrank_ascrank_desccreated_at_asccreated_at_descupdated_at_ascupdated_at_descdeprecated_at_ascdeprecated_at_descrelevanceprice_ascprice_descprice_change_1h_ascprice_change_1h_descprice_change_24h_ascprice_change_24h_descprice_change_7d_ascprice_change_7d_descprice_change_30d_ascprice_change_30d_descprice_change_3m_ascprice_change_3m_descprice_change_1y_ascprice_change_1y_descprice_change_ytd_ascprice_change_ytd_descprice_change_all_ascprice_change_all_descmarket_cap_ascmarket_cap_descmarket_cap_change_24h_ascmarket_cap_change_24h_descvolume_ascvolume_descvolume_change_24h_ascvolume_change_24h_descdominance_ascdominance_desc
  • slugstringکوئری
  • symbolstringکوئری
  • namestringکوئری
  • typestringکوئری
    نوع دارایی، یا all برای همه.
    پیش‌فرض: coin
    coinfiatindexcommodityall
  • verifiedbooleanکوئری
  • deprecatedbooleanکوئری
  • tagstringکوئری
    اسلاگ برچسب.

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

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

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

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

پاسخ

یک صفحه از دارایی‌های برتر. مقدار meta.count حداکثر برابر n است.
فیلدهای پاسخ (67)
  • statusstring
  • metaobject
    اگر count نیامده باشد، سرویس داده تعداد ردیف‌های برگشتی را گزارش نکرده است.
  • meta.countinteger
    تعداد ردیف‌هایی که هزینه این درخواست بر اساس آن حساب شده، یعنی طول data.
  • dataarray
  • data[].slugstring
  • data[].symbolstring
  • data[].namestring
  • data[].signstring | null
  • data[].fa_symbolstring | null
  • data[].display_namestring | null
    نام به زبان درخواستی.
  • data[].descriptionstring | null
    فقط در پاسخ جزئیات می‌آید.
  • data[].typestring
  • data[].colorstring | null
  • data[].rankinteger | null
  • data[].verifiedboolean
  • data[].deprecatedboolean
  • data[].logo_urlstring | null
  • data[].urlsobject | null
    فهرست لینک‌ها به تفکیک نوع، مانند website و explorer.
  • data[].date_addedstring | null
  • data[].date_launchedstring | null
  • data[].max_supplynumber | null
  • data[].infinite_supplyboolean
  • data[].unitstring | null
  • data[].is_stableboolean
  • data[].metricsobject
    آخرین آمار بازار. price به دلار و price_irt به تومان است.
  • data[].metrics.pricenumber | null
  • data[].metrics.price_irtnumber | null
  • data[].metrics.price_change_percent_1hnumber | null
  • data[].metrics.price_change_percent_24hnumber | null
  • data[].metrics.price_change_percent_7dnumber | null
  • data[].metrics.price_change_percent_30dnumber | null
  • data[].metrics.price_change_percent_3mnumber | null
  • data[].metrics.price_change_percent_1ynumber | null
  • data[].metrics.price_change_percent_ytdnumber | null
  • data[].metrics.price_change_percent_allnumber | null
  • data[].metrics.price_change_percent_irt_1hnumber | null
  • data[].metrics.price_change_percent_irt_24hnumber | null
  • data[].metrics.price_change_percent_irt_7dnumber | null
  • data[].metrics.price_change_percent_irt_30dnumber | null
  • data[].metrics.price_change_percent_irt_3mnumber | null
  • data[].metrics.price_change_percent_irt_1ynumber | null
  • data[].metrics.price_change_percent_irt_ytdnumber | null
  • data[].metrics.price_change_percent_irt_allnumber | null
  • data[].metrics.circulating_supplynumber | null
  • data[].metrics.total_supplynumber | null
  • data[].metrics.market_capnumber | null
  • data[].metrics.market_cap_change_percent_24hnumber | null
  • data[].metrics.fully_diluted_market_capnumber | null
  • data[].metrics.fully_diluted_market_cap_change_percent_24hnumber | null
  • data[].metrics.volumenumber | null
  • data[].metrics.volume_change_percent_24hnumber | null
  • data[].metrics.dominancenumber | null
  • data[].metrics.last_updated_atstring | null
  • data[].tagsarray
  • data[].tags[].slugstring
  • data[].tags[].namestring
  • data[].tags[].display_namestring | null
  • data[].networksarray
    فقط در پاسخ جزئیات می‌آید.
  • data[].networks[].slugstring
  • data[].networks[].namestring
  • data[].networks[].display_namestring | null
  • data[].networks[].contract_addressstring | null
  • data[].walletsarray
    فقط در پاسخ جزئیات می‌آید.
  • data[].wallets[].slugstring
  • data[].wallets[].namestring
  • data[].wallets[].display_namestring | null
  • data[].wallets[].logo_urlstring | null

هدرهای پاسخ

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

خطاها

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

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