شروع به کار

baseURL:
https://api.nipoto.com/v1/
                

مسیر پایه برای فراخوانی تمامی مسیرها(اند پوینت) این مستند ، آدرس زیر می باشد.

https://api.nipoto.com/v1/

تعدای از مسیرها بدون احراز هویت و به شکل عمومی در دسترس هستند. سایر مسیر های خصوصی با توکن مختص به خود که از پنل کاربری قابل ایجاد هست در دسترس خواهند بود . دقت نمایید که در هنگام ایجاد توکن در پنل نیپوتو دسترسی لازم به بخش مربوطه را به آن توکن بدهید.

پینگ-پونگ

request:
const res = await axios.get('/v1/ping')
                

برای چک کردن اتصال سرویس api از مسیر زیر استفاده میشه.

GET /v1/ping

تعداد درخواست قابل قبول به این اندپوینت برابر است با :

60 req/min

response:

res.data = 'pong'
                

گرفتن kline

request:

const url = '/v1/market/kline'
const res = await axios.get(`${url}?market=BTC_USDT&timeFrame=1h`)
                

در حال حاضر فقط کندل های 1h, 4h, 1d رو برمیگردن. اگر تعداد تعریف نشه یک دونه رکورد برمیگرده که اخرین کندل همون تایم فریمه . در صورتی که تعداد بیشتر از ۱۰۰ تا باشه، ۱۰۰ تا رکورد برمیگرده. تعداد درخواست قابل قبول به این اندپوینت برابر است با :

60 req/min

GET /v1/market/kline

response:

res.data =  [{
 openTimestamp: '2022-10-12T06:17:42.000Z',
 closeTimestamp: '2022-10-12T06:17:43.000Z',
 open: '0.00000000',
 close: '0.00000000',
 low: '0.00000000',
 high: '0.00000000',
 turnoverValue: '0.00000000',
 volumeAmount: '0.00000000',
 tradeCount: 0
}]
                

پارامترهای ورودی

گرفتن اطلاعات مارکت ها

request:
const res = await axios.get('/v1/market/list')
                

برای گرفتن قیمت لحظه ای، بهترین قیمت خرید و بهترین قیمت فروش تمام مارکت های نیپوتو از این اندپوینت استفاده کنین. فرمت جوابی که برمیگرده به این شکله:

[[marketName, price, bestBid, bestAsk], …]

تعداد درخواست قابل قبول به این اندپوینت برابر است با :

60 req/min

GET /v1/market/list

response:

res.data = [['BTC/USDT', 12000, 13000, 14000], …]
                

گرفتن اردربوک

request:

const method = 'GET'
const url= '/v1/market/order_book'

const res = await axios({ url, method, params: { market: 'BTC_USDT' } })

                

برای گرفتن لیست اردربوک میشه از روت زیر استفاده کرد فرمت دیتایی که برمیگرده به این شکله:

[[[amount, stepPrice], ...], [[amount, stepPrice], …]]

تعداد درخواست قابل قبول به این اندپوینت برابر است با :

60 req/min

GET /v1/market/order_book

response:

res.data = [[[0.01, 1100], …], [[0.02, 1000], …]]

                

پارامترهای ورودی

گرفتن معاملات اخیر مارکت

request:

const method = 'GET'
const url= '/v1/market/recent_trades'

const res = await axios({ url, method, params: { market: 'BTC_USDT' } })

                

برای گرفتن معاملات اخیر یک مارکت میتونین از اندپوینت زیر استفاده کنین. فرمت دیتایی که برمیگرده بدین شکله:

[[ amount, price, side, createdAt], …]

تعداد درخواست قابل قبول به این اندپوینت برابر است با :

60 req/min

GET /v1/market/recent_trades

response:

res.data = res.data=[[0.02,1000,'ask','2022-11-11T16:45:21.876Z'],[0.04,1001,'bid',   '2022-11-11T16:45:20.876Z']]

                

پارامترهای ورودی

دریافت توکن ها

request:

const url = '/v1/user/login'
const method = 'POST'

const res = await axios({
                url,
                method,
                data: { apiKey, secretKey }
            })
                

