در این راهنما مجموعه ای از سرویس های مورد استفاده در برنامه های متصل به بازارهای معاملاتی ارزپایا مورد استفاده قرار می گیرد، در اختیار شما قرار میگیرد. در هر قسمت لیستی از سرویس ها قرار داده شده که عملیات مشابه با هم را انجام می دهند. در بخش آخر (عمومی) می توانید پارامترهای اساسی مورد نیاز در درخواست ها مانند کد بازارها، کد ارز ها، نوع درخواست ها و... مشاهده نمایید. در تمامی درخواست هایی غیر از سرویس عمومی که نیاز به اضافه کردن توکن احراز هویت می باشد با ورود به سایت ارزپایا و درافت توکن ار منو مدیریت توکن ها، میتوانید توکن مختص به خود را دریافت نموده و استفاده نمائید.
\nلازه به ذکر است توکن دریافتی از سایت ارزپایا، توکن خصوصی و مختص به هر کاربر می باشد. لذا در حفط و نگهداری توکن خود نهایت دقت لازم را داشته باشد. همچنین در صورت افشا توکن هر کاربر مسئولیت حساب کاربری برعهده خود کاربر می باشد. همچنین درصورتی که جهت هر توکن مشکل ایجاد گردد، توسط کاربر امکان حذف و عدم استفاده از توکن در منوی مربوطه امکانپذیر می باشد.
\nدر کالکشن نمونه جهت سهولت کار با درخواست ها توکن نمونه در تنظیمات کالکشن گنجانده شده که تمامی درخواست های نمونه از همان استفاده می کنند و تغییر آن منجر به تغییر توکن مورد استفاده در همه سرویس ها می گردد.
\nبنابراین در هنگام استفاده در برنامه اصلی می بایست توکن مورد استفاده را به این صورت درخواست قرار دهید:
\nHeader
\nبا توجه به اینکه در به ازای هر سرویس محدودیت در نظر گرفته شده است لذا در جدول زیر لیست نرخ محدودیت هر سرویس به تفکیک مشخص گردیده است.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"19992462","collectionId":"12886c8a-61ca-4efa-b004-ef054e9554e0","publishedId":"UyxqCiuN","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2022-05-24T07:04:23.000Z"},"item":[{"name":"General","item":[{"name":"Fee","id":"3402196f-c7a1-4d43-87dc-9c0b7f6f2242","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"https://api.arzpaya.com/general/fee","description":"این سرویس، لیست کارمزد شبکه برای ارزهای مختلف و همچنین مقدار محدودیت برداشت را ارائه می دهد
\n","urlObject":{"path":["general","fee"],"host":["https://api.arzpaya.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"3402196f-c7a1-4d43-87dc-9c0b7f6f2242"},{"name":"CurrencyType","id":"beeb79f3-900b-42d5-a6f2-af7e271de536","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"https://api.arzpaya.com/general/CurrencyType","description":"به وسیله این سرویس می توانید لیست ارزهای موجود را دریافت نمایید.
\n","urlObject":{"path":["general","CurrencyType"],"host":["https://api.arzpaya.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"beeb79f3-900b-42d5-a6f2-af7e271de536"},{"name":"Info","id":"03603552-159e-4b67-8180-c4d163b83df4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"https://api.arzpaya.com/general/Info","description":"به وسیله این سرویس می توانید اطلاعات تماس، آدرس و ساعات کاری شرکت را دریافت نمایید
\n","urlObject":{"path":["general","Info"],"host":["https://api.arzpaya.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"03603552-159e-4b67-8180-c4d163b83df4"},{"name":"OrderStatus","id":"829b298a-80db-435a-b132-4b2c2952f109","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"https://api.arzpaya.com/general/OrderStatus","description":"به وسیله این سرویس می توانید لیستی از انواع حالت هایی که ممکن از برای یک سفارش اتفاق بیافتد (فعال، انجام شده و...) را دریافت نمایید
\nتوجه: وضعیت انجام شده - کنسل شده، در شرایطی بوجود می آید که کاربر درخواستی را ثبت کرده و مقداری از درخواست خریداری شده یا به فروش رسیده است و مابقی درخواست توسط کاربر کنسل شده است.
\n","urlObject":{"path":["general","OrderStatus"],"host":["https://api.arzpaya.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"829b298a-80db-435a-b132-4b2c2952f109"},{"name":"OrderType","id":"f2d510a2-bee1-4e3c-861c-2718ef2bb382","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"https://api.arzpaya.com/general/OrderType","description":"به وسیله این سرویس می توانید لیست انواع سفارش (خرید/ فروش) را دریافت نمایید
\n","urlObject":{"path":["general","OrderType"],"host":["https://api.arzpaya.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"f2d510a2-bee1-4e3c-861c-2718ef2bb382"},{"name":"TransactionStatus","id":"cf2dc16a-d718-41b0-b762-145d2a324118","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"https://api.arzpaya.com/general/TransactionStatus","description":"به وسیله این سرویس می توانید لیستی از انواع حالت هایی که برای یک تراکنش اتفاق می افتد (موفق، ناموفق، پیش نویس و...) را دریافت نمایید.
\n","urlObject":{"path":["general","TransactionStatus"],"host":["https://api.arzpaya.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"cf2dc16a-d718-41b0-b762-145d2a324118"},{"name":"TransactionType","id":"78a14eea-3f56-4ba2-a830-5ba1983dfb8d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"https://api.arzpaya.com/general/TransactionType","description":"به وسیله این سرویس می توانید به لیست انواع تراکنش ها (واریز/برداشت) را دریافت نمایید.
\n","urlObject":{"path":["general","TransactionType"],"host":["https://api.arzpaya.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"78a14eea-3f56-4ba2-a830-5ba1983dfb8d"},{"name":"ExchangeTypeIcon","id":"106918d3-d69d-431b-9c1b-aba63a9577f3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"https://api.arzpaya.com/general/ExchangeTypeIcon/1","description":"به وسیله این سرویس می توانید آیکن ارز مورد نظر خود را دریافت نمایید. درخواست ارسالی می بایست شامل کد ارز باشد که این کد را می توانید از سرویس های دیگر دریافت نمایید
\n","urlObject":{"path":["general","ExchangeTypeIcon","1"],"host":["https://api.arzpaya.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"106918d3-d69d-431b-9c1b-aba63a9577f3"},{"name":"ExchangeType","id":"7bfbb772-d7c4-4ef9-a223-b1884f8d9184","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"https://api.arzpaya.com/general/ExchangeType","description":"به وسیله این سرویس می توانید لیست بازارهای معاملات ارزپایا را همراه با مشخصات آن ها دریافت نمایید
\n","urlObject":{"path":["general","ExchangeType"],"host":["https://api.arzpaya.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"7bfbb772-d7c4-4ef9-a223-b1884f8d9184"},{"name":"CurrencyTypeIcon","id":"fea9e397-340f-4f6f-bf16-5bd5b73cbc6e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"https://api.arzpaya.com/general/CurrencyTypeIcon/5","description":"به وسیله این سرویس می توانید آیکن مورد استفاده برای هر رمز ارز را دریافت نمایید.
\n","urlObject":{"path":["general","CurrencyTypeIcon","5"],"host":["https://api.arzpaya.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"fea9e397-340f-4f6f-bf16-5bd5b73cbc6e"},{"name":"TransactionInfo","id":"fa76e62a-baf2-4c23-aafb-3fd9836b2f7e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"https://api.arzpaya.com/general/TransactionInfo","description":"به وسیله این سرویس می توانید اطلاعات صفحه اصلی وبسایت شامل تعداد کاربران جدید، حجم و تعداد تراکنش های 24 ساعت گذشته را دریافت نمایید.
\n","urlObject":{"path":["general","TransactionInfo"],"host":["https://api.arzpaya.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"fa76e62a-baf2-4c23-aafb-3fd9836b2f7e"},{"name":"NetworkType","id":"ee7a4dd3-fa43-4734-94f4-7b411c140c6e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"https://api.arzpaya.com/general/NetworkType","urlObject":{"path":["general","NetworkType"],"host":["https://api.arzpaya.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"ee7a4dd3-fa43-4734-94f4-7b411c140c6e"},{"name":"BestPrice","id":"527b7793-ace4-486a-8b84-f652d0ea1eba","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"ExchangeType\": 6\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.arzpaya.com/general/bestprice","description":"این سرویس با دریافت کد بازار معاملات، بهترین قیمت پیشنهادی برای ثبت سفارش را در اختیار شما قرار می دهد.
\n","urlObject":{"path":["general","bestprice"],"host":["https://api.arzpaya.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"527b7793-ace4-486a-8b84-f652d0ea1eba"},{"name":"OrderBook","id":"a6caa961-b7b5-4acf-8c66-75004c15c91f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"ExchangeType\": 1,\r\n \"OrderType\": 2,\r\n \"Count\": 100\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.arzpaya.com/general/orderbook","description":"این سرویس با دریافت کد بازار معاملاتی، نوع درخواست (خرید یا فروش) و تعداد سفارش مورد نظر در گزارش، لیستی از سفارشات کاربر در بازار مورد نظر را ارائه می دهد.
\n","urlObject":{"path":["general","orderbook"],"host":["https://api.arzpaya.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"a6caa961-b7b5-4acf-8c66-75004c15c91f"},{"name":"ExchangeInfo","id":"54ddd56c-51c6-4daa-84d5-366ee580d15f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"https://api.arzpaya.com/public/ExchangeInfo","description":"این سرویس لیست بازارها و اطلاعات قیمت ارز در بازارهای معاملاتی را ارائه می دهد
\n","urlObject":{"path":["public","ExchangeInfo"],"host":["https://api.arzpaya.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"54ddd56c-51c6-4daa-84d5-366ee580d15f"},{"name":"Price","id":"aa3ebbe6-562d-43e9-a87a-06fd5240f8aa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"SourceType\": 1,\r\n \"CurrencyType\": 2,\r\n \"BaseCurrencyType\": 1\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.arzpaya.com/public/Price","description":"این سرویس قیمت هر ارز در بازار مورد نظر را ارائه می دهد
\nپارامتر های ورودی:
\n","urlObject":{"path":["public","Price"],"host":["https://api.arzpaya.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"aa3ebbe6-562d-43e9-a87a-06fd5240f8aa"}],"id":"a8963484-37a8-4e5b-b8e7-272140f9ee27","_postman_id":"a8963484-37a8-4e5b-b8e7-272140f9ee27","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"این سرویس اطلاعات موجودی کیف پول کاربر را ارائه می دهد.
\nپارامتر های ورودی:
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"این سرویس اطلاعات موجودی تمام کیف پول کاربر را ارائه می دهد.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"کلیه اطلاعات لازم درباره دارایی کاربر از انواع ارزهای مختلف در این قسمت ارائه می شود.
\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"8381b494-fbe3-4d9b-83c4-969abdb4649c"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"21b361a2-5a0e-4f5d-bc97-0987763f0408"}}],"_postman_id":"77294688-3be7-4b39-83ee-cdc214606203","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"این سرویس گزارش گردش های مالی کاربر را ارائه می دهد که شاملی واریز و برداشت ها می باشد.
\nپارامتر های ورودی:
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"این سرویس گزارشی از تمامی سفارشات کاربر را ارائه می دهد که شامل سفارشات خرید و فروش در تمامی حالت های موفق، ناموفق و در حال پردازش هستند. شما می توانید بسته به نیاز خود با استفاده از فیلترها، گزارشات متفاوتی را از این سرویس تهیه نمایید.
\nپارامتر های ورودی:
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"در این بخش، مجموعه ای از سرویس های دریافت گزارشات مختلف ارائه می شود. درخواست های ارسالی برای تمامی سرویس ها میبایست حاوی تنظیماتی باشد که پاسخ ارائه شده توسط سرویس ار آن ها پیروی می کند.
\nPagination:
\nنکته: فیلتر ها شامل آرایه از از کلید و مقدار هستند که برای هر درخواست ممکن است مقادیر کلید متفاوتی داشته باشد و یا حتی خالی باشد.
\n","_postman_id":"dc9b82c6-b595-4bf2-abbc-82b7d84a40f6","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"این سرویس جهت نمایش آدرس واریز با وارد کردن نوع ارز مورد استفاده قرار میگیرد.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"به وسیله این سرویس می توانید لیست سفارش های کاربر را در بازار مورد نظر دریافت نمایید
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"به وسیله این سرویس می توانید یک سفارش خرید و فروش جدید ثبت نمایید
\nبعد از ثبت سفارش، شناسه درخواست جهت پیگیری و بررسی وضعیت درخواست برگشت داده می شود
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"به وسیله این سرویس می توانید یک سفارش خرید یا فروش را در بازار مورد نظر لغو کنید.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"این سرویس با دریافت نوع درخواست (خرید یا فروش) و تعداد سفارش مورد نظر در گزارش، لیستی از سفارشات کاربر در بازار مورد نظر را به ازای هر بازار معاملاتی ارائه می دهد. و حد اکثر تعداد سفارشات قابل نمایش 5 سفارش آخر به ازای هر بازار معاملاتی می باشد.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"این سرویس با دریافت شناسه درخواست که در پارامتر خروجی سرویس ثبت درخواست برگشت داده می شود، میتوانید وضعیت هر درخواست را پیگیری نمود
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"