Skip to content

docs(api-key): document new permissions and exact signature generatio… #339

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
iRhonin wants to merge 2 commits into
base: master
Choose a base branch
from
Open

docs(api-key): document new permissions and exact signature generatio… #339

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
79fedc5
docs(api-key): document new permissions and exact signature generatio…
iRhonin Apr 28, 2026
815be9b
fix: some small fixes
iRhonin May 4, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions source/includes/_address_book.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,10 @@ https GET https://apiv2.nobitex.ir/address_book
- **درخواست:**: `GET /address_book`
- **<a href="/#ratelimit">محدودیت فراخوانی:</a>** 20 درخواست در هر دقیقه

<aside class="notice">
در صورت استفاده از API Key برای این درخواست، دسترسی `READ` روی کلید الزامی است.
</aside>

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

| پارامتر | نوع | پیش‌فرض | توضیحات | نمونه |
Expand Down Expand Up @@ -95,6 +99,10 @@ curl -X POST 'https://apiv2.nobitex.ir/v2/otp/request' \
- **درخواست:**: `POST /address_book`
- **<a href="/#ratelimit">محدودیت فراخوانی:</a>** 6 درخواست در هر دقیقه

<aside class="notice">
در صورت استفاده از API Key برای این درخواست، دسترسی `ADDRESS_BOOK` روی کلید الزامی است. همچنین برای دریافت `otpCode` از `v2/otp/request`، دسترسی `OTP` نیز لازم است.
</aside>

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

| پارامتر | نوع | پیش‌فرض | توضیحات | نمونه |
Expand Down Expand Up @@ -159,6 +167,10 @@ https DELETE /address_book/<address_id>/delete
- **درخواست:**: `DELETE /address_book/<address_id>/delete`
- **<a href="/#ratelimit">محدودیت فراخوانی:</a>** 6 درخواست در هر دقیقه

<aside class="notice">
در صورت استفاده از API Key برای این درخواست، دسترسی `ADDRESS_BOOK` روی کلید الزامی است.
</aside>

### حالت‌های خطا

> در صورت عدم پذیرش درخواست، پاسخ به این صورت خواهد بود:
Expand Down Expand Up @@ -199,6 +211,10 @@ https POST https://apiv2.nobitex.ir/address_book/whitelist/activate
- **درخواست:**: `POST /address_book/whitelist/activate`
- **<a href="/#ratelimit">محدودیت فراخوانی:</a>** 6 درخواست در هر دقیقه

<aside class="notice">
در صورت استفاده از API Key برای این درخواست، دسترسی `ADDRESS_BOOK` روی کلید الزامی است.
</aside>

## غیرفعال کردن برداشت امن
با غیر فعال کردن برداشت امن، به جهت حفظ امنیت حساب امکان برداشت به مدت ۲۴ ساعت روی حساب کاربر محدود خواهد شد.

Expand All @@ -224,6 +240,10 @@ https POST https://apiv2.nobitex.ir/address_book/whitelist/deactivate
- **درخواست:**: `POST /address_book/whitelist/deactivate`
- **<a href="/#ratelimit">محدودیت فراخوانی:</a>** 6 درخواست در هر دقیقه

<aside class="notice">
در صورت استفاده از API Key برای این درخواست، دسترسی `ADDRESS_BOOK` روی کلید الزامی است. همچنین برای دریافت `otpCode` از `v2/otp/request`، دسترسی `OTP` نیز لازم است.
</aside>

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

| پارامتر | نوع | پیش‌فرض | توضیحات | نمونه |
Expand Down
183 changes: 135 additions & 48 deletions source/includes/_intro.md
View file
Open in desktop

Large diffs are not rendered by default.

24 changes: 24 additions & 0 deletions source/includes/_market_trade.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,10 @@ http POST https://apiv2.nobitex.ir/market/orders/add \
- **درخواست:**: `POST /market/orders/add`
- **<a href="/#ratelimit">محدودیت فراخوانی:</a>** 300 درخواست در هر ۱۰ دقیقه (<a href="#order_ratelimit">محدودیت مشترک</a>)

<aside class="notice">
در صورت استفاده از API Key برای این درخواست، دسترسی `TRADE` روی کلید الزامی است.
</aside>