این اندپوینت refreshToken و accessToken رو برمیگردونه.از refreshToken برای گرفتن accessToken و از accessToken برای دسترسی به اندپوینت های خصوصی استفاده میشه.
مدت زمان اعتبار refreshToken هفتاد و دو ساعت و accessToken بیست و چهار ساعته اما اگه توکن اصلیتون منقضی شه accessToken و refreshToken تون هم از کار میفته.
تعداد درخواست قابل قبول به این روت برابر است با :

60 req/min

برای گرفتن accessToken و refreshToken باید به اندپوینت زیر درخواست بفرستین

POST /v1/user/login

response:

res.data = {
      accessToken: 'U2FsdGVkX19evXx2Q3/jbvkz89H***S33y938FtfBU',
      refreshToken: 'U2FsdGVkX19+LC6Hv79iij***zwSGGqIIW2VNe2toY='
    }
                

پارامترهای ورودی

دریافت accessToken

request:

const url = '/v1/user/accessToken'
const method = 'POST'

const res = await axios({
                url,
                method,
                data: { refreshToken }
            })
                

برای دسترسی به روت های پرایوت به accessToken احتیاج دارین.
مدت زمان اعتبار accessToken بیست و چهار ساعته و باید با استفاده از refreshToken اون رو به روزرسانی کنین. اما اگه توکن اصلیتون منقضی شه accessToken تون هم از کار میفته. تعداد درخواست قابل قبول به این روت برابر است با :

60 req/min

برای گرفتن accessToken باید به اندپوینتی زیر درخواست بفرستین

POST /v1/user/accessToken

response:

res.data = {
    accessToken: 'U2FsdGVkX1+fPZ***qY151OFOIMVkHXDOsub7X'
}
                

پارامترهای ورودی

دریافت موجودی حساب

request:

const url = '/v1/accounting/balance'
const method = 'GET'

const res = await axios({
                url,
                method,
                params: { currency: 'USDT' },
                headers: {  authorization: `Bearer ${accessToken}` }
            })
                

یرای گرفتن موجودی حساب میتونید از این روت استفاده کنین. در صورتی که نام ارز رو مشخص کنین فقط موجودی اون ارز برمیگرده، در غیر این صورت لیست تمام دارایی هاتون برمیگرده.
تعداد درخواست قابل قبول به این روت برابر است با :

60 req/min

GET /v1/accounting/balance

response:

res.data = {
      USDT: {
        active: 1000,
        inuse: 0,
        pending: 0
      }
    }
                

پارامترهای ورودی

تولید آدرس رمزارز

request:

const url = '/v1/accounting/wallet'
const method = 'POST'

const res = await axios({
              url,
              method,
              data: { currency: 'BTC', network: 'Bitcoin', paymentID: '1' },
              headers: { authorization: `Bearer ${accessToken}` }
            })
                

برای ایجاد کیف پول رمزارزی میتونین از این اندپوینت استفاده کنین. تعداد درخواست قابل قبول به این اندپوینت برابر است با :

60 req/min

POST /v1/accounting/wallet

response:

res.data = {
   address: '1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa',
   currency: 'BTC',
   network: 'Bitcoin',
   p2address: null,
   paymentID: '1',
   walletID: '691c9b83-f8f4-44c3-851d-1db50dafc68e'
}
                

پارامترهای ورودی

دریافت اطلاعات کیف پول

request:

const url = '/v1/accounting/wallet/:id'
const method = 'GET'

const res = await axios({
              url: url.replace(':id', '691c9b83-f8f4-44c3-851d-1db50dafc68e'),
              method,
              headers: { authorization: `Bearer ${accessToken}` }
            })
                

برای دریافت اطلاعات کیف پول رمزارزی میتونین از این اندپوینت استفاده کنین. تعداد درخواست قابل قبول به این روت برابر است با :

60 req/min

GET /v1/accounting/wallet/:id

response:

res.data = {
   address: '1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa',
   network: 'Bitcoin',
   origin: 'nipoto-api',
   p2address: null,
   type: 'bech32',
   id: '691c9b83-f8f4-44c3-851d-1db50dafc68e',
   createdAt: '2022-09-16T10:51:12.290Z'
}
                

