List all Ramzinex market pairs with their 24h financials.

Persian purpose: فهرست همه بازارها و آمار ۲۴ ساعته. Public, no auth. Maps to GET /exchange/api/{ver}/exchange/pairs. Returns the full set of tradeable pairs with last price, buy/sell, and 24h volume data.

Args: instance: Configured instance whose public base URL to use (default when omitted).

Get a single Ramzinex market pair by its numeric id.

Persian purpose: مشخصات یک بازار مشخص. Public, no auth. Maps to GET /exchange/api/{ver}/exchange/pairs/{pair_id}.

Args: pair_id: Numeric id of the pair (e.g. 2 for BTC/IRR). Discover ids with ramzinex_get_pairs. instance: Configured instance whose public base URL to use (default when omitted).

Get the buy/sell orderbook for a single pair.

Persian purpose: دفتر سفارش‌های خرید و فروش یک بازار. Public, no auth. Maps to GET /exchange/api/{ver}/exchange/orderbooks/{pair_id}/buys_sells.

Args: pair_id: Numeric id of the pair to fetch the orderbook for. instance: Configured instance whose public base URL to use (default when omitted).

Get the orderbooks for all pairs at once.

Persian purpose: دفتر سفارش‌های همه بازارها. Public, no auth. Maps to GET /exchange/api/{ver}/exchange/orderbooks/buys_sells.

Args: instance: Configured instance whose public base URL to use (default when omitted).

Get only the BUY side of the orderbook for a pair.

Persian purpose: سمت خرید دفتر سفارش‌های یک بازار. Public, no auth. Maps to GET /exchange/api/{ver}/exchange/orderbooks/{pair_id}/buys.

Args: pair_id: Numeric id of the pair to fetch buy orders for. instance: Configured instance whose public base URL to use (default when omitted).

Get only the SELL side of the orderbook for a pair.

Persian purpose: سمت فروش دفتر سفارش‌های یک بازار. Public, no auth. Maps to GET /exchange/api/{ver}/exchange/orderbooks/{pair_id}/sells.

Args: pair_id: Numeric id of the pair to fetch sell orders for. instance: Configured instance whose public base URL to use (default when omitted).

Estimate the price to BUY for a given quote amount.

Persian purpose: برآورد قیمت خرید برای مبلغ مشخص (ارز مظنه). Public, no auth. Maps to GET /exchange/api/{ver}/exchange/orderbooks/{pair_id}/market_buy_price with the amount2 (quote-currency) query parameter.

Args: pair_id: Numeric id of the pair. amount2: Amount in the quote currency (e.g. IRR/Toman) to spend buying. Must be greater than zero. instance: Configured instance whose public base URL to use (default when omitted).

Estimate the price to SELL for a given base amount.

Persian purpose: برآورد قیمت فروش برای مقدار مشخص (ارز پایه). Public, no auth. Maps to GET /exchange/api/{ver}/exchange/orderbooks/{pair_id}/market_sell_price with the amount (base-currency) query parameter.

Args: pair_id: Numeric id of the pair. amount: Amount in the base currency to sell. Must be greater than zero. instance: Configured instance whose public base URL to use (default when omitted).

Get the simple prices feed for all markets.

Persian purpose: خوراک ساده قیمت‌ها. Public, no auth. Maps to GET /exchange/api/exchange/prices (note: this path omits the version segment).

Args: instance: Configured instance whose public base URL to use (default when omitted).

List the currencies supported by Ramzinex.

Persian purpose: فهرست ارزهای پشتیبانی‌شده. Public, no auth. Maps to GET /exchange/api/{ver}/exchange/currencies.

Args: instance: Configured instance whose public base URL to use (default when omitted).

List deposit/withdraw networks, optionally filtered.

Persian purpose: شبکه‌های موجود برای واریز و برداشت. Public, no auth. Maps to GET /exchange/api/{ver}/exchange/networks with optional currency_id, withdraw, and deposit query filters.

Args: currency_id: Restrict to one currency's networks (numeric id). withdraw: When set, filter to networks that support withdrawals. deposit: When set, filter to networks that support deposits. instance: Configured instance whose public base URL to use (default when omitted).