ثبت سفارش الزاماً به معنی انجام معامله نیست و بسته به نوع و قیمت سفارش و وضعیت لحظه‌ای بازار ممکن است معامله انجام شود یا نشود. با درخواست «مشاهده وضعیت سفارش» می‌توانید از وضعیت سفارش خود مطلع شوید.

سفارش‌ها پس از ثبت، پیش از ورود به دفتر معاملاتی و انجام معامله، مجدداً از نظر اعتبار مورد بررسی قرار گرفته و در صورت نامعتبر بودن، به وضعیت «رد شده» برده خواهند شد. به همین علت در صورتی که سفارش‌های شما ثبت می‌شود ولی بلافاصله به وضعیت «رد شده» تغییر حالت پیدا می‌کنند، پارامترهای ارسالی خود به ویژه مقدار و قیمت سفارش و موجودی حساب خود را دقیق‌تر بررسی نمایید.
Expand Down Expand Up @@ -284,6 +288,10 @@ http POST https://apiv2.nobitex.ir/market/orders/status \
- **درخواست:** `POST /market/orders/status`
- **<a href="/#ratelimit">محدودیت فراخوانی:</a>** 300 درخواست در هر دقیقه

<aside class="notice">
در صورت استفاده از API Key برای این درخواست، دسترسی `READ` روی کلید الزامی است.
</aside>

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

پارامتر | نوع | پیش‌فرض | توضیحات | نمونه
Expand Down Expand Up @@ -369,6 +377,10 @@ http GET https://apiv2.nobitex.ir/market/orders/list \
- **<a href="/#ratelimit">محدودیت فراخوانی:</a>** 30 درخواست در دقیقه
- **<a href="/#pagination">صفحه بندی:</a>** دارد (پیش فرض ۱۰۰)

<aside class="notice">
در صورت استفاده از API Key برای این درخواست، دسترسی `READ` روی کلید الزامی است.
</aside>

### پارامترهای ورودی
پارامتر | نوع | پیش‌فرض | توضیحات | نمونه
----------- | ---- |----------------------------------------|-----------------------------------------------------------------------------------------| -----
Expand Down Expand Up @@ -485,6 +497,10 @@ http POST https://apiv2.nobitex.ir/market/orders/update-status \
- **درخواست:** `POST /market/orders/update-status`
- **<a href="/#ratelimit">محدودیت فراخوانی:</a>** 90 درخواست در دقیقه

<aside class="notice">
در صورت استفاده از API Key برای این درخواست، دسترسی `TRADE` روی کلید الزامی است.
</aside>

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

پارامتر | نوع | پیش‌فرض | توضیحات | نمونه
Expand Down Expand Up @@ -550,6 +566,10 @@ http POST https://apiv2.nobitex.ir/market/orders/cancel-old \
- **درخواست:** `POST /market/orders/cancel-old`
- **<a href="/#ratelimit">محدودیت فراخوانی:</a>** 30 درخواست در دقیقه

<aside class="notice">
در صورت استفاده از API Key برای این درخواست، دسترسی `TRADE` روی کلید الزامی است.
</aside>

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

| پارامتر | نوع | پیش‌فرض | توضیحات | نمونه |
Expand Down Expand Up @@ -621,6 +641,10 @@ http GET https://apiv2.nobitex.ir/market/trades/list?srcCurrency=usdt&dstCurrenc
- **<a href="/#ratelimit">محدودیت فراخوانی:</a>** 30 درخواست در دقیقه
- **<a href="/#pagination">صفحه بندی:</a>** دارد (پیش فرض ۳۰)

<aside class="notice">
در صورت استفاده از API Key برای این درخواست، دسترسی `READ` روی کلید الزامی است.
</aside>



### پارامترهای ورودی
Expand Down
11 changes: 11 additions & 0 deletions source/includes/_portfolio.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,6 +100,10 @@ Authorization: Token yourTOKENhereHEX0000000000
* **درخواست:** `POST users/portfolio/last-week-daily-profit`
* **<a href="/#ratelimit">محدودیت فراخوانی:</a>** 10 درخواست در 3 دقیقه

<aside class="notice">
در صورت استفاده از API Key برای این درخواست، دسترسی `READ` روی کلید الزامی است.
</aside>