دریافت لیست کیف پول ها

request:

const url = '/v1/accounting/wallet'
const method = 'GET'

const res = await axios({
              url,
              method,
              headers: { authorization: `Bearer ${accessToken}` }
            })
                

برای دریافت اطلاعات کیف پول رمزارزی میتونین از این اندپوینت استفاده کنین. تعداد درخواست قابل قبول به این روت برابر است با :

60 req/min

GET /v1/accounting/wallet

response:
res.data = [{
   address: '1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa',
   network: 'Bitcoin',
   origin: 'nipoto-api',
   p2address: null,
   type: 'bech32',
   id: '691c9b83-f8f4-44c3-851d-1db50dafc68e',
   createdAt: '2022-09-16T10:51:12.290Z'
},{
   address: 'rpshnaf39wBUDNEGHJKLM4PQRST7VWXYZ2bcdeCg65jkm8oFqi1tuvAxyz',
   network: 'XRP',
   origin: 'nipoto',
   p2address: 125451185,
   type: null,
   id: 'bd3dff0c-c331-4ca0-89ee-9162e4a36827',
   createdAt: '2022-09-14T09:22:18.450Z'
}]
                

پارامترهای ورودی

اطلاع رسانی واریز جدید

request:
const url = 'https://yourwebsite.com/callback/newdeposit.php'
const method = 'POST'
data: { depositID }


                

هر واریز جدیدی که به کیف پول های شما در نیپوتو انجام میشه ما یک ریکوئست POST به مسیری که در هنگام ایجاد توکن تعریف می کنید می زنیم و پارامتر depositID رو که نوعش uuid هست رو واستون POST می کنیم. سپس شما جهت دریافت اطلاعات واریزی به مسیر «گرفتن اطلاعات واریز» Get بزنید.:

گزارش واریز رو به یک لینک در سایت شما POST می کنیم.

POST https://yourwebsite.com/callback/newdeposit.php

گرفتن اطلاعات واریز

request:
const url = '/v1/accounting/deposit/:id'
const method = 'GET'

   const res = await axios({
        url: url.replace(':id', '9e0eb6c4-cf78-499b-90f2-9caac4e81c67'),
        method,
        headers: { authorization: `Bearer ${accessToken}` }
})
                

تعداد درخواست قابل قبول به این روت برابر است با :

60 req/min

برای دریافت اطلاعات یک واریز باید به اندپوینت زیر درخواست بزنین.

GET /v1/accounting/deposit/:id

response:

res.data = {
      amount: 1000,
      createdAt: '2022-10-09T06:17:42.000Z',
      currency: 'USDT',
      fee: 1,
      hash: '52b19cf51b831adc39ae95ab****a3bb8b6d0583f4ef5fa316fae4921517e79d6a74',
      humanID: '123456789',
      id,
      instrument: 'TRKofFNxXpCcYmaT4uWT7JCG6UDMJhXS2w',
      network: 'TRC20',
      origin: 'nipoto',
      status: 'done',
      transactionID: '9e0eb6c4-cf78-499b-90f2-9caac4e81c67'
    }

                

گرفتن اطلاعات تمام واریزی ها

request:
const url = '/v1/accounting/deposit'
const method = 'GET'

   const res = await axios({
        url: url.replace(':id', '9e0eb6c4-cf78-499b-90f2-9caac4e81c67'),
        method,
        headers: { authorization: `Bearer ${accessToken}` }
})
                

تعداد درخواست قابل قبول به این روت برابر است با :

60 req/min

برای دریافت اطلاعات تمام واریزی ها باید به اندپوینت زیر درخواست بزنین.

GET /v1/accounting/deposit

response:

res.data = {
      amount: 1000,
      createdAt: '2022-10-09T06:17:42.000Z',
      currency: 'USDT',
      fee: 1,
      hash: '52b19cf51b831adc39ae95ab****a3bb8b6d0583f4ef5fa316fae4921517e79d6a74',
      humanID: '123456789',
      id,
      instrument: 'TRKofFNxXpCcYmaT4uWT7JCG6UDMJhXS2w',
      network: 'TRC20',
      origin: 'nipoto',
      status: 'done',
      transactionID: '9e0eb6c4-cf78-499b-90f2-9caac4e81c67'
    }
                