List my orders, filterable and paginated (read-only).

Persian purpose: فهرست سفارش‌های کاربر. Requires a configured API token. Maps to POST /exchange/api/v1.0/exchange/users/me/orders2 with a JSON body of filters.

Args: limit: Max number of orders to return (1-1000, default 200). offset: Number of orders to skip for pagination (default 0). types: Optional list of order-type ids to filter by. pairs: Optional list of pair ids to filter by. currencies: Optional list of currency ids to filter by. states: Optional list of order-state ids to filter by (e.g. open). is_buy: When true, return only buy orders (default false). instance: Configured instance to use (default when omitted).

Get one of my orders by id (read-only).

Persian purpose: مشخصات یک سفارش مشخص. Requires a configured API token. Maps to GET /exchange/api/v1.0/exchange/users/me/orders2/{order_id}.

Args: order_id: Numeric id of the order to fetch. instance: Configured instance to use (default when omitted).

Place a LIMIT order — WARNING: this executes a REAL trade.

Persian purpose: ثبت سفارش محدود (معامله واقعی). Requires a configured API token AND enable_trading=true on the instance; otherwise it returns {"error": "trading_disabled", ...} without contacting the API. Maps to POST /exchange/api/v1.0/exchange/users/me/orders/limit.

This places a buy or sell order at a fixed price using real funds in the selected account. Double-check the pair, side, amount, and price before calling.

Args: pair_id: Numeric id of the pair to trade. amount: Order amount in the base currency (must be > 0). price: Limit price in the quote currency (must be > 0). type: Order side, buy or sell. instance: Configured instance to use (default when omitted).

Place a MARKET order — WARNING: this executes a REAL trade.

Persian purpose: ثبت سفارش بازار (معامله واقعی). Requires a configured API token AND enable_trading=true on the instance; otherwise it returns {"error": "trading_disabled", ...} without contacting the API. Maps to POST /exchange/api/v1.0/exchange/users/me/orders/market.

A market order fills immediately at the best available price using real funds — the executed price is not guaranteed. Double-check the pair, side, and amount before calling.

Args: pair_id: Numeric id of the pair to trade. amount: Order amount in the base currency (must be > 0). type: Order side, buy or sell. instance: Configured instance to use (default when omitted).

Cancel one of my open orders — WARNING: this changes account state.

Persian purpose: لغو یک سفارش باز. Requires a configured API token AND enable_trading=true on the instance; otherwise it returns {"error": "trading_disabled", ...} without contacting the API. Maps to POST /exchange/api/v1.0/exchange/users/me/orders/{order_id}/cancel.

Args: order_id: Numeric id of the order to cancel. instance: Configured instance to use (default when omitted).

Get my trading turnover over a number of days (read-only).

Persian purpose: گردش معاملاتی کاربر. Requires a configured API token. Maps to GET /exchange/api/v1.0/exchange/users/me/orders/turnover with readable=0, days, and pa=1.

Args: days: Look-back window in days (1-3650, default 30). instance: Configured instance to use (default when omitted).

Get full balance details for all currencies (read-only).

Persian purpose: جزئیات دارایی کاربر برای همه ارزها. Requires configured credentials. Maps to GET /exchange/api/{ver}/exchange/users/me/funds/details.

Args: instance: Configured instance to use (default when omitted).

Get balance details for one currency (read-only).

Persian purpose: جزئیات دارایی کاربر برای یک ارز مشخص. Requires configured credentials. Maps to GET /exchange/api/{ver}/exchange/users/me/funds/details/currency/{currency_id}.

Args: currency_id: Numeric id of the currency (from ramzinex_get_currencies). instance: Configured instance to use (default when omitted).

Get the account balance summary (read-only).

Persian purpose: خلاصه دارایی کاربر. Requires configured credentials. Maps to GET /exchange/api/{ver}/exchange/users/me/funds/summaryDesktop.

Args: instance: Configured instance to use (default when omitted).

Get the total balance for one currency (read-only).