### نکات و ملاحظات:
این API به صورت پیش فرض اطلاعات 7 روز گذشته را ارائه می دهد. برای دریافت اطلاعات ماهانه یا ۳۰ روز گذشته کافیست پارامتر monthly با مقدار true را به همراه این درخواست ارسال نمایید.

Expand Down Expand Up @@ -185,6 +189,10 @@ Authorization: Token yourTOKENhereHEX0000000000
* **درخواست:** `POST users/portfolio/last-week-daily-total-profit`
* **<a href="/#ratelimit">محدودیت فراخوانی:</a>** 10 درخواست در 3 دقیقه

<aside class="notice">
در صورت استفاده از API Key برای این درخواست، دسترسی `READ` روی کلید الزامی است.
</aside>



<h2 id="last-month-total-profit">سود و زیان کل ماه گذشته</h2>
Expand Down Expand Up @@ -236,5 +244,8 @@ Authorization: Token yourTOKENhereHEX0000000000
* **درخواست:** `POST users/portfolio/last-month-total-profit`
* **<a href="/#ratelimit">محدودیت فراخوانی:</a>** 10 درخواست در 3 دقیقه

<aside class="notice">
در صورت استفاده از API Key برای این درخواست، دسترسی `READ` روی کلید الزامی است.
</aside>


24 changes: 24 additions & 0 deletions source/includes/_position.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -278,6 +278,10 @@ http GET https://apiv2.nobitex.ir/margin/v2/delegation-limit \
- **درخواست:**: `GET /margin/v2/delegation-limit`
- **<a href="/#ratelimit">محدودیت فراخوانی:</a>** ۱۲ درخواست در هر دقیقه

<aside class="notice">
در صورت استفاده از API Key برای این درخواست، دسترسی `READ` روی کلید الزامی است.
</aside>


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

Expand Down Expand Up @@ -376,6 +380,10 @@ http POST https://apiv2.nobitex.ir/margin/orders/add \
- **درخواست:**: `POST /margin/orders/add`
- **<a href="/#ratelimit">محدودیت فراخوانی:</a>** ۳۰۰ درخواست در هر ۱۰ دقیقه

<aside class="notice">
در صورت استفاده از API Key برای این درخواست، دسترسی `TRADE` روی کلید الزامی است.
</aside>


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

Expand Down Expand Up @@ -536,6 +544,10 @@ http GET https://apiv2.nobitex.ir/positions/list \

- **<a href="/#pagination">صفحه‌بندی:</a>** دارد (پیش فرض ۵۰)

<aside class="notice">
در صورت استفاده از API Key برای این درخواست، دسترسی `READ` روی کلید الزامی است.
</aside>

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

| پارامتر | نوع | پیش‌فرض | توضیحات | نمونه |
Expand Down Expand Up @@ -670,6 +682,10 @@ http GET https://apiv2.nobitex.ir/positions/128/status
- **درخواست:**: `GET /positions/:positionId:/status`
- **<a href="/#ratelimit">محدودیت فراخوانی:</a>** ۱۰۰ درخواست در هر ۱۰ دقیقه (<a href="#order_ratelimit">محدودیت مشترک</a>)

<aside class="notice">
در صورت استفاده از API Key برای این درخواست، دسترسی `READ` روی کلید الزامی است.
</aside>

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

| پارامتر | نوع | پیش‌فرض | توضیحات | نمونه |
Expand Down Expand Up @@ -731,6 +747,10 @@ http POST https://apiv2.nobitex.ir/positions/128/close \
- **درخواست:**: `POST /positions/:positionId:/close`
- **<a href="/#ratelimit">محدودیت فراخوانی:</a>** ۳۰۰ درخواست در هر ۱۰ دقیقه

<aside class="notice">
در صورت استفاده از API Key برای این درخواست، دسترسی `TRADE` روی کلید الزامی است.
</aside>

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

| پارامتر | نوع | پیش‌فرض | توضیحات | نمونه |
Expand Down Expand Up @@ -865,6 +885,10 @@ http POST https://apiv2.nobitex.ir/positions/128/edit-collateral \
- **درخواست:**: `POST /positions/:positionId:/edit-collateral`
- **<a href="/#ratelimit">محدودیت فراخوانی:</a>** ۶۰ درخواست در هر دقیقه