پارامترهای ورودی

دریافت کارمزد برداشت

request:

const url = '/v1/accounting/withdraw/fee'
const method = 'GET'

const res = await axios({
                url,
                method,
                headers: {  authorization: `Bearer ${accessToken}` }
            })
                

تعداد درخواست قابل قبول به این روت برابر است با :

60 req/min

GET /v1/accounting/withdraw/fee

response:

res.data =  {
  ADA: [
    { fee: 0, min: 0, network: 'Cardano' },
    { fee: 0, min: 0, network: 'BEP20' }
  ],
  BNB: [
    { fee: 0, min: 0, network: 'BEP2' },
    { fee: 0, min: 0, network: 'BEP20' }
  ],
  BTC: [
    { fee: 0, min: 0, network: 'Bitcoin_Bulk' },
    { fee: 0, min: 0, network: 'Bitcoin' },
    { fee: 0, min: 0, network: 'BEP20' }
  ],... }
                

درخواست برداشت رمزارز

request:

const url = '/v1/accounting/withdraw/crypto'
const method = 'POST'

const res = await axios({
                url,
                method,
                data: {
                        address: 'TRKofFNxXpCcYmaT4uWT7JCG6UDMJhXS2w',
                        currency: 'USDT',
                        network: 'TRC20',
                        amount: 300,
                        paymentID: '1',
                        description: 'توضیحات'
                },
                headers: {  authorization: `Bearer ${accessToken}` }
            })
                

در برداشت رمزارز نکته ای ک باید در نظر داشته باشین اینه که اگه "برداشت دو مرحله‌ای" رو موقع جنریت توکن علامت زده باشین یک لینک به ایمیل شما فرستاده میشه که باید روی لینک کلیک کنین و برداشت رو تایید کنین. در این حالت وضعیتی که برمیگرده pendingه. این لینک فقط به مدت ۳۰ دقیقه معتبره. پس از گذشت ۳۰ دقیقه در صورت تایید نشدن لینک، برداشت کنسل میشه.
در صورتی که تیک برداشت دومرحله ای رو نزدین وضعیتی که برمیگرده auditing ه و تنها ۹۰ ثانیه فرصت دارین تا برداشت رو کنسل کنین. بعد از اون برداشت فرستاده میشه.
کارمزد از مقداری که میخواهید برداشت کنید کسر میشود و در نهایت amount - fee به کیف پول شما واریز میشود.
تعداد درخواست قابل قبول به این روت برابر است با :

60 req/min

برای درخواست برداشت رمزارز باید به اندپوینت زیر درخواست بزنین.

POST /v1/accounting/withdraw/crypto

response:

res.data = {
      address: 'TRKofFNxXpCcYmaT4uWT7JCG6UDMJhXS2w',
      amount: 300,
      currency: 'USDT',
      description: 'توضیحات',
      fee: 1,
      network: 'TRC20',
      paymentID: '1',
      status: 'auditing',
      tags: [],
      withdrawID: '789bb874-8af0-4bf3-ab05-11366ea3fd30'
    }
                

پارامترهای ورودی

درخواست برداشت تومان

request:

const url = '/v1/accounting/withdraw/irt'
const method = 'POST'

const res = await axios({
                url,
                method,
                data: {
                        address: '5022291061292486',
                        amount: 300,
                        paymentID: '1',
                        description: 'توضیحات'
                },
                headers: {  authorization: `Bearer ${accessToken}` }
            })
                