Persian purpose: موجودی کل کاربر برای یک ارز مشخص. Requires configured credentials. Maps to GET /exchange/api/{ver}/exchange/users/me/funds/total/currency/{currency_id}.

Args: currency_id: Numeric id of the currency (from ramzinex_get_currencies). instance: Configured instance to use (default when omitted).

Get the available (free) balance for one currency (read-only).

Persian purpose: موجودی در دسترس کاربر برای یک ارز مشخص. Requires configured credentials. Maps to GET /exchange/api/{ver}/exchange/users/me/funds/available/currency/{currency_id}.

Args: currency_id: Numeric id of the currency. instance: Configured instance to use (default when omitted).

Get the in-orders (locked) balance for one currency (read-only).

Persian purpose: موجودی درگیر در سفارش‌های کاربر برای یک ارز. Requires configured credentials. Maps to GET /exchange/api/{ver}/exchange/users/me/funds/in_orders/currency/{currency_id}.

Args: currency_id: Numeric id of the currency. instance: Configured instance to use (default when omitted).

Get the total account value expressed in Iranian Rial (read-only).

Persian purpose: ارزش کل دارایی به ریال. Requires configured credentials. Maps to GET /exchange/api/{ver}/exchange/users/me/funds/rial_equivalent.

Args: instance: Configured instance to use (default when omitted).

Get the total account value expressed in USDT (read-only).

Persian purpose: ارزش کل دارایی به تتر. Requires configured credentials. Maps to GET /exchange/api/{ver}/exchange/users/me/funds/usdt_equivalent.

Args: instance: Configured instance to use (default when omitted).

Ask the backend to refresh / recompute balances (read-only effect).

Persian purpose: به‌روزرسانی دارایی‌ها. Requires configured credentials. This does NOT move funds; it recomputes the cached balances. Maps to POST /exchange/api/{ver}/exchange/users/me/funds/refresh.

Args: instance: Configured instance to use (default when omitted).

Get my wallet addresses for the given networks (read-only).

Persian purpose: آدرس‌های کیف پول کاربر برای شبکه‌های مشخص. Requires configured credentials. Maps to POST /exchange/api/{ver}/exchange/users/me/addresses with a body of {"networks": [...]}.

Args: networks: Non-empty list of network identifiers to fetch addresses for (discover them with ramzinex_get_networks). instance: Configured instance to use (default when omitted).

Allocate/generate a deposit address for the wallet — WARNING: wallet write.

Persian purpose: تخصیص آدرس به کیف پول کاربر. Requires configured credentials AND enable_withdrawals=true (and read_only=false) on the instance; otherwise it returns {"error": "withdrawals_disabled", ...} without contacting the API (creating a deposit address is a wallet-write action).

BEST-EFFORT PATH — confirm against the Ramzinex panel/Postman. The pasted Postman collection did not include the exact URL for this endpoint; this tool implements POST /exchange/api/{ver}/exchange/users/me/addresses/generate with body {network_id, currency_id?} as a documented assumption.

Args: network_id: Numeric id of the network to allocate an address on (must be > 0; discover via ramzinex_get_networks). currency_id: Optional numeric currency id the address is for. instance: Configured instance to use (default when omitted).

List my deposits, paginated (read-only).

Persian purpose: فهرست واریزهای کاربر. Requires configured credentials. Maps to GET /exchange/api/{ver}/exchange/users/me/funds/deposits with limit and offset query params.

Args: limit: Max number of deposits to return (1-1000, default 50). offset: Number of deposits to skip for pagination (default 0). instance: Configured instance to use (default when omitted).

List my deposits for one currency, paginated (read-only).

Persian purpose: واریزهای کاربر برای یک ارز مشخص. Requires configured credentials. Maps to GET /exchange/api/{ver}/exchange/users/me/funds/deposits/currency/{currency_id} with limit and offset query params.

Args: currency_id: Numeric id of the currency to list deposits for. limit: Max number of deposits to return (1-1000, default 50). offset: Number of deposits to skip for pagination (default 0). instance: Configured instance to use (default when omitted).

Get one deposit by id (read-only).