<aside class="notice">
در صورت استفاده از API Key برای این درخواست، دسترسی `TRADE` روی کلید الزامی است.
</aside>

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

| پارامتر | نوع | پیش‌فرض | توضیحات | نمونه |
Expand Down
17 changes: 12 additions & 5 deletions source/includes/_security.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,12 +37,12 @@ http POST https://apiv2.nobitex.ir/users/login-attempts \

```shell
curl 'https://apiv2.nobitex.ir/security/emergency-cancel/activate' \
-X GET \
-X POST \
-H "Authorization: Token yourTOKENhereHEX0000000000"
```

```plaintext
http GET https://apiv2.nobitex.ir/security/emergency-cancel/activate \
http POST https://apiv2.nobitex.ir/security/emergency-cancel/activate \
Authorization: Token yourTOKENhereHEX0000000000
```

Expand All @@ -58,11 +58,14 @@ http GET https://apiv2.nobitex.ir/security/emergency-cancel/activate \
```


جهت فعالسازی امکان لغو اضطراریِ درخواست های برداشت از این درخواست استفاده نمائید.
جهت دریافت کد فعالسازی و فعالسازی امکان لغو اضطراریِ درخواست های برداشت از درخواست‌های زیر استفاده نمائید.
پس از فعالسازی این امکان، پیامک و ایمیل ارسالی پس از ثبت درخواست برداشت،
حاوی لینکی خواهد بود که شما میتوانید با استفاده از آن در صورتی که درخواست برداشت توسط شما ثبت نشده است، در کمترین زمان ممکن و بدون نیاز به لاگین، درخواست های برداشت خود را لغو نمایید.

- **درخواست:** `GET /security/emergency-cancel/activate`
- **درخواست دریافت کد:** `POST /security/emergency-cancel/get-code`
- **درخواست فعالسازی:** `POST /security/emergency-cancel/activate`

در صورت استفاده از API Key برای این درخواست‌ها، دسترسی `WITHDRAW` روی کلید الزامی است.


### نکات و ملاحظات
Expand Down Expand Up @@ -98,6 +101,10 @@ curl --location --request POST 'https://apiv2.nobitex.ir/security/anti-phishing'

> برای دریافت رمزیکبارمصرف otpCode باید از API زیر با پارامترهای مشخص شده استفاده نمایید:

<aside class="notice">
در صورت استفاده از API Key برای این درخواست، دسترسی `OTP` روی کلید الزامی است.
</aside>

```shell
curl -X POST 'https://apiv2.nobitex.ir/v2/otp/request' \
-H 'Authorization: Token yourTOKENhereHEX0000000000' \
Expand Down Expand Up @@ -162,7 +169,7 @@ otpCode | number | الزامی | کد یکبار مصرف ارسال شده ب

```shell
curl --location --request GET 'https://apiv2.nobitex.ir/security/anti-phishing' \
--header 'Authorization: Token yourTOKENhereHEX0000000000'
--header 'Authorization: Token yourTOKENhereHEX0000000000'
```


Expand Down
37 changes: 36 additions & 1 deletion source/includes/_user_data.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,10 @@ http POST https://apiv2.nobitex.ir/users/profile \

- **درخواست:** `GET /users/profile`

<aside class="notice">
در صورت استفاده از API Key برای این درخواست، دسترسی `READ` روی کلید الزامی است.
</aside>

### پارامترهای ورودی
برای دریافت پاسخ، کافیست توکن احراز هویت را ارسال نمایید

Expand Down Expand Up @@ -120,6 +124,10 @@ http POST https://apiv2.nobitex.ir/users/wallets/generate-address \
- **درخواست:** `POST /users/wallets/generate-address`
- **<a href="/#ratelimit">محدودیت فراخوانی:</a>** ۳۰ درخواست در ساعت

<aside class="notice">
در صورت استفاده از API Key برای این درخواست، دسترسی `DEPOSIT` روی کلید الزامی است.
</aside>


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

Expand Down Expand Up @@ -265,6 +273,10 @@ http GET https://apiv2.nobitex.ir/users/limitations