بردای برداشت تومان شماره شبا و شماره کارتی که میفرستین حتما باید از قبل توی پنل ثبت شده باشه و به نام صاحب اکانت باشه.
نکته ای ک باید در نظر داشته باشین اینه که اگه "برداشت دو مرحله‌ای" رو موقع جنریت توکن علامت زده باشین یک لینک به ایمیل شما فرستاده میشه که باید روی لینک کلیک کنین و برداشت رو تایید کنین. در این حالت وضعیتی که برمیگرده pendingه. این لینک فقط به مدت ۳۰ دقیقه معتبره. پس از گذشت ۳۰ دقیقه در صورت تایید نشدن لینک، برداشت کنسل میشه.
در صورتی که تیک برداشت دومرحله ای رو نزدین وضعیتی که برمیگرده auditing ه و تنها ۹۰ ثانیه فرصت دارین تا برداشت رو کنسل کنین. بعد از اون برداشت فرستاده میشه.
کارمزد از مقداری که میخواهید برداشت کنید کسر میشود و در نهایت amount - fee به حساب شما واریز میشود.
تعداد درخواست قابل قبول به این روت برابر است با :

60 req/min

برای درخواست برداشت تومان باید به اندپوینت زیر درخواست بزنین.

POST /v1/accounting/withdraw/irt

response:

res.data = {
    address: '5022291061292486',
    amount: 100000,
    currency: 'IRT',
    description: 'توضیحات',
    fee: 5000,
    network: 'bankCard',
    paymentID: '1',
    status: 'auditing',
    tags: [],
    withdrawID:  '789bb874-8af0-4bf3-ab05-11366ea3fd30'
}
                

پارامترهای ورودی

لفو برداشت

request:

const url = '/v1/accounting/withdraw/:id'
const method = 'DELETE'

const res = await axios({
                url: url.replace(':id', '789bb874-8af0-4bf3-ab05-11366ea3fd30')
                method,
                headers: {  authorization: `Bearer ${accessToken}` }
            })
                

id که فرستاده میشه همون withdrawID هست که موقع گرفتن لیست برداشت ها یا موقع فرستادن یک درخواست برداشت به سمت شما برمیگرده.
پس از آنکه وضعیت برداشت به حسابرسی(auditing) تغییر کرد، تنها ۳۰ ثانیه فرصت دارید تا برداشت را کنسل کنید.
تعداد درخواست قابل قبول به این روت برابر است با :

60 req/min

برای لفو برداشت باید به اندپوینت زیر درخواست بزنین.

DELETE /v1/accounting/withdraw/:id

response:

res.data = {
  status: 'canceled',
  withdrawID:  '789bb874-8af0-4bf3-ab05-11366ea3fd30'
}

                

لفو برداشت با paymentID

request:

const url = '/v1/accounting/withdraw'
const method = 'DELETE'

const res = await axios({
                url,
                method,
                params: { paymentID: '1' },
                headers: {  authorization: `Bearer ${accessToken}` }
            })
                

پس از آنکه وضعیت برداشت به حسابرسی(auditing) تغییر کرد، تنها ۳۰ ثانیه فرصت دارید تا برداشت را کنسل کنید.
تعداد درخواست قابل قبول به این روت برابر است با :

60 req/min

برای لفو برداشت باید به اندپوینت زیر درخواست بزنین.

DELETE /v1/accounting/withdraw

response:

res.data = {
  status: 'canceled',
  paymentID: '1'
}

                

پارامترهای ورودی

دریافت لیست برداشت ها

request:

const url = '/v1/accounting/withdraw'
const method = 'GET'

const res = await axios({
                url,
                method,
                params: {
                  currency: 'USDT',
                },
                headers: {  authorization: `Bearer ${accessToken}` }
            })
                

برای گرفتن لیست برداشت ها (یا گرفتن یک برداشت با استفاده از paymentID ) میتونین از اندپوینت زیر استفاده کنین. در صورتی که هیچ پارامتری ارسال نشه ۲۰ تا برداشت اخیر کاربر بدون توجه به ارز و شبکه برمیگرده. اگر paymentID رو بفرستین سایر پارامترهای ارسالی نادیده گرفته میشن
تعداد درخواست قابل قبول به این روت برابر است با :

60 req/min

برایدریافت لیست برداشت ها باید به اندپوینت زیر درخواست بزنین.

GET /v1/accounting/withdraw

response:

