إنتقل إلى المحتوى الرئيسي

مرجع API الأسعار

مرجع كامل لنقاط نهاية API الأسعار. احصل على أسعار الرموز والعملات وأسعار صرف العملات وعروض أسعار العملات الورقية.

الرابط الأساسي​

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

سعر الرمز​

الحصول على سعر رمز​

احصل على أحدث سعر بالدولار لرمز عبر معرّفه.

GET /price/token/:tokenId

معاملات المسار​

المعاملالنوعمطلوبالوصف
tokenIdstringنعممعرّف الرمز (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 إن لم يتوفر سعر للرمز.

حقول الاستجابة​

الحقلالنوعالوصف
idstringمعرّف سجل السعر (UUID)
tokenIdstringمعرّف الرمز (UUID)
priceUsdstringالسعر بالدولار
sourcestringمصدر السعر (مثل coingecko وmanual)
createdAtstringطابع زمني ISO 8601

العملات​

سرد العملات​

اسرد العملات الورقية/عملات العرض المدعومة.

GET /price/currencies

معاملات الاستعلام​

المعاملالنوعمطلوبالوصف
activestringلااضبطه على 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

معاملات المسار​

المعاملالنوعمطلوبالوصف
baseIdstringنعممعرّف العملة الأساس (UUID)
quoteIdstringنعممعرّف العملة المقابلة (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 إن لم يتوفر سعر صرف للزوج.

حقول الاستجابة​

الحقلالنوعالوصف
idstringمعرّف سجل السعر (UUID)
baseCurrencyIdstringمعرّف العملة الأساس (UUID)
quoteCurrencyIdstringمعرّف العملة المقابلة (UUID)
ratestringسعر الصرف (1 أساس = rate مقابل)
sourcestringمصدر السعر (مثل manual)
createdAtstringطابع زمني ISO 8601

عرض سعر بالعملة الورقية​

الحصول على عرض سعر بالعملة الورقية​

احصل على عرض سعر من العملة الورقية إلى USD/USDC. واختياريًا احصل على المبلغ المكافئ برمز محدد.

GET /price/fiat-quote

معاملات الاستعلام​

المعاملالنوعمطلوبالوصف
amountstringنعمالمبلغ بعملة المصدر (مثل 100000)
currencystringنعمرمز عملة المصدر (مثل irr وusd)
tokenIdstringلامعرّف الرمز (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.

حقول الاستجابة​

الحقلالنوعالوصف
amountUsdstringالمبلغ بالدولار
amountUsdcstringالمبلغ بـ USDC (مساوٍ للدولار في العملة المستقرة)
sourceAmountstringالمبلغ الأصلي بعملة المصدر
sourceCurrencystringرمز عملة المصدر
currencyRateIdstring | nullمعرّف سعر الصرف المستخدم في التحويل (null عند USD)
tokenAmountstringاختياري. المبلغ بالرمز المختار (عند تقديم tokenId)
tokenSymbolstringاختياري. رمز الرمز المختار (عند تقديم tokenId)

رموز الحالة​

رمز الحالةالوصف
200نجاح
404غير موجود (مثلًا لا سعر أو سعر صرف للمعرّفات المحددة)
500خطأ داخلي في الخادم

انظر أيضًا​