- **درخواست:** `POST /users/limitations`

<aside class="notice">
در صورت استفاده از API Key برای این درخواست، دسترسی `READ` روی کلید الزامی است.
</aside>

### پارامترهای ورودی
- در این بخش به ورودی نیاز نیست.
- توکن دریافتی از بخش لاگین باید در هدر ارسال شود.
Expand Down Expand Up @@ -363,6 +375,10 @@ http GET https://apiv2.nobitex.ir/users/wallets/list \
- **درخواست:** `GET /users/wallets/list`
- **<a href="/#ratelimit">محدودیت فراخوانی:</a>** 20 درخواست در 2 دقیقه

<aside class="notice">
در صورت استفاده از API Key برای این درخواست، دسترسی `READ` روی کلید الزامی است.
</aside>


### نکات و ملاحظات
1. کیف پول یک رمزارز در صورتی برای کاربر ایجاد می‌شود که کاربر سفارشی در بازار آن رمزارز ثبت کرده و یا آدرس واریز برای آن ایجاد کرده باشد.
Expand Down Expand Up @@ -408,6 +424,10 @@ http GET https://apiv2.nobitex.ir/v2/wallets \
- **درخواست:** `GET /v2/wallets`
- **<a href="/#ratelimit">محدودیت فراخوانی:</a>** 15 درخواست در دقیقه

<aside class="notice">
در صورت استفاده از API Key برای این درخواست، دسترسی `READ` روی کلید الزامی است.
</aside>

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

پارامتر | نوع | پیش‌فرض | توضیحات | نمونه
Expand Down Expand Up @@ -449,6 +469,10 @@ http POST https://apiv2.nobitex.ir/users/wallets/balance \
- **درخواست:** `POST /users/wallets/balance`
- **<a href="/#ratelimit">محدودیت فراخوانی:</a>** ۶۰ درخواست در ۲ دقیقه

<aside class="notice">
در صورت استفاده از API Key برای این درخواست، دسترسی `READ` روی کلید الزامی است.
</aside>

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

پارامتر | نوع | پیش‌فرض | توضیحات | نمونه
Expand Down Expand Up @@ -505,6 +529,10 @@ http GET https://apiv2.nobitex.ir/users/wallets/transactions/list \
- **<a href="/#ratelimit">محدودیت فراخوانی:</a>** ۶۰ درخواست در ۲ دقیقه
- **<a href="#pagination">صفحه بندی:</a>** دارد (پیشفرض ۵۰)

<aside class="notice">
در صورت استفاده از API Key برای این درخواست، دسترسی `READ` روی کلید الزامی است.
</aside>

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

پارامتر | نوع | پیش‌فرض | توضیحات | نمونه
Expand Down Expand Up @@ -562,6 +590,10 @@ http GET https://apiv2.nobitex.ir/users/transactions-history \
- **<a href="/#ratelimit">محدودیت فراخوانی:</a>** ۶۰ درخواست در ساعت
- **<a href="#pagination">صفحه بندی:</a>** دارد (پیشفرض ۵۰)

<aside class="notice">
در صورت استفاده از API Key برای این درخواست، دسترسی `READ` روی کلید الزامی است.
</aside>

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

| پارامتر | نوع | پیش‌فرض | توضیحات | نمونه |
Expand Down Expand Up @@ -638,6 +670,10 @@ http GET https://apiv2.nobitex.ir/users/wallets/deposits/list \
- **<a href="#pagination">صفحه بندی:</a>** دارد (پیشفرض ۱۰برای ریال و ۲۰برای سایر)
- **<a href="#date-filter">فیلترزمانی:</a>** دارد

<aside class="notice">
در صورت استفاده از API Key برای این درخواست، دسترسی `READ` روی کلید الزامی است.
</aside>

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

پارامتر | نوع | پیش‌فرض | توضیحات | نمونه
Expand Down Expand Up @@ -762,4 +798,3 @@ http DELETE https://apiv2.nobitex.ir/users/markets/favorite
پارامتر | نوع | پیش‌فرض | توضیحات | نمونه
----------- | ---- | ------ |-----------------------------------| -----
market | string | الزامی | نماد بازار و یا All برای حذف همه | `All` or `BTCIRT`

Loading