res.data = [{
    origin: 'nipoto',
    tags: ['mainAccount'],
    description: null,
    id: '789bb874-8af0-4bf3-ab05-11366ea3fd30',
    amount: 500,
    currency: 'USDT',
    address: 'address',
    network: 'TRC20',
    fee: 1,
    p2address: null,
    humanID: '1',
    createdAt: '2022-10-09T06:17:42.000Z',
    status: 'pending',
    hash: null
  },…]
                

پارامترهای ورودی

گرفتن یک برداشت با استفاده از withdrawID

request:

const url = '/v1/accounting/withdraw/:id'
const method = 'GET'

const res = await axios({
                url: url.replace(':id', '789bb874-8af0-4bf3-ab05-11366ea3fd30')
                method,
                headers: {  authorization: `Bearer ${accessToken}` }
            })
                

id که فرستاده میشه همون withdrawID هست که موقع گرفتن لیست برداشت ها یا موقع فرستادن یک درخواست برداشت به سمت شما برمیگرده.
تعداد درخواست قابل قبول به این روت برابر است با :

60 req/min

برای گرفتن اطلاعات برداشت باید به اندپوینت زیر درخواست بزنین.

GET /v1/accounting/withdraw/:id

response:

res.data =  {
    origin: 'nipoto',
    tags: ['mainAccount'],
    description: null,
    id: '789bb874-8af0-4bf3-ab05-11366ea3fd30',
    amount: 500,
    currency: 'USDT',
    address: 'address',
    network: 'TRC20',
    fee: 1,
    p2address: null,
    humanID: '1',
    createdAt: '022-10-09T06:17:42.000Z',
    status: 'auditing',
    hash: null
  }
                

اد سفارش لیمیت

request:

const url = '/v1/market/order/limit'
const method = 'POST'

const res = await axios({
               url,
                method,
                data: { market: 'BTC_USDT', side: 'bid', amount: 0.01, price: 1000, paymentID: '1' }
                headers: {  authorization: `Bearer ${accessToken}` }
            })
                

تعداد درخواست قابل قبول به این روت برابر است با :

60 req/min

برای ثبت کردن سفارش لیمیت باید از اندپوینت زیر استفاده کنین.

POST /v1/market/order/limit

response:

res.data= {
  amount: 0.01,
  market: 'BTC/USDT',
  orderID: 'acb16d06-9bfa-48b6-bcf5-298cba3ca967',
  paymentID: '1',
  price: 1000,
  side: 'bid',
  type: 'limit'
}
                

پارامترهای ورودی

اد سفارش مارکت

request:

const url = '/v1/market/order/market'
const method = 'POST'

const res = await axios({
               url,
                method,
                data: { market: 'BTC_USDT', side: 'bid', amount: 0.01, paymentID: '1' }
                headers: {  authorization: `Bearer ${accessToken}` }
            })
                

تعداد درخواست قابل قبول به این روت برابر است با :

60 req/min

برای ثبت کردن سفارش مارکت باید از اندپوینت زیر استفاده کنین.

POST /v1/market/order/market

response:

res.data= {
  amount: 0.01,
  market: 'BTC/USDT',
  orderID: 'acb16d06-9bfa-48b6-bcf5-298cba3ca967',
  paymentID: '1',
  side: 'bid',
  type: 'market'
}
                

پارامترهای ورودی

اد سفارش oco

request:

const url = '/v1/market/order/oco'
const method = 'POST'

const res = await axios({
                url,
                method,
                data: { market: 'BTC/USDT', side: 'bid', amount: 0.01, price: 1000, paymentID: '1', limit: 1000, stop: 1001 }
                headers: {  authorization: `Bearer ${accessToken}` }
            })
                

تعداد درخواست قابل قبول به این روت برابر است با :

60 req/min

برای ثبت کردن سفارش لیمیت باید از اندپوینت زیر استفاده کنین.

POST /v1/market/order/oco

response:

res.data= {
  amount: 0.01,
  market: 'BTC/USDT',
  orderID: 'acb16d06-9bfa-48b6-bcf5-298cba3ca967',
  paymentID: '1',
  price: 1000,
  stop: 1001,
  limit: 1000
  side: 'bid',
  type: 'oco'
}
                

