پرش به محتویات

نحوه استفاده و کلید API

آدرس پایه در تمام API های Restful صرافکس:
Base URL: https://api.sarrafex.com

حداکثر نرخ درخواست (Rate Limit) در API های Public به صرافکس برابر 500 درخواست در دقیقه به ازای هر IP است. این نرخ بر مجموعه‌ی درخواست‌ها اعمال می‌شود. هر مسیر (EndPoint) می‌تواند یک نرخ درخواست مخصوص به خود نیز داشته باشد که در این صورت این نرخ در بخش مربوط ذکر شده است. به تعدای از مسیرها می‌توان بدون احراز هویت و به شکل عمومی دسترسی داشت.

مسیرهایی که تنها با توکن احراز هویت قابل فراخوانی هستند با کلید واژه‌ی Authenticated در بخش مربوط مشخص شده اند.

توکن احراز هویت باید به صورت HTTP Header و به شکل زیر در درخواست ارسال شود:
api-key: YOUR_API_TOKEN authorization: Bearer YOUR_SECRET_KEY