Persian purpose: مشخصات یک واریز مشخص. Requires configured credentials. Maps to GET /exchange/api/{ver}/exchange/users/me/funds/deposits/{deposit_id}.

Args: deposit_id: Numeric id of the deposit to fetch. instance: Configured instance to use (default when omitted).

Ask the backend to refresh deposits for one currency (no money moved).

Persian purpose: به‌روزرسانی واریزهای یک ارز. Requires configured credentials. This re-scans for incoming deposits; it does NOT move funds. Maps to POST /exchange/api/{ver}/exchange/users/me/funds/deposits/refresh/currency/{currency_id}.

Args: currency_id: Numeric id of the currency to refresh deposits for. instance: Configured instance to use (default when omitted).

List my withdrawals, paginated (read-only).

Persian purpose: فهرست برداشت‌های کاربر. Requires configured credentials. Maps to GET /exchange/api/{ver}/exchange/users/me/funds/withdraws with limit, offset, and optional currency_id query params.

Args: limit: Max number of withdrawals to return (1-1000, default 50). offset: Number of withdrawals to skip for pagination (default 0). currency_id: Optional currency id to filter withdrawals by. instance: Configured instance to use (default when omitted).

List my withdrawals for one currency (read-only).

Persian purpose: برداشت‌های کاربر برای یک ارز مشخص. Requires configured credentials. Maps to GET /exchange/api/{ver}/exchange/users/me/funds/withdraws/currency/{currency_id}.

Args: currency_id: Numeric id of the currency to list withdrawals for. instance: Configured instance to use (default when omitted).

Get one withdrawal by id (read-only).

Persian purpose: مشخصات یک برداشت مشخص. Requires configured credentials. Maps to GET /exchange/api/{ver}/exchange/users/me/funds/withdraws/{withdraw_id}.

Args: withdraw_id: Numeric id of the withdrawal to fetch. instance: Configured instance to use (default when omitted).

Submit a withdrawal request — WARNING: this moves REAL funds.

Persian purpose: ثبت درخواست برداشت (انتقال وجه واقعی). Requires configured credentials AND enable_withdrawals=true (and read_only=false) on the instance; otherwise it returns {"error": "withdrawals_disabled", ...} without contacting the API. Maps to POST /exchange/api/{ver}/exchange/users/me/funds/withdraws/currency/{currency_id} with body {amount, address, network_id, tag?, no_tag}. no_tag is derived automatically (true when no tag is provided).

Double-check the currency, network, address, and amount before calling — withdrawals are irreversible.

Args: currency_id: Numeric id of the currency to withdraw. amount: Amount to withdraw (must be > 0). address: Destination wallet address (non-empty). network_id: Numeric id of the withdrawal network (must be > 0; discover via ramzinex_get_networks). tag: Optional memo/tag/destination tag for networks that require it (e.g. XRP, TON). Omit for networks that do not. instance: Configured instance to use (default when omitted).

Confirm a pending withdrawal with 2FA codes — WARNING: moves REAL funds.

Persian purpose: تأیید برداشت با کدهای امنیتی (انتقال وجه واقعی). Requires configured credentials AND enable_withdrawals=true (and read_only=false); otherwise it returns {"error": "withdrawals_disabled", ...} without contacting the API. Maps to POST /exchange/api/{ver}/exchange/users/me/funds/withdraws/{withdraw_id}/verify with body {code, ga_code}. This finalizes an irreversible withdrawal.

Args: withdraw_id: Numeric id of the withdrawal to confirm (from ramzinex_submit_withdraw). code: SMS/email verification code (non-empty). ga_code: Google Authenticator (TOTP) code (non-empty). instance: Configured instance to use (default when omitted).

List reward / cashback entries (read-only).

Persian purpose: فهرست پاداش‌ها و کش‌بک‌ها. Requires configured credentials.

BEST-EFFORT PATH — confirm against the Ramzinex panel/Postman. The pasted Postman collection has a rewards/commissions section but did not include the exact URL; this tool implements GET /exchange/api/{ver}/exchange/users/me/rewards as a documented assumption.

Args: instance: Configured instance to use (default when omitted).

List commission / fee history (read-only).