پارامترهای ورودی

اد سفارش استاپ-لیمیت

request:

const url = '/v1/market/order/stopLimit'
const method = 'POST'

const res = await axios({
                url,
                method,
                data: { market: 'BTC/USDT', side: 'bid', amount: 0.01, price: 1000, paymentID: '1', limit: 1000, stop: 1001 }
                headers: {  authorization: `Bearer ${accessToken}` }
            })
                

تعداد درخواست قابل قبول به این روت برابر است با :

60 req/min

برای ثبت کردن سفارش استاپ-لیمیت باید از اندپوینت زیر استفاده کنین.

POST /v1/market/order/stopLimit

response:

res.data= {
  amount: 0.01,
  market: 'BTC/USDT',
  orderID: 'acb16d06-9bfa-48b6-bcf5-298cba3ca967',
  paymentID: '1',
  stop: 1001,
  limit: 1000
  side: 'bid',
  type: 'oco'
}
                

پارامترهای ورودی

کنسل کردن سفارش

request:

const url = '/v1/market/order/:id'
const method = 'DELETE'

const res = await axios({
                url: url.replace(':id', '289bb874-8af0-4bf3-ab05-11366ea3fd30')
                method,
                headers: {  authorization: `Bearer ${accessToken}` }
            })
                

id که فرستاده میشه همون orderID هست که موقع گرفتن لیست سفارشات یا موقع ثبت سفارش به سمت شما برمیگرده.
تعداد درخواست قابل قبول به این روت برابر است با :

60 req/min

برای لفو سفارش باید به اندپوینت زیر درخواست بزنین.

DELETE /v1/market/order/:id

response:

res.data = {
    type: 'limit',
    remainingAmount: 0.004,
    market: 'BTC/USDT',
    orderID: id,
    price: 1000,
    side: 'bid'
}

                

کنسل کردن سفارشها

request:

const url = '/v1/market/order'
const method = 'DELETE'

const res = await axios({
                urlو
                method,
                headers: {  authorization: `Bearer ${accessToken}` }
            })
                

در صورتی که paymentID فرستاده شود فقط سفارش مربوطه کنسل خواهد شد(که در این صورت پاسخ بازگشتی مشابه با «کنسل کردن سفارش» میباشد) در غیر این صورت تمام سفارشهای فعال کاربر کنسل میشوند
تعداد درخواست قابل قبول به این روت برابر است با :

60 req/min

برای لفو سفارش باید به اندپوینت زیر درخواست بزنین.

DELETE /v1/market/order

response:

res.data = {
    code: 'SUCCESS',
    message: 'all openOrders are canceled'
}

                

پارامترهای ورودی

گرفتن سفارشات فعال

request:
const url = '/v1/market/order/open'
const method = 'GET'

      const res = await axios({
        url: `${url}?market=BTC_USDT`,
        method
        headers: { authorization: `Bearer ${accessToken}` },
})
                

تعداد درخواست قابل قبول به این روت برابر است با :

60 req/min

برای دریافت سفارشات فعال باید به اندپوینت زیر درخواست بزنین.

GET /v1/market/order/open

response:

res.data = [
    {
        id: 'e959f995-8986-4cb2-8731-e6145c74047c',
        type: 'stop-limit',
        side: 'bid',
        status: 'pending',
        humanID: '210234297718',
        isTriggered: true,
        remainingAmount: 0.01,
        amount: 0.01,
        price: 0,
        stop: 1000,
        limit: 1001,
        createdAt: '2022-10-23T08:16:49.431Z',
        origin: 'nipoto',
        market: 'BTC/USDT'
    },...
]

                

پارامترهای ورودی

گرفتن تاریخچه سفارشات

request:
const url = '/v1/market/order'
const method = 'GET'

      const res = await axios({
        url,
        method,
        params: { market: 'BTC/USDT' },
        headers: { authorization: `Bearer ${accessToken}` }
})
                

در صورتی که paymentID فرستاده شود سایر پارامترها نادیده گرفته میشوند.
تعداد درخواست قابل قبول به این روت برابر است با :

60 req/min

