مرجع API قیمت

مرجع کامل اندپوینت‌های API قیمت. قیمت توکن‌ها، ارزها، نرخ تبدیل ارزها و پیش‌فاکتور فیات را دریافت کنید.

آدرس پایه

https://api.orcarail.com/api/v1

قیمت توکن

دریافت قیمت توکن

آخرین قیمت دلاری یک توکن را با شناسه آن بگیرید.

GET /price/token/:tokenId

پارامترهای مسیر

پارامتر	نوع	الزامی	توضیح
tokenId	string	بله	شناسه توکن (UUID)

پاسخ

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "tokenId": "550e8400-e29b-41d4-a716-446655440001",
  "priceUsd": "2500.00",
  "source": "coingecko",
  "createdAt": "2024-01-01T00:00:00.000Z"
}

اگر قیمتی برای توکن موجود نباشد null برمی‌گرداند.

فیلدهای پاسخ

فیلد	نوع	توضیح
id	string	شناسه رکورد قیمت (UUID)
tokenId	string	شناسه توکن (UUID)
priceUsd	string	قیمت به دلار
source	string	منبع قیمت (مثلاً coingecko، manual)
createdAt	string	زمان به قالب ISO 8601

ارزها

فهرست ارزها

فهرست ارزهای فیات/نمایشی پشتیبانی‌شده.

GET /price/currencies

پارامترهای کوئری

پارامتر	نوع	الزامی	توضیح
active	string	خیر	برای برگرداندن فقط ارزهای فعال آن را true کنید

پاسخ

[
  {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "code": "USD",
    "name": "US Dollar",
    "symbol": "$",
    "decimals": 2,
    "isActive": true,
    "createdAt": "2024-01-01T00:00:00.000Z",
    "updatedAt": "2024-01-01T00:00:00.000Z"
  }
]

نرخ تبدیل ارز

دریافت نرخ تبدیل

آخرین نرخ تبدیل بین دو ارز (پایه و مقابل) را بگیرید.

GET /price/currency-rate/:baseId/:quoteId

پارامترهای مسیر

پارامتر	نوع	الزامی	توضیح
baseId	string	بله	شناسه ارز پایه (UUID)
quoteId	string	بله	شناسه ارز مقابل (UUID)

پاسخ

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "baseCurrencyId": "550e8400-e29b-41d4-a716-446655440001",
  "quoteCurrencyId": "550e8400-e29b-41d4-a716-446655440002",
  "rate": "590000.00",
  "source": "manual",
  "createdAt": "2024-01-01T00:00:00.000Z"
}

اگر نرخی برای این جفت موجود نباشد null برمی‌گرداند.

فیلدهای پاسخ

فیلد	نوع	توضیح
id	string	شناسه رکورد نرخ (UUID)
baseCurrencyId	string	شناسه ارز پایه (UUID)
quoteCurrencyId	string	شناسه ارز مقابل (UUID)
rate	string	نرخ تبدیل (۱ واحد پایه = rate واحد مقابل)
source	string	منبع نرخ (مثلاً manual)
createdAt	string	زمان به قالب ISO 8601

پیش‌فاکتور فیات

دریافت پیش‌فاکتور فیات

پیش‌فاکتور تبدیل فیات به USD/USDC بگیرید. به‌طور اختیاری، مبلغ معادل را بر حسب یک توکن مشخص هم بگیرید.

GET /price/fiat-quote

پارامترهای کوئری

پارامتر	نوع	الزامی	توضیح
amount	string	بله	مبلغ به ارز مبدأ (مثلاً 100000)
currency	string	بله	کد ارز مبدأ (مثلاً irr، usd)
tokenId	string	خیر	شناسه توکن (UUID) برای گرفتن مبلغ بر حسب آن توکن

پاسخ

{
  "amountUsd": "2.38",
  "amountUsdc": "2.38",
  "sourceAmount": "100000",
  "sourceCurrency": "irr",
  "currencyRateId": "550e8400-e29b-41d4-a716-446655440000",
  "tokenAmount": "0.00052",
  "tokenSymbol": "ETH"
}

اگر tokenId ارسال نشود، tokenAmount و tokenSymbol حذف می‌شوند. اگر ارز مبدأ USD باشد، currencyRateId ممکن است null باشد.

فیلدهای پاسخ

فیلد	نوع	توضیح
amountUsd	string	مبلغ به دلار
amountUsdc	string	مبلغ به USDC (برای استیبل‌کوین برابر با دلار)
sourceAmount	string	مبلغ اصلی به ارز مبدأ
sourceCurrency	string	کد ارز مبدأ
currencyRateId	string | null	شناسه نرخ استفاده‌شده در تبدیل (برای USD برابر null)
tokenAmount	string	اختیاری. مبلغ بر حسب توکن انتخابی (اگر tokenId داده شود)
tokenSymbol	string	اختیاری. نماد توکن انتخابی (اگر tokenId داده شود)

کدهای وضعیت

کد وضعیت	توضیح
200	موفق
404	یافت نشد (مثلاً قیمت یا نرخی برای این شناسه‌ها وجود ندارد)
500	خطای داخلی سرور

همچنین ببینید

• پرداخت‌ها — شبکه‌ها و توکن‌ها (برای شناسه توکن‌ها)
• داشبورد — موجودی‌ها و حجم‌ها
• مرجع API SDK نود — orcarail.rates.getFiatQuote و getCurrencies
• دمو — استفاده از انتخابگر ارز و پیش‌فاکتور فیات