Persian purpose: تاریخچه کمیسیون‌ها و کارمزدها. Requires configured credentials.

BEST-EFFORT PATH — confirm against the Ramzinex panel/Postman. The pasted Postman collection has a rewards/commissions section but did not include the exact URL; this tool implements GET /exchange/api/{ver}/exchange/users/me/commissions as a documented assumption.

Args: instance: Configured instance to use (default when omitted).

Update the account-wide API-key general access — WARNING: account control.

Persian purpose: ویرایش دسترسی عمومی کلید API. Requires configured credentials AND account_control=true (and read_only=false) on the instance; otherwise it returns {"error": "account_control_disabled", ...} without contacting the API. Maps to POST /exchange/api/{ver}/exchange/auth/api_key/editGeneralAccess with body {addressFree, alert}. This changes security-sensitive access settings for your API keys.

Args: address_free: 0 or 1 — whether withdrawals to any (non-whitelisted) address are allowed. alert: 0 or 1 — whether access-change alerts are enabled. instance: Configured instance to use (default when omitted).

Update per-key API access permissions — WARNING: account control.

Persian purpose: ویرایش دسترسی اختصاصی یک کلید API. Requires configured credentials AND account_control=true (and read_only=false) on the instance; otherwise it returns {"error": "account_control_disabled", ...} without contacting the API. Maps to POST /exchange/api/{ver}/exchange/auth/api_key/editPrivateAccess with body {api_key_id, withdraw, trade, cancel, excel, ipFree, ips}. This changes what one specific API key may do.

Args: api_key_id: Numeric id of the API key to edit. withdraw: 0 or 1 — allow withdrawals with this key. trade: 0 or 1 — allow placing orders with this key. cancel: 0 or 1 — allow cancelling orders with this key. excel: 0 or 1 — allow Excel/report export with this key. ip_free: 0 or 1 — when 1, the key works from any IP (no IP allowlist). ips: Optional list of allowed IPs (used when ip_free is 0). instance: Configured instance to use (default when omitted).

Authenticate an instance and cache its bearer token (no token leaked).

Persian purpose: احراز هویت و دریافت توکن. Runs the api_key + secret getToken login flow (POST /exchange/api/{ver}/exchange/auth/api_key/getToken) and caches the resulting bearer token in memory for subsequent private calls. If the instance is configured with a pre-issued api_token instead, it simply reports success. The token value is NEVER returned.

Args: instance: Configured instance to authenticate (default when omitted).

Returns: {authenticated: true, instance, method} on success, where method is "api_token" or "api_key"; otherwise a structured error.

Check that Ramzinex is reachable via a lightweight public endpoint.

Persian purpose: بررسی در دسترس بودن رمزینکس. Calls the public GET /exchange/api/{ver}/exchange/pairs endpoint (no auth) and reports whether the API responded. Returns {reachable, pairs_count?} on success or a structured error otherwise.

Args: instance: Name of the configured Ramzinex instance. Defaults to the configured default instance when omitted (the public bases work without any token).

List the configured Ramzinex instances (no secrets).

Persian purpose: فهرست نمونه‌های پیکربندی‌شده. Useful for discovering which instance values the other tools accept and which ones are set up for trading, withdrawals, or account control. Credential values (api_token, api_key, secret) are NEVER returned — only booleans saying whether they are configured.

Returns: {default_instance, instances: [{name, public_base_url, private_base_url, api_version, auth_header_name, has_credentials, auth_method, enable_trading, enable_withdrawals, account_control, read_only, trading_allowed, withdrawals_allowed, account_control_allowed, send_x_api_key, verify_ssl}]}.

Return offline documentation about Ramzinex and this server's tools.

Persian purpose: راهنمای رمزینکس و ابزارها. Use this to learn what Ramzinex offers and how each tool maps to the underlying API, without making any network call. Links point to https://ramzinex.com/exchange/apidocs.

Args: topic: Optional tool name (e.g. ramzinex_get_pairs) to fetch docs for a single tool. When omitted, returns the service overview plus the full tool list.

Returns: A dict with service metadata and matching tool documentation.