برای دریافت سفارشات فعال باید به اندپوینت زیر درخواست بزنین.

GET /v1/market/order

response:

res.data = [{
        id: 'e959f995-8986-4cb2-8731-e6145c74047c',
        market: 'BTC/USDT',
        type: 'limit',
        side: 'bid',
        amount: 0.01,
        average: 999,
        price: 999,
        stop: 0,
        limit: 0,
        humanID: '210230633784',
        origin: 'nipoto',
        executedAmount: 0.009,
        executedTotal: 8.991,
        status: 'partiallyCanceled'
      },
      {
        amount: 0.01,
        average: 1000,
        executedAmount: 0.01,
        executedTotal: 10,
        humanID: '210230633784',
        id: 'e959f995-8986-4cb2-8731-e6145c74047d',
        limit: 0,
        market: 'BTC/USDT',
        origin: 'nipoto-api',
        price: 1000,
        side: 'bid',
        status: 'done',
        stop: 0,
        type: 'limit'
      }
]

                

پارامترهای ورودی

گرفتن اطلاعات یک سفارش

request:
const url = '/v1/market/order/:id'
const method = 'GET'

   const res = await axios({
        url: url.replace(':id', '9e0eb6c4-cf78-499a-90f2-9caac4e81c67'),
        method,
        headers: { authorization: `Bearer ${accessToken}` }
})
                

تعداد درخواست قابل قبول به این روت برابر است با :

60 req/min

برای دریافت اطلاعات یک سفارش باید به اندپوینت زیر درخواست بزنین.

GET /v1/market/order/:id

response:

res.data = {
        id: '9e0eb6c4-cf78-499a-90f2-9caac4e81c67',
        market: 'BTC/USDT',
        type: 'limit',
        side: 'bid',
        amount: 0.01,
        average: 999,
        price: 999,
        stop: 0,
        limit: 0,
        humanID: '210230633784',
        origin: 'nipoto',
        executedAmount: 0.009,
        executedTotal: 8.991,
        status: 'partiallyCanceled'
      }

                

گرفتن معاملات یک سفارش

request:
const url = '/v1/market/order/:id/trades'
const method = 'GET'

   const res = await axios({
        url: url.replace(':id', '9e0eb6c4-cf78-499a-90f2-9caac4e81c67'),
        method,
        headers: { authorization: `Bearer ${accessToken}` }
})
                

تعداد درخواست قابل قبول به این روت برابر است با :

60 req/min

برای دریافت لیست معاملات یک سفارش باید به اندپوینت زیر درخواست بزنین.

GET /v1/market/order/:id/trades

response:

res.data = [
        {
          side: 'bid',
          taker: 'maker',
          humanID: '123456',
          amount: 0.009,
          price: 999,
          fee: 0.008991,
          createdAt: '2022-10-23T08:09:20.161Z',
          market: 'BTC/USDT'
        },
        {
          side: 'bid',
          taker: 'taker',
          amount: 0.009,
          price: 999,
          fee: 0.000009,
          humanID: '123457',
          createdAt: '2022-10-23T08:09:20.161Z',
          market: 'BTC/USDT'
        }
]

                

گرفتن لیست معاملات

request:
const url = '/v1/market/trade'
const method = 'GET'

   const res = await axios({
        url: `${url}?market=BTC_USDT`,
        method,
        headers: { authorization: `Bearer ${accessToken}` }
})
                

تعداد درخواست قابل قبول به این روت برابر است با :

60 req/min

برای دریافت لیست معاملات باید به اندپوینت زیر درخواست بزنین.

GET /v1/market/trade

response:

res.data = [
        {
          side: 'bid',
          taker: 'maker',
          humanID: '123456',
          amount: 0.009,
          price: 999,
          fee: 0.008991,
          createdAt: '2022-10-23T08:09:20.161Z',
          market: 'BTC/USDT'
        },
        {
          side: 'bid',
          taker: 'taker',
          amount: 0.009,
          price: 999,
          fee: 0.000009,
          humanID: '123457',
          createdAt: '2022-10-23T08:09:20.161Z',
          market: 'BTC/USDT'
        }
]

                

پارامترهای ورودی