{ "openapi": "3.1.0", "info": { "title": "مستندات API رمزینکس", "description": "مستندات اندپوینت‌های رمزینکس" }, "servers": [ { "url": "https://ramzinex.ir/" } ], "paths": { "/orderbooks/{pair_id}/buys_sells": { "get": { "summary": "لیست سفارش های باز ( اردربوک) یک بازار مشخص", "description": "برای دریافت لیست سفارشات خرید و فروش موجود در بازار از این نوع درخواست استفاده نمایید:", "operationId": "buySellId", "parameters": [ { "$ref": "#/components/parameters/PairId" } ], "tags": [ "اطلاعات بازار (عمومی)" ], "responses": { "200": { "description": "موفق", "content": { "application/json": { "examples": { "default_example": { "$ref": "#/components/examples/GetSellAndBuy" } } } } } }, "x-codeSamples": [ { "lang": "cURL", "source": "curl --location 'https://publicapi.ramzinex.ir/exchange/api/v1.0/exchange/orderbooks/11/buys_sells' \ --header 'Content-Type: application/json'" }, { "lang": "PHP", "source": " 'https://publicapi.ramzinex.ir/exchange/api/v1.0/exchange/orderbooks/11/buys_sells', CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => '', CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 0, CURLOPT_FOLLOWLOCATION => true, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => 'GET', CURLOPT_HTTPHEADER => array( 'Content-Type: application/json' ), )); $response = curl_exec($curl); curl_close($curl); echo $response; " }, { "lang": "Python", "source": "import requests url = 'https://publicapi.ramzinex.ir/exchange/api/v1.0/exchange/orderbooks/11/buys_sells' headers = { \"Content-Type\": \"application/json\" } response = requests.request('GET', url, headers=headers) response.raise_for_status() print(response.json())" }, { "lang": "JavaScript", "source": "const url = \"https://publicapi.ramzinex.ir/exchange/api/v1.0/exchange/orderbooks/11/buys_sells\"; const headers = { \"Content-Type\": \"application/json\" }; const response = await fetch(url, { method: \"GET\", headers }); if (!response.ok) throw new Error(`HTTP ${response.status}`); console.log(await response.json());" }, { "lang": "C#", "source": "using System.Net.Http; using System.Text; using var client = new HttpClient(); using var request = new HttpRequestMessage(HttpMethod.Get, \"https://publicapi.ramzinex.ir/exchange/api/v1.0/exchange/orderbooks/11/buys_sells\"); using var response = await client.SendAsync(request); response.EnsureSuccessStatusCode(); Console.WriteLine(await response.Content.ReadAsStringAsync());" } ] }, "servers": [ { "url": "https://publicapi.ramzinex.ir/exchange/api/v1.0/exchange/" } ] }, "/orderbooks/buys_sells": { "get": { "summary": "لیست سفارش های باز ( اردربوک) بازارها", "description": "برای دریافت لیست سفارشات خرید و فروش موجود در بازار از این نوع درخواست استفاده نمایید:", "operationId": "buySellsId", "tags": [ "اطلاعات بازار (عمومی)" ], "responses": { "200": { "description": "موفق", "content": { "application/json": { "examples": { "default_example": { "$ref": "#/components/examples/GetSellAndBuyAll" } } } } } }, "x-codeSamples": [ { "lang": "cURL", "source": "curl --location 'https://publicapi.ramzinex.ir/exchange/api/v1.0/exchange/orderbooks/buys_sells' \ --header 'Content-Type: application/json'" }, { "lang": "PHP", "source": " 'https://publicapi.ramzinex.ir/exchange/api/v1.0/exchange/orderbooks/buys_sells', CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => '', CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 0, CURLOPT_FOLLOWLOCATION => true, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => 'GET', CURLOPT_HTTPHEADER => array( 'Content-Type: application/json' ), )); $response = curl_exec($curl); curl_close($curl); echo $response; " }, { "lang": "Python", "source": "import requests url = 'https://publicapi.ramzinex.ir/exchange/api/v1.0/exchange/orderbooks/buys_sells' headers = { \"Content-Type\": \"application/json\" } response = requests.request('GET', url, headers=headers) response.raise_for_status() print(response.json())" }, { "lang": "JavaScript", "source": "const url = \"https://publicapi.ramzinex.ir/exchange/api/v1.0/exchange/orderbooks/buys_sells\"; const headers = { \"Content-Type\": \"application/json\" }; const response = await fetch(url, { method: \"GET\", headers }); if (!response.ok) throw new Error(`HTTP ${response.status}`); console.log(await response.json());" }, { "lang": "C#", "source": "using System.Net.Http; using System.Text; using var client = new HttpClient(); using var request = new HttpRequestMessage(HttpMethod.Get, \"https://publicapi.ramzinex.ir/exchange/api/v1.0/exchange/orderbooks/buys_sells\"); using var response = await client.SendAsync(request); response.EnsureSuccessStatusCode(); Console.WriteLine(await response.Content.ReadAsStringAsync());" } ] }, "servers": [ { "url": "https://publicapi.ramzinex.ir/exchange/api/v1.0/exchange/" } ] }, "/orderbooks/{pair_id}/trades": { "get": { "summary": "لیست آخرین معاملات بازار", "description": "برای دریافت لیست معاملات انجام شده در بازار از این نوع درخواست استفاده نمایید:", "operationId": "tradeId", "parameters": [ { "$ref": "#/components/parameters/PairId" } ], "tags": [ "اطلاعات بازار (عمومی)" ], "responses": { "200": { "description": "موفق", "content": { "application/json": { "examples": { "default_example": { "$ref": "#/components/examples/GetTrades" } } } } } }, "x-codeSamples": [ { "lang": "cURL", "source": "curl --location 'https://publicapi.ramzinex.ir/exchange/api/v1.0/exchange/orderbooks/11/trades' \ --header 'Content-Type: application/json'" }, { "lang": "PHP", "source": " 'https://publicapi.ramzinex.ir/exchange/api/v1.0/exchange/orderbooks/11/trades', CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => '', CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 0, CURLOPT_FOLLOWLOCATION => true, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => 'GET', CURLOPT_HTTPHEADER => array( 'Content-Type: application/json' ), )); $response = curl_exec($curl); curl_close($curl); echo $response; " }, { "lang": "Python", "source": "import requests url = 'https://publicapi.ramzinex.ir/exchange/api/v1.0/exchange/orderbooks/11/trades' headers = { \"Content-Type\": \"application/json\" } response = requests.request('GET', url, headers=headers) response.raise_for_status() print(response.json())" }, { "lang": "JavaScript", "source": "const url = \"https://publicapi.ramzinex.ir/exchange/api/v1.0/exchange/orderbooks/11/trades\"; const headers = { \"Content-Type\": \"application/json\" }; const response = await fetch(url, { method: \"GET\", headers }); if (!response.ok) throw new Error(`HTTP ${response.status}`); console.log(await response.json());" }, { "lang": "C#", "source": "using System.Net.Http; using System.Text; using var client = new HttpClient(); using var request = new HttpRequestMessage(HttpMethod.Get, \"https://publicapi.ramzinex.ir/exchange/api/v1.0/exchange/orderbooks/11/trades\"); using var response = await client.SendAsync(request); response.EnsureSuccessStatusCode(); Console.WriteLine(await response.Content.ReadAsStringAsync());" } ], "servers": [ { "url": "https://publicapi.ramzinex.ir/exchange/api/v1.0/exchange/" } ] } }, "/currencies": { "get": { "summary": "ارزهای رمزینکس", "description": "مشخصات ارزهایی که در رمزینکس خرید و فروش می‌شوند", "operationId": "currenciesId", "tags": [ "اطلاعات بازار (عمومی)" ], "responses": { "200": { "description": "موفق", "content": { "application/json": { "examples": { "default_example": { "$ref": "#/components/examples/GetCurrencies" } } } } } }, "x-codeSamples": [ { "lang": "cURL", "source": "curl --location 'https://api.ramzinex.ir/exchange/api/v2.0/exchange/currencies'" }, { "lang": "PHP", "source": " 'https://api.ramzinex.ir/exchange/api/v2.0/exchange/currencies', CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => '', CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 0, CURLOPT_FOLLOWLOCATION => true, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => 'GET', )); $response = curl_exec($curl); curl_close($curl); echo $response; " }, { "lang": "Python", "source": "import requests url = 'https://api.ramzinex.ir/exchange/api/v2.0/exchange/currencies' headers = {} response = requests.request('GET', url, headers=headers) response.raise_for_status() print(response.json())" }, { "lang": "JavaScript", "source": "const url = \"https://api.ramzinex.ir/exchange/api/v2.0/exchange/currencies\"; const headers = {}; const response = await fetch(url, { method: \"GET\", headers }); if (!response.ok) throw new Error(`HTTP ${response.status}`); console.log(await response.json());" }, { "lang": "C#", "source": "using System.Net.Http; using System.Text; using var client = new HttpClient(); using var request = new HttpRequestMessage(HttpMethod.Get, \"https://api.ramzinex.ir/exchange/api/v2.0/exchange/currencies\"); using var response = await client.SendAsync(request); response.EnsureSuccessStatusCode(); Console.WriteLine(await response.Content.ReadAsStringAsync());" } ], "servers": [ { "url": "https://api.ramzinex.ir/exchange/api/v2.0/exchange" } ] } }, "/currencies/{id}": { "get": { "summary": "مشخصات یک ارز مشخص", "description": "برای دریافت اطلاعات یک ارز رمزینکس از این نوع درخواست استفاده نمایید", "operationId": "aCurrencyId", "parameters": [ { "$ref": "#/components/parameters/CurrencyIdV2" } ], "tags": [ "اطلاعات بازار (عمومی)" ], "responses": { "200": { "description": "موفق", "content": { "application/json": { "examples": { "default_example": { "$ref": "#/components/examples/GetACurrency" } } } } } },"x-codeSamples": [ { "lang": "cURL", "source": "curl --location 'https://api.ramzinex.ir/exchange/api/v2.0/exchange/currencies/9'" }, { "lang": "PHP", "source": " 'https://api.ramzinex.ir/exchange/api/v2.0/exchange/currencies/9', CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => '', CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 0, CURLOPT_FOLLOWLOCATION => true, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => 'GET', )); $response = curl_exec($curl); curl_close($curl); echo $response; " }, { "lang": "Python", "source": "import requests url = 'https://api.ramzinex.ir/exchange/api/v2.0/exchange/currencies/9' headers = {} response = requests.request('GET', url, headers=headers) response.raise_for_status() print(response.json())" }, { "lang": "JavaScript", "source": "const url = \"https://api.ramzinex.ir/exchange/api/v2.0/exchange/currencies/9\"; const headers = {}; const response = await fetch(url, { method: \"GET\", headers }); if (!response.ok) throw new Error(`HTTP ${response.status}`); console.log(await response.json());" }, { "lang": "C#", "source": "using System.Net.Http; using System.Text; using var client = new HttpClient(); using var request = new HttpRequestMessage(HttpMethod.Get, \"https://api.ramzinex.ir/exchange/api/v2.0/exchange/currencies/9\"); using var response = await client.SendAsync(request); response.EnsureSuccessStatusCode(); Console.WriteLine(await response.Content.ReadAsStringAsync());" } ], "servers": [ { "url": "https://api.ramzinex.ir/exchange/api/v2.0/exchange/" } ] } }, "/pairs": { "get": { "summary": "بازارهای رمزینکس", "description": "دریافت مشخصات وضعیت بازارهای رمزینکس", "operationId": "pairsId", "tags": [ "اطلاعات بازار (عمومی)" ], "responses": { "200": { "description": "موفق", "content": { "application/json": { "examples": { "default_example": { "$ref": "#/components/examples/GetPairs" } } } } } },"x-codeSamples": [ { "lang": "cURL", "source": "curl --location 'https://api.ramzinex.ir/exchange/api/v2.0/exchange/pairs'" }, { "lang": "PHP", "source": " 'https://api.ramzinex.ir/exchange/api/v2.0/exchange/pairs', CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => '', CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 0, CURLOPT_FOLLOWLOCATION => true, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => 'GET', )); $response = curl_exec($curl); curl_close($curl); echo $response; " }, { "lang": "Python", "source": "import requests url = 'https://api.ramzinex.ir/exchange/api/v2.0/exchange/pairs' headers = {} response = requests.request('GET', url, headers=headers) response.raise_for_status() print(response.json())" }, { "lang": "JavaScript", "source": "const url = \"https://api.ramzinex.ir/exchange/api/v2.0/exchange/pairs\"; const headers = {}; const response = await fetch(url, { method: \"GET\", headers }); if (!response.ok) throw new Error(`HTTP ${response.status}`); console.log(await response.json());" }, { "lang": "C#", "source": "using System.Net.Http; using System.Text; using var client = new HttpClient(); using var request = new HttpRequestMessage(HttpMethod.Get, \"https://api.ramzinex.ir/exchange/api/v2.0/exchange/pairs\"); using var response = await client.SendAsync(request); response.EnsureSuccessStatusCode(); Console.WriteLine(await response.Content.ReadAsStringAsync());" } ], "servers": [ { "url": "https://api.ramzinex.ir/exchange/api/v2.0/exchange" } ] } }, "/pairs/{pair_id}": { "get": { "summary": "مشخصات یک بازار مشخص", "description": "برای دریافت مشخصات یک بازار مشخص از این نوع درخواست استفاده نمایید", "operationId": "aPairId", "tags": [ "اطلاعات بازار (عمومی)" ], "parameters": [ { "$ref": "#/components/parameters/PairId" } ], "responses": { "200": { "description": "موفق", "content": { "application/json": { "examples": { "default_example": { "$ref": "#/components/examples/GetAPair" } } } } } },"x-codeSamples": [ { "lang": "cURL", "source": "curl --location 'https://api.ramzinex.ir/exchange/api/v2.0/exchange/pairs/2'" }, { "lang": "PHP", "source": " 'https://api.ramzinex.ir/exchange/api/v2.0/exchange/pairs/2', CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => '', CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 0, CURLOPT_FOLLOWLOCATION => true, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => 'GET', )); $response = curl_exec($curl); curl_close($curl); echo $response; " }, { "lang": "Python", "source": "import requests url = 'https://api.ramzinex.ir/exchange/api/v2.0/exchange/pairs/2' headers = {} response = requests.request('GET', url, headers=headers) response.raise_for_status() print(response.json())" }, { "lang": "JavaScript", "source": "const url = \"https://api.ramzinex.ir/exchange/api/v2.0/exchange/pairs/2\"; const headers = {}; const response = await fetch(url, { method: \"GET\", headers }); if (!response.ok) throw new Error(`HTTP ${response.status}`); console.log(await response.json());" }, { "lang": "C#", "source": "using System.Net.Http; using System.Text; using var client = new HttpClient(); using var request = new HttpRequestMessage(HttpMethod.Get, \"https://api.ramzinex.ir/exchange/api/v2.0/exchange/pairs/2\"); using var response = await client.SendAsync(request); response.EnsureSuccessStatusCode(); Console.WriteLine(await response.Content.ReadAsStringAsync());" }, ], "servers": [ { "url": "https://api.ramzinex.ir/exchange/api/v2.0/exchange/" } ] } }, "/orderbooks/{pair_id}/market_buy_price": { "get": { "summary": "قیمت تمام شده خرید یک ارز", "description": "قیمت تمام شده خرید یک ارز با مقدار مشخص شده در بازار رمزینکس", "operationId": "marketBuyPriceId", "tags": [ "اطلاعات بازار (عمومی)" ], "parameters": [ { "$ref": "#/components/parameters/PairId" } ], "responses": { "200": { "description": "موفق", "content": { "application/json": { "examples": { "default_example": { "$ref": "#/components/examples/GetMarketBuyPrice" } } } } } }, "x-codeSamples": [ { "lang": "cURL", "source": "curl --location 'https://publicapi.ramzinex.ir/exchange/api/v1.0/exchange/orderbooks/11/market_buy_price'" }, { "lang": "PHP", "source": " 'https://publicapi.ramzinex.ir/exchange/api/v1.0/exchange/orderbooks/11/market_buy_price', CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => '', CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 0, CURLOPT_FOLLOWLOCATION => true, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => 'GET', )); $response = curl_exec($curl); curl_close($curl); echo $response; " }, { "lang": "Python", "source": "import requests url = 'https://publicapi.ramzinex.ir/exchange/api/v1.0/exchange/orderbooks/11/market_buy_price' headers = {} response = requests.request('GET', url, headers=headers) response.raise_for_status() print(response.json())" }, { "lang": "JavaScript", "source": "const url = \"https://publicapi.ramzinex.ir/exchange/api/v1.0/exchange/orderbooks/11/market_buy_price\"; const headers = {}; const response = await fetch(url, { method: \"GET\", headers }); if (!response.ok) throw new Error(`HTTP ${response.status}`); console.log(await response.json());" }, { "lang": "C#", "source": "using System.Net.Http; using System.Text; using var client = new HttpClient(); using var request = new HttpRequestMessage(HttpMethod.Get, \"https://publicapi.ramzinex.ir/exchange/api/v1.0/exchange/orderbooks/11/market_buy_price\"); using var response = await client.SendAsync(request); response.EnsureSuccessStatusCode(); Console.WriteLine(await response.Content.ReadAsStringAsync());" } ], "servers": [ { "url": "https://publicapi.ramzinex.ir/exchange/api/v1.0/exchange/" } ] } }, "/orderbooks/{pair_id}/market_sell_price": { "get": { "summary": "قیمت تمام شده فروش یک ارز", "description": "قیمت تمام شده فروش یک ارز با مقدار مشخص شده در بازار رمزینکس", "operationId": "marketSellPriceId", "tags": [ "اطلاعات بازار (عمومی)" ], "parameters": [ { "$ref": "#/components/parameters/PairId" } ], "responses": { "200": { "description": "موفق", "content": { "application/json": { "examples": { "default_example": { "$ref": "#/components/examples/GetMarketSellPrice" } } } } } }, "x-codeSamples": [ { "lang": "cURL", "source": "curl --location 'https://publicapi.ramzinex.ir/exchange/api/v1.0/exchange/orderbooks/11/market_sell_price'" }, { "lang": "PHP", "source": " 'https://publicapi.ramzinex.ir/exchange/api/v1.0/exchange/orderbooks/11/market_sell_price', CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => '', CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 0, CURLOPT_FOLLOWLOCATION => true, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => 'GET', )); $response = curl_exec($curl); curl_close($curl); echo $response; " }, { "lang": "Python", "source": "import requests url = 'https://publicapi.ramzinex.ir/exchange/api/v1.0/exchange/orderbooks/11/market_sell_price' headers = {} response = requests.request('GET', url, headers=headers) response.raise_for_status() print(response.json())" }, { "lang": "JavaScript", "source": "const url = \"https://publicapi.ramzinex.ir/exchange/api/v1.0/exchange/orderbooks/11/market_sell_price\"; const headers = {}; const response = await fetch(url, { method: \"GET\", headers }); if (!response.ok) throw new Error(`HTTP ${response.status}`); console.log(await response.json());" }, { "lang": "C#", "source": "using System.Net.Http; using System.Text; using var client = new HttpClient(); using var request = new HttpRequestMessage(HttpMethod.Get, \"https://publicapi.ramzinex.ir/exchange/api/v1.0/exchange/orderbooks/11/market_sell_price\"); using var response = await client.SendAsync(request); response.EnsureSuccessStatusCode(); Console.WriteLine(await response.Content.ReadAsStringAsync());" } ], "servers": [ { "url": "https://publicapi.ramzinex.ir/exchange/api/v1.0/exchange/" } ] } }, "/chart/statistics-24": { "get": { "summary": "آمار 24 ساعته بازارها", "description": "برای دریافت آخرین آمار بازارهای رمزینکس در 24 ساعت گذشته از این درخواست استفاده نمایید.", "operationId": "statistics24Id", "tags": [ "اطلاعات بازار (عمومی)" ], "responses": { "200": { "description": "موفق", "content": { "application/json": { "examples": { "default_example": { "$ref": "#/components/examples/Statistic24Res" } } } } } }, "x-codeSamples": [ { "lang": "cURL", "source": "curl --location 'https://publicapi.ramzinex.ir/exchange/api/v1.0/exchange/chart/statistics-24'" }, { "lang": "PHP", "source": " 'https://publicapi.ramzinex.ir/exchange/api/v1.0/exchange/chart/statistics-24', CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => '', CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 0, CURLOPT_FOLLOWLOCATION => true, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => 'GET', )); $response = curl_exec($curl); curl_close($curl); echo $response; " }, { "lang": "Python", "source": "import requests url = 'https://publicapi.ramzinex.ir/exchange/api/v1.0/exchange/chart/statistics-24' headers = {} response = requests.request('GET', url, headers=headers) response.raise_for_status() print(response.json())" }, { "lang": "JavaScript", "source": "const url = \"https://publicapi.ramzinex.ir/exchange/api/v1.0/exchange/chart/statistics-24\"; const headers = {}; const response = await fetch(url, { method: \"GET\", headers }); if (!response.ok) throw new Error(`HTTP ${response.status}`); console.log(await response.json());" }, { "lang": "C#", "source": "using System.Net.Http; using System.Text; using var client = new HttpClient(); using var request = new HttpRequestMessage(HttpMethod.Get, \"https://publicapi.ramzinex.ir/exchange/api/v1.0/exchange/chart/statistics-24\"); using var response = await client.SendAsync(request); response.EnsureSuccessStatusCode(); Console.WriteLine(await response.Content.ReadAsStringAsync());" } ] }, "servers": [ { "url": "https://publicapi.ramzinex.ir/exchange/api/v1.0/exchange/" } ] }, "/chart/tv/history": { "get": { "summary": "کندل ها (آمار OHLC بازارها)", "description": "با این درخواست می‌توانید کندل‌های بازارهای رمزینکس را در بازهٔ زمانی مشخص دریافت کنید. مقادیر resolution خارج از مقادیر پشتیبانی‌شده به بازهٔ یک‌ساعته نگاشت می‌شوند.", "operationId": "chartHistoryId", "tags": [ "اطلاعات بازار (عمومی)" ], "parameters": [ { "$ref": "#/components/parameters/marketSymbol" }, { "$ref": "#/components/parameters/resolution" }, { "$ref": "#/components/parameters/fromDate" }, { "$ref": "#/components/parameters/toDate" } ], "responses": { "200": { "description": "موفق", "content": { "application/json": { "schema": { "type": "object", "properties": { "c": { "type": "array", "description": "آخرین قیمت کندل‌ها" }, "h": { "type": "array", "description": "بالاترین قیمت کندل‌ها" }, "l": { "type": "array", "description": "پایین ترین قیمت کندل‌ها" }, "o": { "type": "array", "description": "اولین قیمت کندل‌ها" }, "s": { "type": "string", "description": "تعیین وضعیت" }, "t": { "type": "array", "description": "زمان شروع کندل‌ها" }, "v": { "type": "array", "description": "حجم معاملات کندل‌ها" } } }, "examples": { "default_example": { "$ref": "#/components/examples/ChartHistoryRes" } } } } } }, "x-codeSamples": [ { "lang": "cURL", "source": "curl --location 'https://publicapi.ramzinex.ir/exchange/api/v1.0/exchange/chart/tv/history?symbol=GOLDIRR&resolution=60&from=1724576847&to=1729760907'" }, { "lang": "PHP", "source": " 'https://publicapi.ramzinex.ir/exchange/api/v1.0/exchange/chart/tv/history?symbol=GOLDIRR&resolution=60&from=1724576847&to=1729760907', CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => '', CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 0, CURLOPT_FOLLOWLOCATION => true, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => 'GET', )); $response = curl_exec($curl); curl_close($curl); echo $response; " }, { "lang": "Python", "source": "import requests url = 'https://publicapi.ramzinex.ir/exchange/api/v1.0/exchange/chart/tv/history?symbol=GOLDIRR&resolution=60&from=1724576847&to=1729760907' headers = {} response = requests.request('GET', url, headers=headers) response.raise_for_status() print(response.json())" }, { "lang": "JavaScript", "source": "const url = \"https://publicapi.ramzinex.ir/exchange/api/v1.0/exchange/chart/tv/history?symbol=GOLDIRR&resolution=60&from=1724576847&to=1729760907\"; const headers = {}; const response = await fetch(url, { method: \"GET\", headers }); if (!response.ok) throw new Error(`HTTP ${response.status}`); console.log(await response.json());" }, { "lang": "C#", "source": "using System.Net.Http; using System.Text; using var client = new HttpClient(); using var request = new HttpRequestMessage(HttpMethod.Get, \"https://publicapi.ramzinex.ir/exchange/api/v1.0/exchange/chart/tv/history?symbol=GOLDIRR&resolution=60&from=1724576847&to=1729760907\"); using var response = await client.SendAsync(request); response.EnsureSuccessStatusCode(); Console.WriteLine(await response.Content.ReadAsStringAsync());" } ] }, "servers": [ { "url": "https://publicapi.ramzinex.ir/exchange/api/v1.0/exchange/" } ] }, "/auth/api_key/getToken": { "post": { "summary": "دریافت توکن خصوصی", "description": "

برای گرفتن API Key ابتدا به بخش مدیریت API مراجعه کنید. بعد از ساخت API Key کلید محرمانه و API Key خود را در HTTP Body Request خود ارسال کنید.

", "operationId": "getTokenId", "tags": [ "احراز هویت" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTokenReq" } } } }, "responses": { "200": { "description": "موفق", "content": { "application/json": { "examples": { "default_example": { "$ref": "#/components/examples/GetTokenRes" } } } } } }, "x-codeSamples": [ { "lang": "cURL", "source": "curl --location 'https://api.ramzinex.ir/exchange/api/v1.0/exchange/auth/api_key/getToken' \ --header 'Content-Type: application/json' \ --data '{ \"secret\": \"****\", \"api_key\": \"****\" }'" }, { "lang": "PHP", "source": " 'https://api.ramzinex.ir/exchange/api/v1.0/exchange/auth/api_key/getToken', CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => '', CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 0, CURLOPT_FOLLOWLOCATION => true, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => 'POST', CURLOPT_POSTFIELDS =>'{ 'secret': '****', 'api_key': '****' }', CURLOPT_HTTPHEADER => array( 'Content-Type: application/json' ), )); $response = curl_exec($curl); curl_close($curl); echo $response; " }, { "lang": "Python", "source": "import requests url = 'https://api.ramzinex.ir/exchange/api/v1.0/exchange/auth/api_key/getToken' headers = { \"Content-Type\": \"application/json\" } payload = { \"secret\": \"****\", \"api_key\": \"****\" } response = requests.request('POST', url, headers=headers, json=payload) response.raise_for_status() print(response.json())" }, { "lang": "JavaScript", "source": "const url = \"https://api.ramzinex.ir/exchange/api/v1.0/exchange/auth/api_key/getToken\"; const headers = { \"Content-Type\": \"application/json\" }; const payload = { \"secret\": \"****\", \"api_key\": \"****\" }; const response = await fetch(url, { method: \"POST\", headers, body: JSON.stringify(payload) }); if (!response.ok) throw new Error(`HTTP ${response.status}`); console.log(await response.json());" }, { "lang": "C#", "source": "using System.Net.Http; using System.Text; using var client = new HttpClient(); using var request = new HttpRequestMessage(HttpMethod.Post, \"https://api.ramzinex.ir/exchange/api/v1.0/exchange/auth/api_key/getToken\"); const string payload = @\"{ \"\"secret\"\": \"\"****\"\", \"\"api_key\"\": \"\"****\"\" }\"; request.Content = new StringContent(payload, Encoding.UTF8, \"application/json\"); using var response = await client.SendAsync(request); response.EnsureSuccessStatusCode(); Console.WriteLine(await response.Content.ReadAsStringAsync());" } ], "servers": [ { "url": "https://api.ramzinex.ir/exchange/api/v1.0/exchange" } ] } }, "/funds/available/currency/{currency_id}": { "get": { "summary": "سرمایه در دسترس کاربر برای یک ارز", "description": "

نکته:

.این درخواست نیازمند ارسال توکن است

", "operationId": "availableCurrencyId", "tags": [ "کیف پول" ], "parameters": [ { "$ref": "#/components/parameters/CurrencyId" } ], "responses": { "200": { "description": "موفق", "content": { "application/json": { "examples": { "default_example": { "$ref": "#/components/examples/AvailableCurrency" } } } } }, "401": { "description": "ارسال توکن اشتباه" } }, "x-codeSamples": [ { "lang": "cURL", "source": "curl --location 'https://api.ramzinex.ir/exchange/api/v1.0/exchange/users/me/funds/available/currency/9' \ --header 'Authorization2: Bearer ****' \ --header 'x-api-key: ****'" }, { "lang": "PHP", "source": " 'https://api.ramzinex.ir/exchange/api/v1.0/exchange/users/me/funds/available/currency/9', CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => '', CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 0, CURLOPT_FOLLOWLOCATION => true, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => 'GET', CURLOPT_HTTPHEADER => array( 'Authorization2: Bearer ****', 'x-api-key: ****', ), )); $response = curl_exec($curl); curl_close($curl); echo $response;" }, { "lang": "Python", "source": "import requests url = 'https://api.ramzinex.ir/exchange/api/v1.0/exchange/users/me/funds/available/currency/9' headers = { \"Authorization2\": \"Bearer ****\", \"x-api-key\": \"****\" } response = requests.request('GET', url, headers=headers) response.raise_for_status() print(response.json())" }, { "lang": "JavaScript", "source": "const url = \"https://api.ramzinex.ir/exchange/api/v1.0/exchange/users/me/funds/available/currency/9\"; const headers = { \"Authorization2\": \"Bearer ****\", \"x-api-key\": \"****\" }; const response = await fetch(url, { method: \"GET\", headers }); if (!response.ok) throw new Error(`HTTP ${response.status}`); console.log(await response.json());" }, { "lang": "C#", "source": "using System.Net.Http; using System.Text; using var client = new HttpClient(); using var request = new HttpRequestMessage(HttpMethod.Get, \"https://api.ramzinex.ir/exchange/api/v1.0/exchange/users/me/funds/available/currency/9\"); request.Headers.TryAddWithoutValidation(\"Authorization2\", \"Bearer ****\"); request.Headers.TryAddWithoutValidation(\"x-api-key\", \"****\"); using var response = await client.SendAsync(request); response.EnsureSuccessStatusCode(); Console.WriteLine(await response.Content.ReadAsStringAsync());" } ], "servers": [ { "url": "https://api.ramzinex.ir/exchange/api/v1.0/exchange/users/me" } ] } }, "/funds/total/currency/{currency_id}": { "get": { "summary": "سرمایه کل کاربر برای یک ارز", "description": "

نکته:

.این درخواست نیازمند ارسال توکن است

" , "operationId": "totalCurrencyId", "tags": [ "کیف پول" ], "parameters": [ { "$ref": "#/components/parameters/CurrencyId" } ], "responses": { "200": { "description": "موفق", "content": { "application/json": { "examples": { "default_example": { "$ref": "#/components/examples/AvailableCurrency" } } } } }, "401": { "description": "ارسال توکن اشتباه" } }, "x-codeSamples": [ { "lang": "cURL", "source": "curl --location 'https://api.ramzinex.ir/exchange/api/v1.0/exchange/users/me/funds/total/currency/9' \ --header 'Authorization2: Bearer ****' \ --header 'x-api-key: ****'" }, { "lang": "PHP", "source": " 'https://api.ramzinex.ir/exchange/api/v1.0/exchange/users/me/total/available/currency/9', CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => '', CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 0, CURLOPT_FOLLOWLOCATION => true, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => 'GET', CURLOPT_HTTPHEADER => array( 'Authorization2: Bearer ****', 'x-api-key: ****', ), )); $response = curl_exec($curl); curl_close($curl); echo $response;" }, { "lang": "Python", "source": "import requests url = 'https://api.ramzinex.ir/exchange/api/v1.0/exchange/users/me/funds/total/currency/9' headers = { \"Authorization2\": \"Bearer ****\", \"x-api-key\": \"****\" } response = requests.request('GET', url, headers=headers) response.raise_for_status() print(response.json())" }, { "lang": "JavaScript", "source": "const url = \"https://api.ramzinex.ir/exchange/api/v1.0/exchange/users/me/funds/total/currency/9\"; const headers = { \"Authorization2\": \"Bearer ****\", \"x-api-key\": \"****\" }; const response = await fetch(url, { method: \"GET\", headers }); if (!response.ok) throw new Error(`HTTP ${response.status}`); console.log(await response.json());" }, { "lang": "C#", "source": "using System.Net.Http; using System.Text; using var client = new HttpClient(); using var request = new HttpRequestMessage(HttpMethod.Get, \"https://api.ramzinex.ir/exchange/api/v1.0/exchange/users/me/funds/total/currency/9\"); request.Headers.TryAddWithoutValidation(\"Authorization2\", \"Bearer ****\"); request.Headers.TryAddWithoutValidation(\"x-api-key\", \"****\"); using var response = await client.SendAsync(request); response.EnsureSuccessStatusCode(); Console.WriteLine(await response.Content.ReadAsStringAsync());" } ], "servers": [ { "url": "https://api.ramzinex.ir/exchange/api/v1.0/exchange/users/me" } ] } }, "/funds/in_orders/currency/{currency_id}": { "get": { "summary": "میزان سرمایه در حال معامله کاربر", "description": "

نکته:

.این درخواست نیازمند ارسال توکن است

", "operationId": "inOrderCurrencyId", "tags": [ "کیف پول" ], "parameters": [ { "$ref": "#/components/parameters/CurrencyId" } ], "responses": { "200": { "description": "موفق", "content": { "application/json": { "examples": { "default_example": { "$ref": "#/components/examples/AvailableCurrency" } } } } }, "401": { "description": "ارسال توکن اشتباه" } }, "x-codeSamples": [ { "lang": "cURL", "source": "curl --location 'https://api.ramzinex.ir/exchange/api/v1.0/exchange/users/me/funds/in_orders/currency/9' \ --header 'Authorization2: Bearer ****' \ --header 'x-api-key: ****'" }, { "lang": "PHP", "source": " 'https://api.ramzinex.ir/exchange/api/v1.0/exchange/users/me/in_orders/available/currency/9', CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => '', CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 0, CURLOPT_FOLLOWLOCATION => true, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => 'GET', CURLOPT_HTTPHEADER => array( 'Authorization2: Bearer ****', 'x-api-key: ****', ), )); $response = curl_exec($curl); curl_close($curl); echo $response;" }, { "lang": "Python", "source": "import requests url = 'https://api.ramzinex.ir/exchange/api/v1.0/exchange/users/me/funds/in_orders/currency/9' headers = { \"Authorization2\": \"Bearer ****\", \"x-api-key\": \"****\" } response = requests.request('GET', url, headers=headers) response.raise_for_status() print(response.json())" }, { "lang": "JavaScript", "source": "const url = \"https://api.ramzinex.ir/exchange/api/v1.0/exchange/users/me/funds/in_orders/currency/9\"; const headers = { \"Authorization2\": \"Bearer ****\", \"x-api-key\": \"****\" }; const response = await fetch(url, { method: \"GET\", headers }); if (!response.ok) throw new Error(`HTTP ${response.status}`); console.log(await response.json());" }, { "lang": "C#", "source": "using System.Net.Http; using System.Text; using var client = new HttpClient(); using var request = new HttpRequestMessage(HttpMethod.Get, \"https://api.ramzinex.ir/exchange/api/v1.0/exchange/users/me/funds/in_orders/currency/9\"); request.Headers.TryAddWithoutValidation(\"Authorization2\", \"Bearer ****\"); request.Headers.TryAddWithoutValidation(\"x-api-key\", \"****\"); using var response = await client.SendAsync(request); response.EnsureSuccessStatusCode(); Console.WriteLine(await response.Content.ReadAsStringAsync());" } ], "servers": [ { "url": "https://api.ramzinex.ir/exchange/api/v1.0/exchange/users/me" } ] } }, "/networks": { "get": { "summary": "شبکه‌های موجود برای واریز و برداشت یک ارز", "description": "برای دریافت لیست شبکه‌های موجود برای واریز یا برداشت از این نوع درخواست استفاده کنید:", "operationId": "networksId", "tags": [ "کیف پول" ], "parameters": [ { "$ref": "#/components/parameters/CurrencyIdQuery" }, { "$ref": "#/components/parameters/WithdrawBooleanQuery" }, { "$ref": "#/components/parameters/DepositBooleanQuery" } ], "responses": { "200": { "description": "موفق", "content": { "application/json": { "examples": { "default_example": { "$ref": "#/components/examples/networksRes" } } } } } }, "x-codeSamples": [ { "lang": "cURL", "source": "curl --location 'https://publicapi.ramzinex.ir/exchange/api/v1.0/exchange/networks?currency_id=46&deposit=1&withdraw=1'" }, { "lang": "PHP", "source": " 'https://publicapi.ramzinex.ir/exchange/api/v1.0/exchange/networks?currency_id=46&deposit=1&withdraw=1', CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => '', CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 0, CURLOPT_FOLLOWLOCATION => true, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => 'GET', CURLOPT_HTTPHEADER => array( ': ' ), )); $response = curl_exec($curl); curl_close($curl); echo $response; " }, { "lang": "Python", "source": "import requests url = 'https://publicapi.ramzinex.ir/exchange/api/v1.0/exchange/networks?currency_id=46&deposit=1&withdraw=1' headers = {} response = requests.request('GET', url, headers=headers) response.raise_for_status() print(response.json())" }, { "lang": "JavaScript", "source": "const url = \"https://publicapi.ramzinex.ir/exchange/api/v1.0/exchange/networks?currency_id=46&deposit=1&withdraw=1\"; const headers = {}; const response = await fetch(url, { method: \"GET\", headers }); if (!response.ok) throw new Error(`HTTP ${response.status}`); console.log(await response.json());" }, { "lang": "C#", "source": "using System.Net.Http; using System.Text; using var client = new HttpClient(); using var request = new HttpRequestMessage(HttpMethod.Get, \"https://publicapi.ramzinex.ir/exchange/api/v1.0/exchange/networks?currency_id=46&deposit=1&withdraw=1\"); using var response = await client.SendAsync(request); response.EnsureSuccessStatusCode(); Console.WriteLine(await response.Content.ReadAsStringAsync());" } ], "servers": [ { "url": "https://publicapi.ramzinex.ir/exchange/api/v1.0/exchange/" } ] } }, "/users/me/addresses": { "get": { "summary": "آدرس‌های کاربر", "description": "

برای دریافت آدرس‌های موجود برای یک ارز از این نوع درخواست استفاده کنید

در صورت ارسال بیش از یک شناسه در networks، فقط اولین مقدار بررسی می‌شود و مقادیر بعدی نادیده گرفته می‌شوند.

نکته:

.این درخواست نیازمند ارسال توکن است

", "operationId": "addressedId", "tags": [ "کیف پول" ], "parameters": [ { "name": "networks[]", "in": "query", "required": true, "description": "شناسهٔ شبکه‌ها. حداقل یک مقدار لازم است؛ فقط اولین مقدار پردازش می‌شود.", "schema": { "type": "array", "items": { "type": "integer" }, "minItems": 1, "example": [116] } } ], "responses": { "200": { "description": "موفق", "content": { "application/json": { "examples": { "example1": { "$ref": "#/components/examples/AddressRes" }, "example2": { "$ref": "#/components/examples/AddressRes2" } } } } }, "401": { "description": "ارسال توکن اشتباه", }, "500": { "description": "ارسال آیدی نتورک اشتباه", } }, "x-codeSamples": [ { "lang": "cURL", "source": "curl --get 'https://api.ramzinex.ir/exchange/api/v1.0/exchange/users/me/addresses' \ --data-urlencode 'networks[]=116' \ --header 'Authorization2: Bearer ****' \ --header 'x-api-key: ****'" }, { "lang": "PHP", "source": " 'https://api.ramzinex.ir/exchange/api/v1.0/exchange/users/me/addresses?networks%5B%5D=116', CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => '', CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 0, CURLOPT_FOLLOWLOCATION => true, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => 'GET', CURLOPT_HTTPHEADER => array( 'Authorization2: Bearer ****', 'x-api-key: ****', ), )); $response = curl_exec($curl); curl_close($curl); echo $response; " }, { "lang": "Python", "source": "import requests url = 'https://api.ramzinex.ir/exchange/api/v1.0/exchange/users/me/addresses' headers = { \"Authorization2\": \"Bearer ****\", \"x-api-key\": \"****\" } response = requests.request('POST', url, headers=headers) response.raise_for_status() print(response.json())" }, { "lang": "JavaScript", "source": "const url = \"https://api.ramzinex.ir/exchange/api/v1.0/exchange/users/me/addresses\"; const headers = { \"Authorization2\": \"Bearer ****\", \"x-api-key\": \"****\" }; const response = await fetch(url, { method: \"POST\", headers }); if (!response.ok) throw new Error(`HTTP ${response.status}`); console.log(await response.json());" }, { "lang": "C#", "source": "using System.Net.Http; using System.Text; using var client = new HttpClient(); using var request = new HttpRequestMessage(HttpMethod.Post, \"https://api.ramzinex.ir/exchange/api/v1.0/exchange/users/me/addresses\"); request.Headers.TryAddWithoutValidation(\"Authorization2\", \"Bearer ****\"); request.Headers.TryAddWithoutValidation(\"x-api-key\", \"****\"); using var response = await client.SendAsync(request); response.EnsureSuccessStatusCode(); Console.WriteLine(await response.Content.ReadAsStringAsync());" } ], "servers": [ { "url": "https://api.ramzinex.ir/exchange/api/v1.0/exchange/" } ] } }, "/users/me/funds/summaryDesktop": { "get": { "summary": "دارایی", "description": "

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

نکته:

.این درخواست نیازمند ارسال توکن است

", "operationId": "summaryDesktop", "tags": [ "کیف پول" ], "responses": { "200": { "description": "موفق", "content": { "application/json": { "examples": { "default_example": { "$ref": "#/components/examples/summaryDesktopRes" } } } } } }, "x-codeSamples": [ { "lang": "cURL", "source": "curl --location 'https://api.ramzinex.ir/exchange/api/v1.0/exchange/users/me/funds/summaryDesktop' \ --header 'Authorization2: Bearer ****' \ --header 'x-api-key: ****'" }, { "lang": "PHP", "source": " 'https://api.ramzinex.ir/exchange/api/v1.0/exchange/users/me/funds/summaryDesktop', CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => '', CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 0, CURLOPT_FOLLOWLOCATION => true, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => 'GET', CURLOPT_HTTPHEADER => array( 'Authorization2: Bearer ****', 'x-api-key: ****', ), )); $response = curl_exec($curl); curl_close($curl); echo $response; " }, { "lang": "Python", "source": "import requests url = 'https://api.ramzinex.ir/exchange/api/v1.0/exchange/users/me/funds/summaryDesktop' headers = { \"Authorization2\": \"Bearer ****\", \"x-api-key\": \"****\" } response = requests.request('GET', url, headers=headers) response.raise_for_status() print(response.json())" }, { "lang": "JavaScript", "source": "const url = \"https://api.ramzinex.ir/exchange/api/v1.0/exchange/users/me/funds/summaryDesktop\"; const headers = { \"Authorization2\": \"Bearer ****\", \"x-api-key\": \"****\" }; const response = await fetch(url, { method: \"GET\", headers }); if (!response.ok) throw new Error(`HTTP ${response.status}`); console.log(await response.json());" }, { "lang": "C#", "source": "using System.Net.Http; using System.Text; using var client = new HttpClient(); using var request = new HttpRequestMessage(HttpMethod.Get, \"https://api.ramzinex.ir/exchange/api/v1.0/exchange/users/me/funds/summaryDesktop\"); request.Headers.TryAddWithoutValidation(\"Authorization2\", \"Bearer ****\"); request.Headers.TryAddWithoutValidation(\"x-api-key\", \"****\"); using var response = await client.SendAsync(request); response.EnsureSuccessStatusCode(); Console.WriteLine(await response.Content.ReadAsStringAsync());" } ], "servers": [ { "url": "https://api.ramzinex.ir/exchange/api/v1.0/exchange/" } ] } }, "/users/me/funds/refresh": { "post": { "summary": "بروز رسانی کیف پول", "description": "

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

نکته:

.این درخواست نیازمند ارسال توکن است

", "operationId": "refreshId", "tags": [ "کیف پول" ], "responses": { "200": { "description": "موفق", "content": { "application/json": { "examples": { "default_example": { "$ref": "#/components/examples/RefreshFundsRes" } } } } }, "401": { "description": "ارسال توکن اشتباه", } }, "x-codeSamples": [ { "lang": "cURL", "source": "curl --location --request POST 'https://api.ramzinex.ir/exchange/api/v1.0/exchange/users/me/funds/refresh' \ --header 'Authorization2: Bearer ****' \ --header 'x-api-key: ****'" }, { "lang": "PHP", "source": " 'https://api.ramzinex.ir/exchange/api/v1.0/exchange/users/me/funds/refresh', CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => '', CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 0, CURLOPT_FOLLOWLOCATION => true, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => 'POST', CURLOPT_HTTPHEADER => array( 'Authorization2: Bearer ****', 'x-api-key: ****', ), )); $response = curl_exec($curl); curl_close($curl); echo $response; " }, { "lang": "Python", "source": "import requests url = 'https://api.ramzinex.ir/exchange/api/v1.0/exchange/users/me/funds/refresh' headers = { \"Authorization2\": \"Bearer ****\", \"x-api-key\": \"****\" } response = requests.request('POST', url, headers=headers) response.raise_for_status() print(response.json())" }, { "lang": "JavaScript", "source": "const url = \"https://api.ramzinex.ir/exchange/api/v1.0/exchange/users/me/funds/refresh\"; const headers = { \"Authorization2\": \"Bearer ****\", \"x-api-key\": \"****\" }; const response = await fetch(url, { method: \"POST\", headers }); if (!response.ok) throw new Error(`HTTP ${response.status}`); console.log(await response.json());" }, { "lang": "C#", "source": "using System.Net.Http; using System.Text; using var client = new HttpClient(); using var request = new HttpRequestMessage(HttpMethod.Post, \"https://api.ramzinex.ir/exchange/api/v1.0/exchange/users/me/funds/refresh\"); request.Headers.TryAddWithoutValidation(\"Authorization2\", \"Bearer ****\"); request.Headers.TryAddWithoutValidation(\"x-api-key\", \"****\"); using var response = await client.SendAsync(request); response.EnsureSuccessStatusCode(); Console.WriteLine(await response.Content.ReadAsStringAsync());" } ], "servers": [ { "url": "https://api.ramzinex.ir/exchange/api/v1.0/exchange/" } ] } }, "/users/me/create_address": { "post": { "summary": "تخصیص آدرس به کیف پول کاربر", "description": "

برای تخصیص آدرس ارز برای کاربر از این درخواست استفاده کنید

نکته:

.این درخواست نیازمند ارسال توکن است

", "operationId": "createAddressId", "tags": [ "کیف پول" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateNetworkReq" }, "examples": { "default_example": { "$ref": "#/components/examples/CreateAddressEx" } } } } }, "responses": { "200": { "description": "موفق", "content": { "application/json": { "examples": { "example1": { "$ref": "#/components/examples/CreateAddressRes" }, "example2": { "$ref": "#/components/examples/RepeatedAddressRes" } } } } }, "422": { "description": "ارسال ناقص بدنه‌ی درخواست", "content": { "application/json": { "examples": { "default_example": { "$ref": "#/components/examples/WrongCreateNetworkRes" } } } } }, "401": { "description": "ارسال توکن اشتباه", } }, "x-codeSamples": [ { "lang": "cURL", "source": "curl --location --request POST 'https://api.ramzinex.ir/exchange/api/v1.0/exchange/users/me/funds/refresh' \ --header 'Authorization2: Bearer ****' \ --header 'x-api-key: ****'" }, { "lang": "PHP", "source": " 'https://api.ramzinex.ir/exchange/api/v1.0/exchange/users/me/funds/refresh', CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => '', CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 0, CURLOPT_FOLLOWLOCATION => true, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => 'POST', CURLOPT_HTTPHEADER => array( 'Authorization2: Bearer ****', 'x-api-key: ****', ), )); $response = curl_exec($curl); curl_close($curl); echo $response; " }, { "lang": "Python", "source": "import requests url = 'https://api.ramzinex.ir/exchange/api/v1.0/exchange/users/me/funds/refresh' headers = { \"Authorization2\": \"Bearer ****\", \"x-api-key\": \"****\" } response = requests.request('POST', url, headers=headers) response.raise_for_status() print(response.json())" }, { "lang": "JavaScript", "source": "const url = \"https://api.ramzinex.ir/exchange/api/v1.0/exchange/users/me/funds/refresh\"; const headers = { \"Authorization2\": \"Bearer ****\", \"x-api-key\": \"****\" }; const response = await fetch(url, { method: \"POST\", headers }); if (!response.ok) throw new Error(`HTTP ${response.status}`); console.log(await response.json());" }, { "lang": "C#", "source": "using System.Net.Http; using System.Text; using var client = new HttpClient(); using var request = new HttpRequestMessage(HttpMethod.Post, \"https://api.ramzinex.ir/exchange/api/v1.0/exchange/users/me/funds/refresh\"); request.Headers.TryAddWithoutValidation(\"Authorization2\", \"Bearer ****\"); request.Headers.TryAddWithoutValidation(\"x-api-key\", \"****\"); using var response = await client.SendAsync(request); response.EnsureSuccessStatusCode(); Console.WriteLine(await response.Content.ReadAsStringAsync());" } ], "servers": [ { "url": "https://api.ramzinex.ir/exchange/api/v1.0/exchange/" } ] } }, "/users/me/funds/deposits": { "get": { "summary": "مشاهده واریزهای کاربر برای ارزهای مشخص شده", "description": "

مشخصات واریزهای انجام شده کاربر برای ارزهای مشخص

نکته:

.این درخواست نیازمند ارسال توکن است

", "operationId": "depositsId", "tags": [ "واریزها و برداشت‌ها" ], "parameters": [ { "name": "currency_type", "in": "query", "schema": { "type": "string", "enum": ["rial", "cryptocurrency"] } }, { "name": "currencies[]", "in": "query", "schema": { "type": "array", "items": { "type": "integer" }, "example": [2, 9, 46] } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "maximum": 50, "example": 3 } }, { "name": "offset", "in": "query", "schema": { "type": "integer", "example": 1 } }, { "name": "created_at_from", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "created_at_to", "in": "query", "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "موفق", "content": { "application/json": { "examples": { "default_example": { "$ref": "#/components/examples/DepositListRes" }, } } } }, "401": { "description": "ارسال توکن اشتباه", } }, "x-codeSamples": [ { "lang": "cURL", "source": "curl --get 'https://api.ramzinex.ir/exchange/api/v1.0/exchange/users/me/funds/deposits' \ --data-urlencode 'limit=3' \ --data-urlencode 'offset=1' \ --data-urlencode 'currencies[]=2' \ --data-urlencode 'currencies[]=9' \ --data-urlencode 'currencies[]=46' \ --header 'Authorization2: Bearer ****' \ --header 'x-api-key: ****'" }, { "lang": "PHP", "source": " 'https://api.ramzinex.ir/exchange/api/v1.0/exchange/users/me/funds/deposits?limit=3&offset=1¤cies%5B%5D=2¤cies%5B%5D=9¤cies%5B%5D=46', CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => '', CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 0, CURLOPT_FOLLOWLOCATION => true, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => 'GET', CURLOPT_HTTPHEADER => array( 'Authorization2: Bearer ****', 'x-api-key: ****', ), )); $response = curl_exec($curl); curl_close($curl); echo $response; " }, { "lang": "Python", "source": "import requests url = 'https://api.ramzinex.ir/exchange/api/v1.0/exchange/users/me/funds/deposits' headers = { \"Authorization2\": \"Bearer ****\", \"x-api-key\": \"****\" } response = requests.request('POST', url, headers=headers) response.raise_for_status() print(response.json())" }, { "lang": "JavaScript", "source": "const url = \"https://api.ramzinex.ir/exchange/api/v1.0/exchange/users/me/funds/deposits\"; const headers = { \"Authorization2\": \"Bearer ****\", \"x-api-key\": \"****\" }; const response = await fetch(url, { method: \"POST\", headers }); if (!response.ok) throw new Error(`HTTP ${response.status}`); console.log(await response.json());" }, { "lang": "C#", "source": "using System.Net.Http; using System.Text; using var client = new HttpClient(); using var request = new HttpRequestMessage(HttpMethod.Post, \"https://api.ramzinex.ir/exchange/api/v1.0/exchange/users/me/funds/deposits\"); request.Headers.TryAddWithoutValidation(\"Authorization2\", \"Bearer ****\"); request.Headers.TryAddWithoutValidation(\"x-api-key\", \"****\"); using var response = await client.SendAsync(request); response.EnsureSuccessStatusCode(); Console.WriteLine(await response.Content.ReadAsStringAsync());" } ], "servers": [ { "url": "https://api.ramzinex.ir/exchange/api/v1.0/exchange/" } ] } }, "/users/me/funds/deposits/{deposit_id}": { "get": { "summary": "مشخصات یک واریز مشخص", "description": "

نکته:

.این درخواست نیازمند ارسال توکن است

", "operationId": "specialDepositId", "tags": [ "واریزها و برداشت‌ها" ], "parameters": [ { "$ref": "#/components/parameters/DepositQuery" } ], "responses": { "200": { "description": "موفق", "content": { "application/json": { "examples": { "default_example": { "$ref": "#/components/examples/SpecialDepositRes" } } } } }, "401": { "description": "موفق", } }, "x-codeSamples": [ { "lang": "cURL", "source": "curl --location 'https://api.ramzinex.ir/exchange/api/v1.0/exchange/users/me/funds/deposits/10412179' \ --header 'Authorization2: Bearer ****' \ --header 'x-api-key: ****'" }, { "lang": "PHP", "source": " 'https://api.ramzinex.ir/exchange/api/v1.0/exchange/users/me/funds/deposits/10412179', CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => '', CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 0, CURLOPT_FOLLOWLOCATION => true, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => 'GET', CURLOPT_HTTPHEADER => array( 'Authorization2: Bearer ****', 'x-api-key: ****', ), )); $response = curl_exec($curl); curl_close($curl); echo $response; " }, { "lang": "Python", "source": "import requests url = 'https://api.ramzinex.ir/exchange/api/v1.0/exchange/users/me/funds/deposits/10412179' headers = { \"Authorization2\": \"Bearer ****\", \"x-api-key\": \"****\" } response = requests.request('GET', url, headers=headers) response.raise_for_status() print(response.json())" }, { "lang": "JavaScript", "source": "const url = \"https://api.ramzinex.ir/exchange/api/v1.0/exchange/users/me/funds/deposits/10412179\"; const headers = { \"Authorization2\": \"Bearer ****\", \"x-api-key\": \"****\" }; const response = await fetch(url, { method: \"GET\", headers }); if (!response.ok) throw new Error(`HTTP ${response.status}`); console.log(await response.json());" }, { "lang": "C#", "source": "using System.Net.Http; using System.Text; using var client = new HttpClient(); using var request = new HttpRequestMessage(HttpMethod.Get, \"https://api.ramzinex.ir/exchange/api/v1.0/exchange/users/me/funds/deposits/10412179\"); request.Headers.TryAddWithoutValidation(\"Authorization2\", \"Bearer ****\"); request.Headers.TryAddWithoutValidation(\"x-api-key\", \"****\"); using var response = await client.SendAsync(request); response.EnsureSuccessStatusCode(); Console.WriteLine(await response.Content.ReadAsStringAsync());" } ], "servers": [ { "url": "https://api.ramzinex.ir/exchange/api/v1.0/exchange/" } ] } }, "/users/me/funds/withdraws": { "get": { "summary": "مشخصات برداشت‌ها", "description": "

برای دریافت مشخصات برداشت‌های یک ارز کاربر از این درخواست استفاده کنید

نکته:

.این درخواست نیازمند ارسال توکن است

", "operationId": "withdrawsId", "tags": [ "واریزها و برداشت‌ها" ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CurrencyWithdrawsReq" }, "examples": { "default_example": { "$ref": "#/components/examples/WithdrawListReq" } } } } }, "responses": { "200": { "description": "موفق", "content": { "application/json": { "examples": { "default_example": { "$ref": "#/components/examples/WithdrawListRes" }, } } } }, "401": { "description": "ارسال توکن اشتباه", } }, "x-codeSamples": [ { "lang": "cURL", "source": "curl --location --request GET 'https://api.ramzinex.ir/exchange/api/v1.0/exchange/users/me/funds/withdraws' \ --header 'Content-Type: application/json' \ --header 'Authorization2: Bearer ****' \ --header 'x-api-key: ****' \ --data '{ \"currency_id\" : 6 }'" }, { "lang": "PHP", "source": " 'https://api.ramzinex.ir/exchange/api/v1.0/exchange/users/me/funds/withdraws',\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => '',\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 0,\n CURLOPT_FOLLOWLOCATION => true,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => 'GET',\n CURLOPT_POSTFIELDS => '{\"currency_id\": 6}',\n CURLOPT_HTTPHEADER => array(\n 'Content-Type: application/json',\n 'Authorization2: Bearer ****', \n 'x-api-key: ****',\n ),\n ));\n\n $response = curl_exec($curl);\n\n curl_close($curl);\n echo $response;\n " }, { "lang": "Python", "source": "import requests url = 'https://api.ramzinex.ir/exchange/api/v1.0/exchange/users/me/funds/withdraws' headers = { \"Content-Type\": \"application/json\", \"Authorization2\": \"Bearer ****\", \"x-api-key\": \"****\" } payload = { \"currency_id\": 6 } response = requests.request('GET', url, headers=headers, json=payload) response.raise_for_status() print(response.json())" }, { "lang": "JavaScript", "source": "const url = \"https://api.ramzinex.ir/exchange/api/v1.0/exchange/users/me/funds/withdraws\"; const headers = { \"Content-Type\": \"application/json\", \"Authorization2\": \"Bearer ****\", \"x-api-key\": \"****\" }; const payload = { \"currency_id\": 6 }; const response = await fetch(url, { method: \"GET\", headers, body: JSON.stringify(payload) }); if (!response.ok) throw new Error(`HTTP ${response.status}`); console.log(await response.json());" }, { "lang": "C#", "source": "using System.Net.Http; using System.Text; using var client = new HttpClient(); using var request = new HttpRequestMessage(HttpMethod.Get, \"https://api.ramzinex.ir/exchange/api/v1.0/exchange/users/me/funds/withdraws\"); request.Headers.TryAddWithoutValidation(\"Authorization2\", \"Bearer ****\"); request.Headers.TryAddWithoutValidation(\"x-api-key\", \"****\"); const string payload = @\"{ \"\"currency_id\"\": 6 }\"; request.Content = new StringContent(payload, Encoding.UTF8, \"application/json\"); using var response = await client.SendAsync(request); response.EnsureSuccessStatusCode(); Console.WriteLine(await response.Content.ReadAsStringAsync());" } ], "servers": [ { "url": "https://api.ramzinex.ir/exchange/api/v1.0/exchange/" } ] } }, "/users/me/funds/withdraws/currency/{currency_id}": { "post": { "summary": "درخواست برداشت ارز", "description": "

درخواست برداشت ارز به یک آدرس مشخص

نکته:

.این درخواست نیازمند ارسال توکن است

", "operationId": "withdrawRequestId", "tags": [ "واریزها و برداشت‌ها" ], "parameters": [ { "$ref": "#/components/parameters/CurrencyId" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WithdrawRequestReq" }, "examples": { "default_example": { "$ref": "#/components/examples/WithdrawReqReq" } } } } }, "responses": { "200": { "description": "موفق", "content": { "application/json": { "examples": { "example1": { "$ref": "#/components/examples/WithdrawCreateRes" }, "example2": { "$ref": "#/components/examples/WithdrawRequestErrorRes" } } } } }, "401": { "description": "ارسال توکن اشتباه", } }, "x-codeSamples": [ { "lang": "cURL", "source": "curl --location 'https://api.ramzinex.ir/exchange/api/v1.0/exchange/users/me/funds/withdraws/currency/166' \ --header 'Content-Type: application/json' \ --header 'Authorization2: Bearer ****' \ --header 'x-api-key: ****' \ --data '{ \"amount\": 0.5, \"address\": '0x484E993a8B4b731E8e1801777722109f3953b6bF', \"network_id\": 303, \"currency_id\": 166, \"tag\": '1234', \"no_tag\": false }'" }, { "lang": "PHP", "source": " 'https://api.ramzinex.ir/exchange/api/v1.0/exchange/users/me/funds/withdraws/currency/166',\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => '',\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 0,\n CURLOPT_FOLLOWLOCATION => true,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => 'POST',\n CURLOPT_POSTFIELDS => '{\n \"amount\": 0.5,\n \"address\": \"0x484E993a8B4b731E8e1801777722109f3953b6bF\",\n \"network_id\": 303,\n \"currency_id\": 166,\n \"tag\": \"1234\",\n \"no_tag\": false\n }',\n CURLOPT_HTTPHEADER => array(\n 'Content-Type: application/json',\n 'Authorization2: Bearer ****', \n 'x-api-key: ****',\n ),\n ));\n $response = curl_exec($curl);\n curl_close($curl);\n echo $response;\n " }, { "lang": "Python", "source": "import requests url = 'https://api.ramzinex.ir/exchange/api/v1.0/exchange/users/me/funds/withdraws/currency/166' headers = { \"Content-Type\": \"application/json\", \"Authorization2\": \"Bearer ****\", \"x-api-key\": \"****\" } payload = { \"amount\": 0.5, \"address\": \"0x484E993a8B4b731E8e1801777722109f3953b6bF\", \"network_id\": 303, \"currency_id\": 166, \"tag\": \"1234\", \"no_tag\": false } response = requests.request('POST', url, headers=headers, json=payload) response.raise_for_status() print(response.json())" }, { "lang": "JavaScript", "source": "const url = \"https://api.ramzinex.ir/exchange/api/v1.0/exchange/users/me/funds/withdraws/currency/166\"; const headers = { \"Content-Type\": \"application/json\", \"Authorization2\": \"Bearer ****\", \"x-api-key\": \"****\" }; const payload = { \"amount\": 0.5, \"address\": \"0x484E993a8B4b731E8e1801777722109f3953b6bF\", \"network_id\": 303, \"currency_id\": 166, \"tag\": \"1234\", \"no_tag\": false }; const response = await fetch(url, { method: \"POST\", headers, body: JSON.stringify(payload) }); if (!response.ok) throw new Error(`HTTP ${response.status}`); console.log(await response.json());" }, { "lang": "C#", "source": "using System.Net.Http; using System.Text; using var client = new HttpClient(); using var request = new HttpRequestMessage(HttpMethod.Post, \"https://api.ramzinex.ir/exchange/api/v1.0/exchange/users/me/funds/withdraws/currency/166\"); request.Headers.TryAddWithoutValidation(\"Authorization2\", \"Bearer ****\"); request.Headers.TryAddWithoutValidation(\"x-api-key\", \"****\"); const string payload = @\"{ \"\"amount\"\": 0.5, \"\"address\"\": \"\"0x484E993a8B4b731E8e1801777722109f3953b6bF\"\", \"\"network_id\"\": 303, \"\"currency_id\"\": 166, \"\"tag\"\": \"\"1234\"\", \"\"no_tag\"\": false }\"; request.Content = new StringContent(payload, Encoding.UTF8, \"application/json\"); using var response = await client.SendAsync(request); response.EnsureSuccessStatusCode(); Console.WriteLine(await response.Content.ReadAsStringAsync());" } ], "servers": [ { "url": "https://api.ramzinex.ir/exchange/api/v1.0/exchange/" } ] } }, "/users/me/funds/withdraws/{withdraw_id}/verify": { "post": { "summary": "تایید یک برداشت", "description": "

برای تایید یک برداشت، کد ارسال شده در پیامک و کد Google Authenticator (در صورت فعالسازی) را به این درخواست ارسال کنید.

نکته:

.این درخواست نیازمند ارسال توکن است

", "operationId": "VerifyWithdrawId", "tags": [ "واریزها و برداشت‌ها" ], "parameters": [ { "$ref": "#/components/parameters/WithdrawId" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VerifyWithdrawReq" }, "examples": { "default_example": { "$ref": "#/components/examples/VerifyWithdrawEx" } } } } }, "responses": { "200": { "description": "موفق", "content": { "application/json": { "examples": { "example1": { "$ref": "#/components/examples/VerifyWithdrawRes" }, "example2": { "$ref": "#/components/examples/VerifyWithdrawErrorRes" } } } } }, "401": { "description": "ارسال توکن اشتباه", } }, "x-codeSamples": [ { "lang": "cURL", "source": "curl --location --globoff 'https://api.ramzinex.ir/exchange/api/v1.0/exchange/users/me/funds/withdraws/{{withdraw_id}}/verify' \ --header 'Content-Type: application/json' \ --header 'Authorization2: Bearer ****' \ --header 'x-api-key: ****' \ --data '{ \"code\" : \"557018\", \"gaCode\" : \"394570\" }'" }, { "lang": "PHP", "source": " 'https://api.ramzinex.ir/exchange/api/v1.0/exchange/users/me/funds/withdraws/{{withdraw_id}}/verify', CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => '', CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 0, CURLOPT_FOLLOWLOCATION => true, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => 'POST', CURLOPT_POSTFIELDS =>'{ 'code' : '557018', 'gaCode' : '394570' }', CURLOPT_HTTPHEADER => array( 'Content-Type: application/json', 'Authorization2: Bearer ****', 'x-api-key: ****', ), )); $response = curl_exec($curl); curl_close($curl); echo $response; " }, { "lang": "Python", "source": "import requests url = 'https://api.ramzinex.ir/exchange/api/v1.0/exchange/users/me/funds/withdraws/{{withdraw_id}}/verify' headers = { \"Content-Type\": \"application/json\", \"Authorization2\": \"Bearer ****\", \"x-api-key\": \"****\" } payload = { \"code\": \"557018\", \"gaCode\": \"394570\" } response = requests.request('POST', url, headers=headers, json=payload) response.raise_for_status() print(response.json())" }, { "lang": "JavaScript", "source": "const url = \"https://api.ramzinex.ir/exchange/api/v1.0/exchange/users/me/funds/withdraws/{{withdraw_id}}/verify\"; const headers = { \"Content-Type\": \"application/json\", \"Authorization2\": \"Bearer ****\", \"x-api-key\": \"****\" }; const payload = { \"code\": \"557018\", \"gaCode\": \"394570\" }; const response = await fetch(url, { method: \"POST\", headers, body: JSON.stringify(payload) }); if (!response.ok) throw new Error(`HTTP ${response.status}`); console.log(await response.json());" }, { "lang": "C#", "source": "using System.Net.Http; using System.Text; using var client = new HttpClient(); using var request = new HttpRequestMessage(HttpMethod.Post, \"https://api.ramzinex.ir/exchange/api/v1.0/exchange/users/me/funds/withdraws/{{withdraw_id}}/verify\"); request.Headers.TryAddWithoutValidation(\"Authorization2\", \"Bearer ****\"); request.Headers.TryAddWithoutValidation(\"x-api-key\", \"****\"); const string payload = @\"{ \"\"code\"\": \"\"557018\"\", \"\"gaCode\"\": \"\"394570\"\" }\"; request.Content = new StringContent(payload, Encoding.UTF8, \"application/json\"); using var response = await client.SendAsync(request); response.EnsureSuccessStatusCode(); Console.WriteLine(await response.Content.ReadAsStringAsync());" } ], "servers": [ { "url": "https://api.ramzinex.ir/exchange/api/v1.0/exchange/" } ] } }, "/users/me/funds/withdraws/{withdraw_id}/cancel": { "post": { "summary": "لغو یک برداشت", "description": "

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

در نظر داشته باشید که هنگام ثبت یک برداشت موجودی از حساب شما کم می‌شود و تا قبل زمان لغو یک برداشت این موجودی به حساب شما بر نمی‌گردد.

نکته:

.این درخواست نیازمند ارسال توکن است

", "operationId": "CancelWithdrawId", "tags": [ "واریزها و برداشت‌ها" ], "parameters": [ { "$ref": "#/components/parameters/WithdrawId" } ], "responses": { "200": { "description": "موفق", "content": { "application/json": { "examples": { "example1": { "$ref": "#/components/examples/CancelWithdrawEx3" }, "example2": { "$ref": "#/components/examples/CancelWithdrawEx1" }, "example3": { "$ref": "#/components/examples/CancelWithdrawEx2" }, } } } }, "401": { "description": "ارسال توکن اشتباه", } }, "x-codeSamples": [ { "lang": "cURL", "source": "curl --location --request POST 'https://api.ramzinex.ir/exchange/api/v1.0/exchange/users/me/funds/withdraws/8849988/cancel' \ --header 'Authorization2: Bearer ****' \ --header 'x-api-key: ****' \ --data ''" }, { "lang": "PHP", "source": " 'https://api.ramzinex.ir/exchange/api/v1.0/exchange/users/me/funds/withdraws/8849988/cancel', CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => '', CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 0, CURLOPT_FOLLOWLOCATION => true, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => 'POST', CURLOPT_HTTPHEADER => array( 'Authorization2: Bearer ****', 'x-api-key: ****', ), )); $response = curl_exec($curl); curl_close($curl); echo $response; " }, { "lang": "Python", "source": "import requests url = 'https://api.ramzinex.ir/exchange/api/v1.0/exchange/users/me/funds/withdraws/8849988/cancel' headers = { \"Authorization2\": \"Bearer ****\", \"x-api-key\": \"****\" } response = requests.request('POST', url, headers=headers) response.raise_for_status() print(response.json())" }, { "lang": "JavaScript", "source": "const url = \"https://api.ramzinex.ir/exchange/api/v1.0/exchange/users/me/funds/withdraws/8849988/cancel\"; const headers = { \"Authorization2\": \"Bearer ****\", \"x-api-key\": \"****\" }; const response = await fetch(url, { method: \"POST\", headers }); if (!response.ok) throw new Error(`HTTP ${response.status}`); console.log(await response.json());" }, { "lang": "C#", "source": "using System.Net.Http; using System.Text; using var client = new HttpClient(); using var request = new HttpRequestMessage(HttpMethod.Post, \"https://api.ramzinex.ir/exchange/api/v1.0/exchange/users/me/funds/withdraws/8849988/cancel\"); request.Headers.TryAddWithoutValidation(\"Authorization2\", \"Bearer ****\"); request.Headers.TryAddWithoutValidation(\"x-api-key\", \"****\"); using var response = await client.SendAsync(request); response.EnsureSuccessStatusCode(); Console.WriteLine(await response.Content.ReadAsStringAsync());" } ], "servers": [ { "url": "https://api.ramzinex.ir/exchange/api/v1.0/exchange/" } ] } }, "/users/me/funds/deposits/refresh/currency/{currency_id}": { "post": { "summary": "به‌روز رسانی واریزها", "description": "

به‌روز رسانی واریزهای یک ارز کاربر

نکته:

.این درخواست نیازمند ارسال توکن است

", "operationId": "RefreshDepositId", "tags": [ "واریزها و برداشت‌ها" ], "parameters": [ { "$ref": "#/components/parameters/CurrencyId" } ], "responses": { "200": { "description": "موفق", "content": { "application/json": { "examples": { "default_example": { "$ref": "#/components/examples/updateDepositsEx" } } } } }, "401": { "description": "ارسال توکن اشتباه", } }, "x-codeSamples": [ { "lang": "cURL", "source": "curl --location --request POST 'https://api.ramzinex.ir/exchange/api/v1.0/exchange/users/me/funds/deposits/refresh/currency/11' \ --header 'Authorization2: Bearer ****' \ --header 'x-api-key: ****'" }, { "lang": "PHP", "source": " 'https://api.ramzinex.ir/exchange/api/v1.0/exchange/users/me/funds/deposits/refresh/currency/11', CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => '', CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 0, CURLOPT_FOLLOWLOCATION => true, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => 'POST', CURLOPT_HTTPHEADER => array( 'Authorization2: Bearer ****', 'x-api-key: ****', ), )); $response = curl_exec($curl); curl_close($curl); echo $response; " }, { "lang": "Python", "source": "import requests url = 'https://api.ramzinex.ir/exchange/api/v1.0/exchange/users/me/funds/deposits/refresh/currency/11' headers = { \"Authorization2\": \"Bearer ****\", \"x-api-key\": \"****\" } response = requests.request('POST', url, headers=headers) response.raise_for_status() print(response.json())" }, { "lang": "JavaScript", "source": "const url = \"https://api.ramzinex.ir/exchange/api/v1.0/exchange/users/me/funds/deposits/refresh/currency/11\"; const headers = { \"Authorization2\": \"Bearer ****\", \"x-api-key\": \"****\" }; const response = await fetch(url, { method: \"POST\", headers }); if (!response.ok) throw new Error(`HTTP ${response.status}`); console.log(await response.json());" }, { "lang": "C#", "source": "using System.Net.Http; using System.Text; using var client = new HttpClient(); using var request = new HttpRequestMessage(HttpMethod.Post, \"https://api.ramzinex.ir/exchange/api/v1.0/exchange/users/me/funds/deposits/refresh/currency/11\"); request.Headers.TryAddWithoutValidation(\"Authorization2\", \"Bearer ****\"); request.Headers.TryAddWithoutValidation(\"x-api-key\", \"****\"); using var response = await client.SendAsync(request); response.EnsureSuccessStatusCode(); Console.WriteLine(await response.Content.ReadAsStringAsync());" } ], "servers": [ { "url": "https://api.ramzinex.ir/exchange/api/v1.0/exchange/" } ] } }, "/users/me/funds/bonuses": { "post": { "summary": "جزئیات ریزپاداش‌های کاربر", "description": "

جمع تمام پاداش‌های دریافتی به تفکیک ارز

نکته:

.این درخواست نیازمند ارسال توکن است

", "operationId": "BonusesId", "tags": [ "کارمزد‌ها و پاداش‌ها" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BonusesReq" } } } }, "responses": { "200": { "description": "موفق", "content": { "application/json": { "examples": { "default_example": { "$ref": "#/components/examples/BonusesRes" } } } } }, "401": { "description": "ارسال توکن اشتباه", } }, "x-codeSamples": [ { "lang": "cURL", "source": "curl --location --request POST 'https://api.ramzinex.ir/exchange/api/v1.0/exchange/users/me/funds/bonuses' \ --header 'Authorization2: Bearer ****' \ --header 'x-api-key: ****'" }, { "lang": "PHP", "source": " 'https://api.ramzinex.ir/exchange/api/v1.0/exchange/users/me/funds/bonuses', CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => '', CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 0, CURLOPT_FOLLOWLOCATION => true, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => 'POST', CURLOPT_HTTPHEADER => array( 'Authorization2: Bearer ****', 'x-api-key: ****', ), )); $response = curl_exec($curl); curl_close($curl); echo $response; " }, { "lang": "Python", "source": "import requests url = 'https://api.ramzinex.ir/exchange/api/v1.0/exchange/users/me/funds/bonuses' headers = { \"Authorization2\": \"Bearer ****\", \"x-api-key\": \"****\" } response = requests.request('POST', url, headers=headers) response.raise_for_status() print(response.json())" }, { "lang": "JavaScript", "source": "const url = \"https://api.ramzinex.ir/exchange/api/v1.0/exchange/users/me/funds/bonuses\"; const headers = { \"Authorization2\": \"Bearer ****\", \"x-api-key\": \"****\" }; const response = await fetch(url, { method: \"POST\", headers }); if (!response.ok) throw new Error(`HTTP ${response.status}`); console.log(await response.json());" }, { "lang": "C#", "source": "using System.Net.Http; using System.Text; using var client = new HttpClient(); using var request = new HttpRequestMessage(HttpMethod.Post, \"https://api.ramzinex.ir/exchange/api/v1.0/exchange/users/me/funds/bonuses\"); request.Headers.TryAddWithoutValidation(\"Authorization2\", \"Bearer ****\"); request.Headers.TryAddWithoutValidation(\"x-api-key\", \"****\"); using var response = await client.SendAsync(request); response.EnsureSuccessStatusCode(); Console.WriteLine(await response.Content.ReadAsStringAsync());" } ], "servers": [ { "url": "https://api.ramzinex.ir/exchange/api/v1.0/exchange/" } ] } }, "/user/fee": { "get": { "summary": "کمیسیون کاربر در بازارهای مختلف", "description": "

نکته:

.این درخواست نیازمند ارسال توکن است

", "operationId": "feeId", "tags": [ "کارمزد‌ها و پاداش‌ها" ], "responses": { "200": { "description": "موفق", "content": { "application/json": { "examples": { "default_example": { "$ref": "#/components/examples/FeeRes" } } } } }, "401": { "description": "ارسال توکن اشتباه", } }, "x-codeSamples": [ { "lang": "curl", "source": "curl --location 'https://api.ramzinex.ir/exchange/api/v2.0/exchange/user/fee' \ --header 'Authorization2: Bearer ****' \ --header 'x-api-key: ****'" }, { "lang": "PHP", "source": " 'https://api.ramzinex.ir/exchange/api/v2.0/exchange/user/fee', CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => '', CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 0, CURLOPT_FOLLOWLOCATION => true, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => 'GET', CURLOPT_HTTPHEADER => array( 'Authorization2: Bearer ****', 'x-api-key: ****', ), )); $response = curl_exec($curl); curl_close($curl); echo $response; " }, { "lang": "Python", "source": "import requests url = 'https://api.ramzinex.ir/exchange/api/v2.0/exchange/user/fee' headers = { \"Authorization2\": \"Bearer ****\", \"x-api-key\": \"****\" } response = requests.request('GET', url, headers=headers) response.raise_for_status() print(response.json())" }, { "lang": "JavaScript", "source": "const url = \"https://api.ramzinex.ir/exchange/api/v2.0/exchange/user/fee\"; const headers = { \"Authorization2\": \"Bearer ****\", \"x-api-key\": \"****\" }; const response = await fetch(url, { method: \"GET\", headers }); if (!response.ok) throw new Error(`HTTP ${response.status}`); console.log(await response.json());" }, { "lang": "C#", "source": "using System.Net.Http; using System.Text; using var client = new HttpClient(); using var request = new HttpRequestMessage(HttpMethod.Get, \"https://api.ramzinex.ir/exchange/api/v2.0/exchange/user/fee\"); request.Headers.TryAddWithoutValidation(\"Authorization2\", \"Bearer ****\"); request.Headers.TryAddWithoutValidation(\"x-api-key\", \"****\"); using var response = await client.SendAsync(request); response.EnsureSuccessStatusCode(); Console.WriteLine(await response.Content.ReadAsStringAsync());" } ], "servers": [ { "url": "https://api.ramzinex.ir/exchange/api/v2.0/exchange" } ] } }, "/fee-levels/user": { "get": { "summary": "حجم و سطح بندی کمیسیون کاربر", "description": "

حجم و سطح بندی کمیسیون کاربر

نکته:

.این درخواست نیازمند ارسال توکن است

", "operationId": "totalBonusId", "tags": [ "کارمزد‌ها و پاداش‌ها" ], "responses": { "200": { "description": "موفق", "content": { "application/json": { "examples": { "default_example": { "$ref": "#/components/examples/feeLevelRes" } } } } }, "401": { "description": "ارسال توکن اشتباه", } }, "x-codeSamples": [ { "lang": "cURL", "source": "curl --location 'https://api.ramzinex.ir/exchange/api/v2.0/exchange/fee-levels/user' \ --header 'Authorization: Bearer ****'" }, { "lang": "PHP", "source": " 'https://api.ramzinex.ir/exchange/api/v2.0/exchange/fee-levels/user', CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => '', CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 0, CURLOPT_FOLLOWLOCATION => true, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => 'GET', CURLOPT_HTTPHEADER => array( 'Authorization: Bearer DHwmVnNR4m31N3xNgYcJNoguQ3RrInDB1myH4R404CC3L3r4t0redc78b9b3d5aa8a42ea34f4686dc770e' ), )); $response = curl_exec($curl); curl_close($curl); echo $response; " }, { "lang": "Python", "source": "import requests url = 'https://api.ramzinex.ir/exchange/api/v2.0/exchange/fee-levels/user' headers = { \"Authorization\": \"Bearer ****\" } response = requests.request('GET', url, headers=headers) response.raise_for_status() print(response.json())" }, { "lang": "JavaScript", "source": "const url = \"https://api.ramzinex.ir/exchange/api/v2.0/exchange/fee-levels/user\"; const headers = { \"Authorization\": \"Bearer ****\" }; const response = await fetch(url, { method: \"GET\", headers }); if (!response.ok) throw new Error(`HTTP ${response.status}`); console.log(await response.json());" }, { "lang": "C#", "source": "using System.Net.Http; using System.Text; using var client = new HttpClient(); using var request = new HttpRequestMessage(HttpMethod.Get, \"https://api.ramzinex.ir/exchange/api/v2.0/exchange/fee-levels/user\"); request.Headers.TryAddWithoutValidation(\"Authorization\", \"Bearer ****\"); using var response = await client.SendAsync(request); response.EnsureSuccessStatusCode(); Console.WriteLine(await response.Content.ReadAsStringAsync());" } ], "servers": [ { "url": "https://api.ramzinex.ir/exchange/api/v2.0/exchange/" } ] } }, "/networks/fee/calculate_fee": { "post": { "summary": "کارمزد برداشت", "description": "

کارمزد برداشت روی شبکه‌های مختلف

نکته:

.این درخواست نیازمند ارسال توکن است

", "operationId": "calculateFeeID", "tags": [ "کارمزد‌ها و پاداش‌ها" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/calculateFeeReq" } } } }, "responses": { "200": { "description": "موفق", "content": { "application/json": { "examples": { "default_example": { "$ref": "#/components/examples/CalculateFeeRes" } } } } }, "401": { "description": "ارسال توکن اشتباه", } }, "x-codeSamples": [ { "lang": "cURL", "source": "curl --location --request POST 'https://api.ramzinex.ir/exchange/api/v1.0/exchange/networks/fee/calculate_fee' \ --header 'Content-Type: application/json' \ --header 'Authorization: ••••••' --data '{ \"network_id\": \"550\", \"amount\": \"1\" }'" }, { "lang": "PHP", "source": " 'application/json', 'Authorization' => 'Bearer DHwmVnNR4m31N3xNgYcJNoguQ3RrInDB1myH4R404CC3L3r4t0redc78b9b3d5aa8a42ea34f4686dc770e' ]; $body = '{ 'network_id': '550, 'amount': '1' }'; $request = new Request('POST', 'https://api.ramzinex.ir/exchange/api/v1.0/exchange/networks/fee/calculate_fee', $headers, $body); $res = $client->sendAsync($request)->wait(); echo $res->getBody();" }, { "lang": "Python", "source": "import requests url = 'https://api.ramzinex.ir/exchange/api/v1.0/exchange/networks/fee/calculate_fee' headers = { \"Content-Type\": \"application/json\", \"Authorization\": \"••••••\" } payload = { \"network_id\": \"550\", \"amount\": \"1\" } response = requests.request('POST', url, headers=headers, json=payload) response.raise_for_status() print(response.json())" }, { "lang": "JavaScript", "source": "const url = \"https://api.ramzinex.ir/exchange/api/v1.0/exchange/networks/fee/calculate_fee\"; const headers = { \"Content-Type\": \"application/json\", \"Authorization\": \"••••••\" }; const payload = { \"network_id\": \"550\", \"amount\": \"1\" }; const response = await fetch(url, { method: \"POST\", headers, body: JSON.stringify(payload) }); if (!response.ok) throw new Error(`HTTP ${response.status}`); console.log(await response.json());" }, { "lang": "C#", "source": "using System.Net.Http; using System.Text; using var client = new HttpClient(); using var request = new HttpRequestMessage(HttpMethod.Post, \"https://api.ramzinex.ir/exchange/api/v1.0/exchange/networks/fee/calculate_fee\"); request.Headers.TryAddWithoutValidation(\"Authorization\", \"••••••\"); const string payload = @\"{ \"\"network_id\"\": \"\"550\"\", \"\"amount\"\": \"\"1\"\" }\"; request.Content = new StringContent(payload, Encoding.UTF8, \"application/json\"); using var response = await client.SendAsync(request); response.EnsureSuccessStatusCode(); Console.WriteLine(await response.Content.ReadAsStringAsync());" } ], "servers": [ { "url": "https://api.ramzinex.ir/exchange/api/v1.0/exchange/" } ] } }, "/users/me/orders3": { "post": { "summary": "دریافت سفارش‌های کاربر", "description": "

دریافت سفارش‌های کاربر با مشخصات خاص

نکته:

.این درخواست نیازمند ارسال توکن است

", "operationId": "ordersId", "tags": [ "سفارشات و معاملات" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrdersReq" } } } }, "responses": { "200": { "description": "موفق", "content": { "application/json": { "examples": { "default_example": { "$ref": "#/components/examples/OrdersRes" } } } } }, "401": { "description": "ارسال توکن اشتباه", } }, "x-codeSamples": [ { "lang": "cURL", "source": "curl --location 'https://api.ramzinex.ir/exchange/api/v1.0/exchange/users/me/orders3' \ --header 'Content-Type: application/json' \ --header 'Authorization2: Bearer ****' \ --header 'x-api-key: ****' \ --data '{ \"isbuy\": false, \"pairs\": [11] }'" }, { "lang": "PHP", "source": " 'https://api.ramzinex.ir/exchange/api/v1.0/exchange/users/me/orders3', CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => '', CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 0, CURLOPT_FOLLOWLOCATION => true, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => 'POST', CURLOPT_POSTFIELDS =>'{ 'isbuy': false, 'pairs': [11] }', CURLOPT_HTTPHEADER => array( 'Content-Type: application/json', 'Authorization2: Bearer ****', 'x-api-key: ****', ), )); $response = curl_exec($curl); curl_close($curl); echo $response; " }, { "lang": "Python", "source": "import requests url = 'https://api.ramzinex.ir/exchange/api/v1.0/exchange/users/me/orders3' headers = { \"Content-Type\": \"application/json\", \"Authorization2\": \"Bearer ****\", \"x-api-key\": \"****\" } payload = { \"isbuy\": false, \"pairs\": [ 11 ] } response = requests.request('POST', url, headers=headers, json=payload) response.raise_for_status() print(response.json())" }, { "lang": "JavaScript", "source": "const url = \"https://api.ramzinex.ir/exchange/api/v1.0/exchange/users/me/orders3\"; const headers = { \"Content-Type\": \"application/json\", \"Authorization2\": \"Bearer ****\", \"x-api-key\": \"****\" }; const payload = { \"isbuy\": false, \"pairs\": [ 11 ] }; const response = await fetch(url, { method: \"POST\", headers, body: JSON.stringify(payload) }); if (!response.ok) throw new Error(`HTTP ${response.status}`); console.log(await response.json());" }, { "lang": "C#", "source": "using System.Net.Http; using System.Text; using var client = new HttpClient(); using var request = new HttpRequestMessage(HttpMethod.Post, \"https://api.ramzinex.ir/exchange/api/v1.0/exchange/users/me/orders3\"); request.Headers.TryAddWithoutValidation(\"Authorization2\", \"Bearer ****\"); request.Headers.TryAddWithoutValidation(\"x-api-key\", \"****\"); const string payload = @\"{ \"\"isbuy\"\": false, \"\"pairs\"\": [ 11 ] }\"; request.Content = new StringContent(payload, Encoding.UTF8, \"application/json\"); using var response = await client.SendAsync(request); response.EnsureSuccessStatusCode(); Console.WriteLine(await response.Content.ReadAsStringAsync());" } ], "servers": [ { "url": "https://api.ramzinex.ir/exchange/api/v1.0/exchange/" } ] } }, "/users/me/orders2/{order_id}": { "get": { "summary": "مشخصات یک سفارش", "description": "

مشخصات یک سفارش مشخص

نکته:

.این درخواست نیازمند ارسال توکن است

", "operationId": "specialOrder2Id", "tags": [ "سفارشات و معاملات" ], "parameters": [ { "$ref": "#/components/parameters/OrderId" } ], "responses": { "200": { "description": "موفق", "content": { "application/json": { "examples": { "default_example": { "$ref": "#/components/examples/SpecialOrder2Ex1" } } } } }, "404": { "description": "ارسال شناسه اشتباه", }, "401": { "description": "ارسال توکن اشتباه", } }, "x-codeSamples": [ { "lang": "cURL", "source": "curl --location 'https://api.ramzinex.ir/exchange/api/v1.0/exchange/users/me/orders2/781742310' \ --header 'Authorization2: Bearer ****' \ --header 'x-api-key: ****'" }, { "lang": "PHP", "source": " 'https://api.ramzinex.ir/exchange/api/v1.0/exchange/users/me/orders2/781742310', CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => '', CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 0, CURLOPT_FOLLOWLOCATION => true, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => 'GET', CURLOPT_HTTPHEADER => array( 'Authorization2: Bearer ****', 'x-api-key: ****', ), )); $response = curl_exec($curl); curl_close($curl); echo $response; " }, { "lang": "Python", "source": "import requests url = 'https://api.ramzinex.ir/exchange/api/v1.0/exchange/users/me/orders2/781742310' headers = { \"Authorization2\": \"Bearer ****\", \"x-api-key\": \"****\" } response = requests.request('GET', url, headers=headers) response.raise_for_status() print(response.json())" }, { "lang": "JavaScript", "source": "const url = \"https://api.ramzinex.ir/exchange/api/v1.0/exchange/users/me/orders2/781742310\"; const headers = { \"Authorization2\": \"Bearer ****\", \"x-api-key\": \"****\" }; const response = await fetch(url, { method: \"GET\", headers }); if (!response.ok) throw new Error(`HTTP ${response.status}`); console.log(await response.json());" }, { "lang": "C#", "source": "using System.Net.Http; using System.Text; using var client = new HttpClient(); using var request = new HttpRequestMessage(HttpMethod.Get, \"https://api.ramzinex.ir/exchange/api/v1.0/exchange/users/me/orders2/781742310\"); request.Headers.TryAddWithoutValidation(\"Authorization2\", \"Bearer ****\"); request.Headers.TryAddWithoutValidation(\"x-api-key\", \"****\"); using var response = await client.SendAsync(request); response.EnsureSuccessStatusCode(); Console.WriteLine(await response.Content.ReadAsStringAsync());" } ], "servers": [ { "url": "https://api.ramzinex.ir/exchange/api/v1.0/exchange/" } ] } }, "/users/me/orders/limit": { "post": { "summary": "ارسال سفارش محدود", "description": "

سفارش برای یک بازار مشخص (مانند بازار بیت کوین/ریال)، با قیمت و مقدار مشخص شده از نوع خرید یا فروش ارسال می شود.

نکته:

.این درخواست نیازمند ارسال توکن است

", "operationId": "limitOrdersId", "tags": [ "سفارشات و معاملات" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LimitOrdersSchema" }, "examples": { "default_example": { "$ref": "#/components/examples/LimitOrderEx" } } } } }, "responses": { "200": { "description": "موفق", "content": { "application/json": { "examples": { "example1": { "$ref": "#/components/examples/LimitRes1" }, "example2": { "$ref": "#/components/examples/LimitRes2" }, } } } }, "401": { "description": "ارسال توکن اشتباه", }, "500": { "description": "اشتباه وارد کردن بدنه‌ی درخواست", } }, "x-codeSamples": [ { "lang": "cURL", "source": "curl --location 'https://api.ramzinex.ir/exchange/api/v1.0/exchange/users/me/orders/limit' \ --header 'Content-Type: application/json' \ --header 'Authorization2: Bearer ****' \ --header 'x-api-key: ****' \ --data '{ \"pair_id\":\"11\", \"amount\":70.460, \"price\":12000, \"type\":\"buy\" }'" }, { "lang": "PHP", "source": " 'https://api.ramzinex.ir/exchange/api/v1.0/exchange/users/me/orders/limit', CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => '', CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 0, CURLOPT_FOLLOWLOCATION => true, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => 'POST', CURLOPT_POSTFIELDS =>'{ 'pair_id':'11', 'amount':70.460, 'price':12000, 'type':'buy' }', CURLOPT_HTTPHEADER => array( 'Content-Type: application/json', 'Authorization2: Bearer ****', 'x-api-key': '****', ), )); $response = curl_exec($curl); curl_close($curl); echo $response; " }, { "lang": "Python", "source": "import requests url = 'https://api.ramzinex.ir/exchange/api/v1.0/exchange/users/me/orders/limit' headers = { \"Content-Type\": \"application/json\", \"Authorization2\": \"Bearer ****\", \"x-api-key\": \"****\" } payload = { \"pair_id\": \"11\", \"amount\": 70.46, \"price\": 12000, \"type\": \"buy\" } response = requests.request('POST', url, headers=headers, json=payload) response.raise_for_status() print(response.json())" }, { "lang": "JavaScript", "source": "const url = \"https://api.ramzinex.ir/exchange/api/v1.0/exchange/users/me/orders/limit\"; const headers = { \"Content-Type\": \"application/json\", \"Authorization2\": \"Bearer ****\", \"x-api-key\": \"****\" }; const payload = { \"pair_id\": \"11\", \"amount\": 70.46, \"price\": 12000, \"type\": \"buy\" }; const response = await fetch(url, { method: \"POST\", headers, body: JSON.stringify(payload) }); if (!response.ok) throw new Error(`HTTP ${response.status}`); console.log(await response.json());" }, { "lang": "C#", "source": "using System.Net.Http; using System.Text; using var client = new HttpClient(); using var request = new HttpRequestMessage(HttpMethod.Post, \"https://api.ramzinex.ir/exchange/api/v1.0/exchange/users/me/orders/limit\"); request.Headers.TryAddWithoutValidation(\"Authorization2\", \"Bearer ****\"); request.Headers.TryAddWithoutValidation(\"x-api-key\", \"****\"); const string payload = @\"{ \"\"pair_id\"\": \"\"11\"\", \"\"amount\"\": 70.46, \"\"price\"\": 12000, \"\"type\"\": \"\"buy\"\" }\"; request.Content = new StringContent(payload, Encoding.UTF8, \"application/json\"); using var response = await client.SendAsync(request); response.EnsureSuccessStatusCode(); Console.WriteLine(await response.Content.ReadAsStringAsync());" } ], "servers": [ { "url": "https://api.ramzinex.ir/exchange/api/v1.0/exchange/" } ] } }, "/users/me/orders/market": { "post": { "summary": "ارسال سفارش بازار", "description": "

سفارش برای یک بازار مشخص (مانند بازار بیت کوین/ریال)، با بهترین قیمت بازار صورت می گیرد. برای خرید مقدار ریالی و برای فروش نیز مقدار رمز ارز مدنظرتان را ارسال کنید.

نکته:

.این درخواست نیازمند ارسال توکن است

", "operationId": "marketOrdersId", "tags": [ "سفارشات و معاملات" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MarketOrdersSchema" }, "examples": { "default_example": { "$ref": "#/components/examples/MarketOrderEx" } } }, } }, "responses": { "200": { "description": "موفق", "content": { "application/json": { "examples": { "example1": { "$ref": "#/components/examples/MarketRes1" }, "example2": { "$ref": "#/components/examples/MarketRes2" }, } } } }, "401": { "description": "ارسال توکن اشتباه", }, "500": { "description": "اشتباه وارد کردن بدنه‌ی درخواست", } }, "x-codeSamples": [ { "lang": "cURL", "source": "curl --location 'https://api.ramzinex.ir/exchange/api/v2.0/exchange/users/me/orders/market' \ --header 'Content-Type: application/json' \ --header 'Authorization2: Bearer ****' \ --header 'x-api-key: ****' \ --data '{ \"pair_id\" : 12, \"amount\" : 2, \"type\": 'sell' }'" }, { "lang": "PHP", "source": " 'https://api.ramzinex.ir/exchange/api/v2.0/exchange/users/me/orders/market', CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => '', CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 0, CURLOPT_FOLLOWLOCATION => true, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => 'POST', CURLOPT_POSTFIELDS =>'{ 'pair_id' : 12, 'amount' : 2, 'type': 'sell' }', CURLOPT_HTTPHEADER => array( 'Content-Type: application/json', 'Authorization2: Bearer ****', 'x-api-key: ****', ), )); $response = curl_exec($curl); curl_close($curl); echo $response; " }, { "lang": "Python", "source": "import requests url = 'https://api.ramzinex.ir/exchange/api/v2.0/exchange/users/me/orders/market' headers = { \"Content-Type\": \"application/json\", \"Authorization2\": \"Bearer ****\", \"x-api-key\": \"****\" } payload = { \"pair_id\": 12, \"amount\": 2, \"type\": \"sell\" } response = requests.request('POST', url, headers=headers, json=payload) response.raise_for_status() print(response.json())" }, { "lang": "JavaScript", "source": "const url = \"https://api.ramzinex.ir/exchange/api/v2.0/exchange/users/me/orders/market\"; const headers = { \"Content-Type\": \"application/json\", \"Authorization2\": \"Bearer ****\", \"x-api-key\": \"****\" }; const payload = { \"pair_id\": 12, \"amount\": 2, \"type\": \"sell\" }; const response = await fetch(url, { method: \"POST\", headers, body: JSON.stringify(payload) }); if (!response.ok) throw new Error(`HTTP ${response.status}`); console.log(await response.json());" }, { "lang": "C#", "source": "using System.Net.Http; using System.Text; using var client = new HttpClient(); using var request = new HttpRequestMessage(HttpMethod.Post, \"https://api.ramzinex.ir/exchange/api/v2.0/exchange/users/me/orders/market\"); request.Headers.TryAddWithoutValidation(\"Authorization2\", \"Bearer ****\"); request.Headers.TryAddWithoutValidation(\"x-api-key\", \"****\"); const string payload = @\"{ \"\"pair_id\"\": 12, \"\"amount\"\": 2, \"\"type\"\": \"\"sell\"\" }\"; request.Content = new StringContent(payload, Encoding.UTF8, \"application/json\"); using var response = await client.SendAsync(request); response.EnsureSuccessStatusCode(); Console.WriteLine(await response.Content.ReadAsStringAsync());" } ], "servers": [ { "url": "https://api.ramzinex.ir/exchange/api/v2.0/exchange/" } ] } }, "/users/me/orders/{order_id}/cancel": { "post": { "summary": "کنسل کردن سفارش", "description": "

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

نکته:

.این درخواست نیازمند ارسال توکن است

", "operationId": "cancelOrderId", "tags": [ "سفارشات و معاملات" ], "parameters": [ { "$ref": "#/components/parameters/OrderId" } ], "responses": { "200": { "description": "موفق", "content": { "application/json": { "examples": { "example1": { "$ref": "#/components/examples/CancelOrderRes1" }, "example2": { "$ref": "#/components/examples/CancelOrderRes2" }, } } } }, "401": { "description": "ارسال توکن اشتباه", } }, "x-codeSamples": [ { "lang": "cURL", "source": "curl --location --request POST 'https://api.ramzinex.ir/exchange/api/v1.0/exchange/users/me/orders/811235995/cancel' \ --header 'Authorization2: Bearer ****' \ --header 'x-api-key: ****'" }, { "lang": "PHP", "source": " 'https://api.ramzinex.ir/exchange/api/v1.0/exchange/users/me/orders/811235995/cancel', CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => '', CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 0, CURLOPT_FOLLOWLOCATION => true, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => 'POST', CURLOPT_HTTPHEADER => array( 'Authorization2: Bearer ****', 'x-api-key: ****', ), )); $response = curl_exec($curl); curl_close($curl); echo $response; " }, { "lang": "Python", "source": "import requests url = 'https://api.ramzinex.ir/exchange/api/v1.0/exchange/users/me/orders/811235995/cancel' headers = { \"Authorization2\": \"Bearer ****\", \"x-api-key\": \"****\" } response = requests.request('POST', url, headers=headers) response.raise_for_status() print(response.json())" }, { "lang": "JavaScript", "source": "const url = \"https://api.ramzinex.ir/exchange/api/v1.0/exchange/users/me/orders/811235995/cancel\"; const headers = { \"Authorization2\": \"Bearer ****\", \"x-api-key\": \"****\" }; const response = await fetch(url, { method: \"POST\", headers }); if (!response.ok) throw new Error(`HTTP ${response.status}`); console.log(await response.json());" }, { "lang": "C#", "source": "using System.Net.Http; using System.Text; using var client = new HttpClient(); using var request = new HttpRequestMessage(HttpMethod.Post, \"https://api.ramzinex.ir/exchange/api/v1.0/exchange/users/me/orders/811235995/cancel\"); request.Headers.TryAddWithoutValidation(\"Authorization2\", \"Bearer ****\"); request.Headers.TryAddWithoutValidation(\"x-api-key\", \"****\"); using var response = await client.SendAsync(request); response.EnsureSuccessStatusCode(); Console.WriteLine(await response.Content.ReadAsStringAsync());" } ], "servers": [ { "url": "https://api.ramzinex.ir/exchange/api/v1.0/exchange/" } ] } }, "/users/me/cancelAllOpenOrders": { "post": { "summary": "کنسل کردن تمامی سفارشات باز", "description": "

کنسل کردن سفارشات باز

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

نکته:

.این درخواست نیازمند ارسال توکن است

", "operationId": "cancelAllOrdersId", "tags": [ "سفارشات و معاملات" ], "responses": { "200": { "description": "موفق", "content": { "application/json": { "examples": { "example1": { "$ref": "#/components/examples/CancelAllOrdersRes1" } } } } }, "401": { "description": "ارسال توکن اشتباه", } }, "x-codeSamples": [ { "lang": "cURL", "source": "curl --location --request POST 'https://api.ramzinex.ir/exchange/api/v1.0/exchange/users/me/cancelAllOpenOrders' \ --header 'Authorization2: Bearer ****' \ --header 'x-api-key: ****'" }, { "lang": "PHP", "source": " 'https://api.ramzinex.ir/exchange/api/v1.0/exchange/users/me/cancelAllOpenOrders', CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => '', CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 0, CURLOPT_FOLLOWLOCATION => true, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => 'POST', CURLOPT_HTTPHEADER => array( 'Authorization2: Bearer ****', 'x-api-key: ****', ), )); $response = curl_exec($curl); curl_close($curl); echo $response; " }, { "lang": "Python", "source": "import requests url = 'https://api.ramzinex.ir/exchange/api/v1.0/exchange/users/me/cancelAllOpenOrders' headers = { \"Authorization2\": \"Bearer ****\", \"x-api-key\": \"****\" } response = requests.request('POST', url, headers=headers) response.raise_for_status() print(response.json())" }, { "lang": "JavaScript", "source": "const url = \"https://api.ramzinex.ir/exchange/api/v1.0/exchange/users/me/cancelAllOpenOrders\"; const headers = { \"Authorization2\": \"Bearer ****\", \"x-api-key\": \"****\" }; const response = await fetch(url, { method: \"POST\", headers }); if (!response.ok) throw new Error(`HTTP ${response.status}`); console.log(await response.json());" }, { "lang": "C#", "source": "using System.Net.Http; using System.Text; using var client = new HttpClient(); using var request = new HttpRequestMessage(HttpMethod.Post, \"https://api.ramzinex.ir/exchange/api/v1.0/exchange/users/me/cancelAllOpenOrders\"); request.Headers.TryAddWithoutValidation(\"Authorization2\", \"Bearer ****\"); request.Headers.TryAddWithoutValidation(\"x-api-key\", \"****\"); using var response = await client.SendAsync(request); response.EnsureSuccessStatusCode(); Console.WriteLine(await response.Content.ReadAsStringAsync());" } ], "servers": [ { "url": "https://api.ramzinex.ir/exchange/api/v1.0/exchange/" } ] } }, }, "components": { "schemas": { "TicketType": { "description": "Type of ticket being purchased. Use `general` for regular museum entry and `event` for tickets to special events.", "type": "string", "enum": [ "event", "general" ], "example": "event" }, "Date": { "type": "string", "format": "date", "example": "2023-10-29" }, "Email": { "description": "Email address for ticket purchaser.", "type": "string", "format": "email", "example": "museum-lover@example.com" }, "api_key_id": { "type": "number", "description": "آی‌دی کلید امنیتی", "example": 1234 }, "addressFree": { "type": "number", "description": "دسترسی به برداشت", "example": 1 }, "api_key": { "type": "string", "description": "کلید API", "example": "ApiKeyAzi6AZw:ebc78abccddb609b60e070ba83412c1540d8b7f952b277d1" }, "networks": { "type": "array", "description": "لیست شناسه‌ی شبکه‌ها. فقط اولین شناسه توسط API پردازش می‌شود.", "items": { "type": "integer" }, "minItems": 1, "example": [116] }, "secret": { "type": "string", "description": "کلید محرمانه", "example": "8ab1qsad1112216306b07f7c7" }, "currencies": { "type": "array", "description": "لیست شناسه رمزارزها", "items": { "type": "integer" }, "example": [1, 9, 46] }, "limit": { "type": "number", "description": "تعداد آبجکت‌های هر ریکوئست", "example": 10 }, "offset": { "type": "number", "description": "از آبجکت چند به بعد نشان داده شود", "example": 2 }, "network_id": { "type": "number", "description": "شناسه شبکه", "example": 1 }, "address": { "type": "string", "description": "آدرس", "example": "TJYHuRZBa2673p1pL5KT6HAbZaRFYEipzz" }, "tag": { "type": "string", "description": "تگ", "example": "TJYHuRZBa2673p1pL5KT6HAbZaRFYEipzz" }, "no_tag": { "type": "boolean", "description": "تعیین تگ داشتن یا نداشتن", "example": false }, "code": { "type": "string", "pattern": "^[0-9]+$", "description": "کد تأیید عددی", "example": "123456" }, "gaCode": { "type": "string", "pattern": "^[0-9]+$", "description": "کد عددی Google Authenticator", "example": "123987" }, "apiName": { "type": "string", "description": "نام دلخواه برای کلید ای‌پی‌آی", "example": "api test" }, "boolean": { "type": "number", "description": "", "example": "1" }, "alert": { "type": "number", "description": "دسترسی به ثبت سفارش", "example": 0 }, "pairs": { "type": "list", "description": "لیست بازارها", "example": [11, 46] }, "ips": { "type": "array", "description": "لیست آی‌پی ها", "example": [1.1.1.1, 2.2.2.2] }, "isbuy": { "type": "boolean", "description": "سفارش ها از نوع خرید باشند یا خیر", "example": "True", "enum": [True, False], }, "pair_id": { "type": "number", "description": "شناسه بازار", "example": 11 }, "currency_id": { "type": "number", "description": "شناسه رمزارز", "example": 9 }, "currency_id_optional": { "type": "number", "description": "برای یافتن برداشت یک رمزارز خاص، می‌توانید از این فیلد استفاده کنید.", "example": 9 }, "amount": { "type": "number", "description": "مقدار خرید با واحد ریال یا مقدار فروش با واحد ارز", "example": 120 }, "limitAmount": { "type": "float", "description": "مقدار خرید یا مقدار فروش با واحد ارز", "example": 120 }, "price": { "type": "number", "description": "قیمت واحد", "example": 18500 }, "type": { "type": "string", "description": "تعیین جهت سفارش (خرید یا فروش)", "example": "buy", "enum": ["buy", "sell"] }, "states": { "type": "number", "description": "مقدار ۱: سفارشات باز / مقدار ۲: سفارشات لغو شده / مقدار ۳: سفارشات انجام شده / مقدار ۴: سفارشات بخشی انجام شده", "example": 1, "enum": [1, 2, 3, 4] }, "AddressesReq": { "description": "بدنه درخواست", "type": "object", "properties": { "networks": { "$ref": "#/components/schemas/networks" } }, "required": [ "networks" ] }, "CreateNetworkReq": { "description": "currency_id اجباری است. network_id اختیاری است؛ در صورت نبودن، شبکه پیش‌فرض ارز استفاده می‌شود.", "type": "object", "properties": { "network_id": { "$ref": "#/components/schemas/network_id" }, "currency_id": { "$ref": "#/components/schemas/currency_id" }, }, "required": [ "currency_id" ] }, "GetTokenReq": { "description": "GeneralApiKeyReq", "type": "object", "properties": { "api_key": { "$ref": "#/components/schemas/api_key" }, "secret": { "$ref": "#/components/schemas/secret" } }, "required": [ "api_key", "secret" ] }, "GeneralApiKeyReq": { "description": "بادی دریافت توکن", "type": "object", "properties": { "addressFree": { "$ref": "#/components/schemas/addressFree" }, "alert": { "$ref": "#/components/schemas/alert" } }, "required": [ "addressFree", "alert" ] }, "CurrencyDepositsReq": { "description": "فیلترهای اختیاری فهرست واریزها", "type": "object", "properties": { "currency_type": { "type": "string", "enum": ["rial", "cryptocurrency"], "description": "نوع ارز" }, "currencies": { "$ref": "#/components/schemas/currencies" }, "limit": { "$ref": "#/components/schemas/limit" }, "offset": { "$ref": "#/components/schemas/offset" }, "created_at_from": { "type": "string", "format": "date-time", "description": "ابتدای بازهٔ زمانی ایجاد واریز" }, "created_at_to": { "type": "string", "format": "date-time", "description": "انتهای بازهٔ زمانی ایجاد واریز" }, } }, "WithdrawRequestReq": { "description": "WithdrawRequestReq", "type": "object", "properties": { "amount": { "$ref": "#/components/schemas/amount" }, "address": { "$ref": "#/components/schemas/address" }, "network_id": { "$ref": "#/components/schemas/network_id" }, "currency_id": { "$ref": "#/components/schemas/currency_id" }, "tag": { "$ref": "#/components/schemas/tag" }, "no_tag": { "$ref": "#/components/schemas/no_tag" }, "ramzinex_client_type": { "type": "string", "description": "نوع کلاینت رمزینکس" }, "2fa": { "type": "string", "description": "کد تأیید دوعاملی، در صورت نیاز" }, "password": { "type": "string", "description": "رمز عبور، در صورت نیاز" }, }, "required": [ "address", "network_id", "amount", "currency_id", ] }, "CurrencyWithdrawsReq": { "description": "فیلترهای اختیاری فهرست برداشت‌ها", "type": "object", "properties": { "limit": { "$ref": "#/components/schemas/limit" }, "offset": { "$ref": "#/components/schemas/offset" }, "currency_id": { "$ref": "#/components/schemas/currency_id_optional" }, "exclude_rial": { "type": "boolean", "description": "حذف برداشت‌های ریالی از نتیجه" }, "type": { "type": "integer", "minimum": 0, "description": "نوع برداشت" }, "created_at_from": { "type": "string", "format": "date-time", "description": "ابتدای بازهٔ زمانی ایجاد برداشت" }, "created_at_to": { "type": "string", "format": "date-time", "description": "انتهای بازهٔ زمانی ایجاد برداشت" }, "state_id": { "type": "integer", "description": "شناسه وضعیت برداشت" } } }, "BonusesReq": { "description": "فیلترهای اختیاری ریزپاداش‌ها", "type": "object", "properties": { "offset": { "$ref": "#/components/schemas/offset" }, "limit": { "$ref": "#/components/schemas/limit" } } }, "LimitOffsetReq": { "description": "CurrencyDepositsReqq", "type": "object", "properties": { "offset": { "$ref": "#/components/schemas/offset" }, "limit": { "$ref": "#/components/schemas/limit" }, "pairs": { "$ref": "#/components/schemas/pairs" }, "states": { "$ref": "#/components/schemas/states" }, "isbuy": { "$ref": "#/components/schemas/isbuy" }, } }, "OrdersReq": { "description": "OrdersReq", "type": "object", "properties": { "offset": { "$ref": "#/components/schemas/offset" }, "limit": { "$ref": "#/components/schemas/limit" }, "pairs": { "$ref": "#/components/schemas/pairs" }, "isBuy": { "$ref": "#/components/schemas/isbuy" }, "states": { "$ref": "#/components/schemas/states" }, } }, "calculateFeeReq": { "description": "calculateFeeReq", "type": "object", "properties": { "network_id": { "$ref": "#/components/schemas/network_id" }, "amount": { "$ref": "#/components/schemas/amount" }, } }, "LimitOrdersSchema": { "description": "LimitOrdersSchema", "type": "object", "properties": { "pair_id": { "$ref": "#/components/schemas/pair_id" }, "amount": { "$ref": "#/components/schemas/limitAmount" }, "price": { "$ref": "#/components/schemas/price" }, "type": { "$ref": "#/components/schemas/type" }, } }, "MarketOrdersSchema": { "description": "MarketOrdersSchema", "type": "object", "properties": { "pair_id": { "$ref": "#/components/schemas/pair_id" }, "amount": { "$ref": "#/components/schemas/amount" }, "type": { "$ref": "#/components/schemas/type" }, } }, "VerifyWithdrawReq": { "description": "code اجباری و gaCode اختیاری است. هر دو باید فقط شامل رقم باشند.", "type": "object", "properties": { "code": { "$ref": "#/components/schemas/code" }, "gaCode": { "$ref": "#/components/schemas/gaCode" }, }, "required": ["code"] }, "Error": { "type": "object", "properties": { "type": { "type": "string", "example": "object" }, "title": { "type": "string", "example": "Validation failed" } } }, }, "securitySchemes": {}, "examples": { "Addresses": { "summary": "User addresses", "value": { "networks":[ 116 ] } }, "AddressesEx": { "summary": "توجه! مقدار 0 به معنی عدم دسترسی و مقدار 1 به معنی به معنی داشتن دسترسی می‌باشد", "value": { "networks":[116] } }, "CreateAddressEx": { "summary": "create address for a currency", "value": { "currency_id": 9, "network_id": 1 } }, "DepositListReq": { "summary": "a list of deposits in currencies", "value": { "currency_type": "cryptocurrency", "limit": 5, "offset": 1, "currencies": [ 2, 9, 46 ], "created_at_from": "2026-01-01T00:00:00+03:30", "created_at_to": "2026-01-31T23:59:59+03:30" } }, "WithdrawReqRes2": { "summary": "خطای عدم احراز ویژه", "value": { "status": -1232, "description": { "fa": " برداشت ارز دیجیتال با احراز پایه امکان پذیر نیست ", "en": "Withdraw crypto is not possible with basic authorization" } } }, "WithdrawReqRes1": { "summary": "پاسخ موفق", "value": { "status": 0, "count": 727, "data": [ { "id": 781742310, "pair": "tether/rial", "pair_obj": { "sell": 641050, "buy": 640810, "pair_id": 11, "name": { "fa": "تتر(دلار)", "en": "tether/rial" }, "icon": "exchange/img/coins/usdt.png", "logo": "https://public-assets.ramzinex.ir/public/currencies/logo/usdt.png", "web_link": "https://ramzinex.ir/exchange/orderbook/11", "base_precision": 2, "quote_precision": 0, "base_currency_id": 9, "base_currency_symbol": { "en": "usdt", "fa": "تتر" }, "quote_currency_id": 2, "quote_currency_symbol": { "en": "irr", "fa": "ریال" }, "financial": { "last24h": { "open": 638921, "close": 641050, "highest": 642994, "lowest": 637500, "quote_volume": 689423192262, "base_volume": 1076372.9266, "change_percent": 0.33 } }, "price_step": 641, "amount_step": 1.55, "tv_symbol": { "ramzinex": "usdtirr", "international": "BINANCE:usdcUSDT", "charts": { "tradingview": { "source": "BINANCE", "symbol": "usdcUSDT" }, "bitycle": { "source": "binance_spot", "symbol": "USDCUSDT" } } }, "show_order": 51, "url_name": "tether-usdt", "crypto_box": 0, "price_precision": 0, "is_delist": 0 }, "pair_name": { "en": "tether/rial", "fa": "تتر(دلار)" }, "pair_id": 11, "type_id": 1, "type_id_v2": 11, "type_v2_all_lang": { "en": "limit", "fa": " محدود" }, "type": "خرید", "type_en": "buy", "amount": "1.07 usdt", "stop_price": null, "limit_price": null, "stop_limit_price": null, "amount_nr": 1.07, "total_quote_amount_nr": 646059, "amount_quote_nr": 646059, "average_price": "603,793 irr", "average_price_nr": 603793.9999999999, "order_price": 603794, "order_price_nr": 603794, "total_payment": "0 irr", "total_payment_nr": 0, "net_received": "0.00 usdt", "net_received_nr": 0, "commission_currency_id": 9, "commission_nr": 0, "commission_percentage_nr": 0, "filled_nr": 0, "created_at": "03-07-07 08:53", "created_at_ms": 1727501018, "status": { "fa_name": "باز", "id": 1 }, "status_id": 1, "account_id": 58408, "reference_id": "1030000000000399956", "percent": "0 %", "percent_num": 0, "cancel_route": "https://ramzinex.ir/exchange/order/cancelOrder/781742310" }, { "id": 781647832, "pair": "tether/rial", "pair_obj": { "sell": 641050, "buy": 640810, "pair_id": 11, "name": { "fa": "تتر(دلار)", "en": "tether/rial" }, "icon": "exchange/img/coins/usdt.png", "logo": "https://public-assets.ramzinex.ir/public/currencies/logo/usdt.png", "web_link": "https://ramzinex.ir/exchange/orderbook/11", "base_precision": 2, "quote_precision": 0, "base_currency_id": 9, "base_currency_symbol": { "en": "usdt", "fa": "تتر" }, "quote_currency_id": 2, "quote_currency_symbol": { "en": "irr", "fa": "ریال" }, "financial": { "last24h": { "open": 638921, "close": 641050, "highest": 642994, "lowest": 637500, "quote_volume": 689423192262, "base_volume": 1076372.9266, "change_percent": 0.33 } }, "price_step": 641, "amount_step": 1.55, "tv_symbol": { "ramzinex": "usdtirr", "international": "BINANCE:usdcUSDT", "charts": { "tradingview": { "source": "BINANCE", "symbol": "usdcUSDT" }, "bitycle": { "source": "binance_spot", "symbol": "USDCUSDT" } } }, "show_order": 51, "url_name": "tether-usdt", "crypto_box": 0, "price_precision": 0, "is_delist": 0 }, "pair_name": { "en": "tether/rial", "fa": "تتر(دلار)" }, "pair_id": 11, "type_id": 1, "type_id_v2": 11, "type_v2_all_lang": { "en": "limit", "fa": " محدود" }, "type": "خرید", "type_en": "buy", "amount": "1.07 usdt", "stop_price": null, "limit_price": null, "stop_limit_price": null, "amount_nr": 1.07, "total_quote_amount_nr": 644727, "amount_quote_nr": 644727, "average_price": "602,549 irr", "average_price_nr": 602549, "order_price": 602549, "order_price_nr": 602549, "total_payment": "0 irr", "total_payment_nr": 0, "net_received": "0.00 usdt", "net_received_nr": 0, "commission_currency_id": 9, "commission_nr": 0, "commission_percentage_nr": 0, "filled_nr": 0, "created_at": "03-07-07 06:25", "created_at_ms": 1727492150, "status": { "fa_name": "باز", "id": 1 }, "status_id": 1, "account_id": 58408, "reference_id": "1030000000000399784", "percent": "0 %", "percent_num": 0, "cancel_route": "https://ramzinex.ir/exchange/order/cancelOrder/781647832" } ] } }, "OrdersRes": { "summary": "پاسخ موفق", "value": { "status": 0, "count": 729, "data": [ { "id": 811289310, "pair": "tether/rial", "pair_obj": { "sell": 687022, "buy": 686909, "pair_id": 11, "name": { "fa": "تتر(دلار)", "en": "tether/rial" }, "icon": "exchange/img/coins/usdt.png", "logo": "https://public-assets.ramzinex.ir/public/currencies/logo/usdt.png", "web_link": "https://ramzinex.ir/exchange/orderbook/11", "base_precision": 2, "quote_precision": 0, "base_currency_id": 9, "base_currency_symbol": { "en": "usdt", "fa": "تتر" }, "quote_currency_id": 2, "quote_currency_symbol": { "en": "irr", "fa": "ریال" }, "financial": { "last24h": { "open": 692400, "close": 687635.99, "highest": 697000, "lowest": 687125, "quote_volume": 773313057479, "base_volume": 1117614.7862, "change_percent": -0.76 } }, "price_step": 687, "amount_step": 1.45, "tv_symbol": { "ramzinex": "usdtirr", "international": "BINANCE:usdcUSDT", "charts": { "tradingview": { "source": "BINANCE", "symbol": "usdcUSDT" }, "bitycle": { "source": "binance_spot", "symbol": "USDCUSDT" } } }, "show_order": 51, "url_name": "tether-usdt", "crypto_box": 0, "price_precision": 0, "is_delist": 0 }, "pair_name": { "en": "tether/rial", "fa": "تتر(دلار)" }, "pair_id": 11, "type_id": 11, "type_id_v2": 16, "type_v2_all_lang": { "en": "market", "fa": " بازار" }, "type": "فروش", "type_en": "sell", "amount": "2 usdt", "stop_price": null, "limit_price": null, "stop_limit_price": null, "amount_nr": 2, "total_quote_amount_nr": 0, "amount_quote_nr": 0, "average_price": "661,643 irr", "average_price_nr": 661643, "order_price": 661643, "order_price_nr": 661643, "total_payment": "2.00 usdt", "total_payment_nr": 200, "net_received": "1,319,977 irr", "net_received_nr": 1319977, "commission_currency_id": 2, "commission_nr": 3308.21, "commission_percentage_nr": 0, "filled_nr": 2, "created_at": "03-08-01 18:11", "created_at_ms": 1729608075, "status": { "fa_name": "کاملا اجرا شده", "id": 3 }, "status_id": 3, "account_id": 4084, "reference_id": "bd802366-1af0-4c0c-a862-6a2675cb5091", "percent": "100 %", "percent_num": 100, "details_route": "https://ramzinex.ir/exchange/order/orderDetails/811289310" }, { "id": 811253947, "pair": "tether/rial", "pair_obj": { "sell": 687022, "buy": 686909, "pair_id": 11, "name": { "fa": "تتر(دلار)", "en": "tether/rial" }, "icon": "exchange/img/coins/usdt.png", "logo": "https://public-assets.ramzinex.ir/public/currencies/logo/usdt.png", "web_link": "https://ramzinex.ir/exchange/orderbook/11", "base_precision": 2, "quote_precision": 0, "base_currency_id": 9, "base_currency_symbol": { "en": "usdt", "fa": "تتر" }, "quote_currency_id": 2, "quote_currency_symbol": { "en": "irr", "fa": "ریال" }, "financial": { "last24h": { "open": 692400, "close": 687635.99, "highest": 697000, "lowest": 687125, "quote_volume": 773313057479, "base_volume": 1117614.7862, "change_percent": -0.76 } }, "price_step": 687, "amount_step": 1.45, "tv_symbol": { "ramzinex": "usdtirr", "international": "BINANCE:usdcUSDT", "charts": { "tradingview": { "source": "BINANCE", "symbol": "usdcUSDT" }, "bitycle": { "source": "binance_spot", "symbol": "USDCUSDT" } } }, "show_order": 51, "url_name": "tether-usdt", "crypto_box": 0, "price_precision": 0, "is_delist": 0 }, "pair_name": { "en": "tether/rial", "fa": "تتر(دلار)" }, "pair_id": 11, "type_id": 1, "type_id_v2": 11, "type_v2_all_lang": { "en": "limit", "fa": " محدود" }, "type": "خرید", "type_en": "buy", "amount": "70.46 usdt", "stop_price": null, "limit_price": null, "stop_limit_price": null, "amount_nr": 70.45, "total_quote_amount_nr": 845519, "amount_quote_nr": 845519, "average_price": "12,000 irr", "average_price_nr": 12000.016889039012, "order_price": 12000, "order_price_nr": 12000, "total_payment": "0 irr", "total_payment_nr": 0, "net_received": "0.00 usdt", "net_received_nr": 0, "commission_currency_id": 9, "commission_nr": 0, "commission_percentage_nr": 0, "filled_nr": 0, "created_at": "03-08-01 17:32", "created_at_ms": 1729605762, "status": { "fa_name": "باز", "id": 1 }, "status_id": 1, "account_id": 4084, "reference_id": "15641447-d6ea-4575-9d3b-266f55297ca4", "percent": "0 %", "percent_num": 0, "cancel_route": "https://ramzinex.ir/exchange/order/cancelOrder/811253947" }, ] } }, "LimitRes1": { "summary": "success", "value": { "data": { "order_id": 811235995 }, "status": 0 } }, "LimitRes2": { "summary": "عدم رعایت حداقل ارزش سفارش", "value": { "description": { "en": "100000 rial is required ", "fa": "خطا در ثبت سفارش؛ حداقل ارزش سفارش 100000 ریال است." }, "status": -9 } }, "MarketRes1": { "summary": "سفارش موفقیت آمیز", "value": { "data": { "order_id": 811289310 }, "status": 0 } }, "MarketRes2": { "summary": "خطا در ثبت سفارش(بدنه‌ی اشتباه)", "value": { "description": { "fa": "خطا در ثبت سفارش", "en": "general error in submit" }, "status": -11 } }, "CancelOrderRes1": { "summary": "لغو موفق سفارش", "value": { "description": "ok", "status": 0, "data": [] } }, "CancelAllOrdersRes1": { "summary": "لغو موفق تمامی سفارشات", "value": { "status": 0, "data": [], "count": 0 } }, "CancelOrderRes2": { "summary": "آی‌دی سفارش اشتباه است.", "value": { "description": { "en": "the order is not open", "fa": "سفارش شما باز نیست و امکان کنسل ندارد(قبلا اجرا شده ی کامل و یا جزیی بوده و یا قبلا کنسل شده است)" }, "status": -3, "data": [] } }, "CancelWithdrawEx1": { "summary": "مدت زمان لغو برداشت سپری نشده است.", "value": { "status": -193, "description": { "fa": "لطفا 132ثانیه ی دیگر امتحان کنید", "en": "please try 132seconds later" } } }, "CancelWithdrawEx2": { "summary": "سفارش پیشتر لغو شده است.", "value": { "status": -3 } }, "CancelWithdrawEx3": { "summary": "برداشت با موفقیت لغو شد.", "value": { "status": 0 } }, "updateDepositsEx": { "summary": "بروزرسانی موفقیت آمیز", "value": { "status": 0 } }, "BonusesRes": { "summary": "بروزرسانی موفقیت آمیز", "value": { "status": 0, "count": 41, "data": [ { "amount": "2.2728", "created_at": "03-06-20 21:23", "created_at_ms": 1599756782, "currency_id": 14 } ] } }, "CalculateFeeRes": { "summary": "محاسبه موفقیت‌آمیز کارمزد", "value": { "status": true, "description": null, "data": { "fee": 0.0029 } } }, "WithdrawReqReq": { "summary": "basic kyc error", "value": { "amount": 0.5, "address": "0x484E993a8B4b731E8e1801777722109f3953b6bF", "network_id": 303, "currency_id": 166, "tag": "1234", "no_tag": false } }, "WithdrawCreateRes": { "summary": "درخواست برداشت ثبت شد", "value": { "status": 0, "data": { "withdraw_id": 8389403, "verification_status": { "cell_number": "09123456789", "remained": 300, "verified": false }, "sms_verification": true } } }, "WithdrawRequestErrorRes": { "summary": "خطا در ثبت درخواست برداشت", "value": { "status": -10, "description": { "fa": "اطلاعات وارد شده درست نیست.", "en": "Validation Failed" }, "errors": ["The amount field is required."] } }, "VerifyWithdrawRes": { "summary": "برداشت با موفقیت تأیید شد", "value": { "success": true } }, "VerifyWithdrawErrorRes": { "summary": "کد تأیید نادرست است", "value": { "status": -1, "description": { "fa": "کد ارائه شده نادرست است", "en": "Code is not correct" } } }, "VerifyWithdrawEx": { "summary": "verify withdraw", "value": { "code" : "557018", "gaCode" : "394570" } }, "MarketOrderEx": { "summary": "verify withdraw", "value": { "pair_id" : 11, "amount" : 2, "type": "sell" } }, "LimitOrderEx": { "summary": "verify withdraw", "value": { "pair_id":12, "amount":0.0460, "price":12000, "type":"buy" } }, "WithdrawListReq": { "summary": "فیلترهای فهرست برداشت‌ها", "value": { "currency_id": 9, "limit": 10, "offset": 0, "exclude_rial": false, "type": 0, "created_at_from": "2026-01-01T00:00:00+03:30", "created_at_to": "2026-01-31T23:59:59+03:30", "state_id": 1 } }, "GetSellAndBuy": { "summary": "sell and buy", "value": { "data": { "buys": [ [ 631000.0, 365.84, 230845039.99999997, false, null, 5.0, 1727945696541 ], [ 630604.0, 23.91, 15077741.64, false, null, 0.0, 1727945561696 ] ], "sells": [ [ 640000.0, 6789.5199, 4345292736.0, false, null, 87.0, 1727945621848 ], [ 635000.0, 8051.66, 5112804100.0, false, null, 102.0, 1727945044697 ] ] }, "status": 0 } }, "GetSellAndBuyAll": { "summary": "sell and buy all", "value": { "10": { "buys": [ [ 90281, 25, 2257025, false, null, 9, 1730015490062 ], [ 90234, 90, 8121060, false, null, 15, 1730015490062 ], [ 90209, 15, 1353135, false, null, 8, 1730015490062 ], [ 90132, 18, 1622376, false, null, 8, 1730015490062 ], [ 90122, 15, 1351830, false, null, 8, 1730015490062 ], [ 90089, 38, 3423382, false, null, 11, 1730015490062 ] ], "sells": [ [ 92499, 801, 74091699, false, null, 32, 1730015490062 ], [ 92300, 2547.63, 235146249, false, null, 47, 1730015490062 ], [ 92248, 541.18, 49922772.64, false, null, 27, 1730015679083 ], [ 92245, 700, 64571500, false, null, 30, 1730015723650 ] ] }, "101": { "buys": [ [ 70, 19.02709, 1331.8963, false, null, 1, 1730015499493 ], [ 50, 91000, 4550000, false, null, 12, 1730015499493 ], [ 10, 100000, 1000000, false, null, 7, 1730015499493 ], [ 4, 600000, 2400000, false, null, 9, 1730015499493 ], [ 2, 500000, 1000000, false, null, 7, 1730015499493 ] ], "sells": [ [ 7850000, 2, 15700000, false, null, 18, 1730015499493 ], [ 7800000, 1.5912, 12411360, false, null, 17, 1730015499493 ], [ 7799999, 0.0199, 155219.9801, false, null, 4, 1730015499493 ], [ 7766540, 13.723, 106580228.42, false, null, 36, 1730015499493 ], [ 7600000, 10.9667, 83346920, false, null, 33, 1730015499493 ], [ 7594999, 0.2089, 1586595.2911, false, null, 8, 1730015499493 ], [ 7519940, 20.7941, 156370384.354, false, null, 41, 1730015499493 ], [ 7500000, 29.946, 224595000, false, null, 47, 1730015499493 ], [ 7450000, 16, 119200000, false, null, 37, 1730015499493 ], [ 6910000, 0.5, 3455000, false, null, 11, 1730015499493 ], [ 6900000, 2.32, 16008000, false, null, 18, 1730015499493 ], [ 5983960, 0.1985, 1187816.06, false, null, 7, 1730015499493 ], [ 5965676, 0.1923, 1147199.4948, false, null, 7, 1730015499493 ], [ 5196185, 96.2244, 499999783.914, false, null, 62, 1730015899695 ] ] }, } }, "GetTrades": { "summary": "sell and buy", "value": { "data": [ [ 632861, 23.4799, "2024-10-03 11:30:43", "buy", 1727955043, "1af804c887c0460161fff401dfcca7e8" ], [ 632810, 10.4, "2024-10-03 11:30:38", "sell", 1727955038, "db6f46a3267ccab3540e46dc32971209" ] ], "status": 0 } }, "Statistic24Res": { "summary": "Statistic24 Response", "value": { "data": { "10": { "open": 44738111378, "close": 46000000000, "highest": 46250000000, "lowest": 44524539000, "baseVolume": 1.1343021, "quoteVolume": 51610421320.24, "changePercent": 2.82 }, "106": { "open": 92792, "close": 94710, "highest": 97400, "lowest": 91800, "baseVolume": 945986.74, "quoteVolume": 89292945529.7, "changePercent": 2.19 } }, "status": 0 } }, "ChartHistoryRes": { "summary": "ChartHistory Response", "value": { "c": [ 40792, 40973, 40394, 40804 ], "h": [41200, 41200, 41118, 41000], "l": [40791, 40792, 40394, 40394], "o": [40792, 40792, 40973, 40394], "s": "ok", "t": [1728389453, 1728392561, 1728396005, 1728399681], "v": [24159.9025, 8416.6203, 4739.7176, 14744.8487], } }, "GetCurrencies": { "summary": "get currencies", "value": { "status": 0, "data": { "currencies": [ { "id": 1, "name": { "en": "bitcoin", "fa": "بیت کوین" }, "standard_name": "bitcoin", "precision": 5, "symbol": "btc", "logo": "https://public-assets.ramzinex.ir/public/currencies/logo/btc.png", "color": "FF8C00", "related_pairs": [ 2, 12 ], "rial_related_pair": 2, "withdraw": 1, "default_network_id": null, "deposit": 1, "slug": "bitcoin-btc", "currency_box": 0 }, { "id": 2, "name": { "en": "rial", "fa": "ریال" }, "standard_name": "rial", "precision": 0, "symbol": "irr", "logo": "https://public-assets.ramzinex.ir/public/currencies/logo/irr.png", "color": "f8bbd0", "related_pairs": [], "rial_related_pair": null, "withdraw": 1, "default_network_id": null, "deposit": 1, "slug": null, "currency_box": 0 }, ] } } }, "GetACurrency": { "summary": "get a currency", "value": { "status": 0, "data": { "currency": { "id": 9, "name": { "en": "tether", "fa": "تتر" }, "standard_name": "tether", "precision": 2, "symbol": "usdt", "logo": "https://public-assets.ramzinex.ir/public/currencies/logo/usdt.png", "color": "b2ebf2", "related_pairs": [ 11 ], "rial_related_pair": 11, "withdraw": 1, "default_network_id": null, "deposit": 1, "slug": "tether-usdt", "currency_box": 0 } } } }, "GetPairs": { "summary": "get pairs", "value": { "status": 0, "data": { "pairs": [ { "id": 614, "name": { "fa": "رمزفیکس", "en": "ramzfix/rial" }, "logo": "https://public-assets.ramzinex.ir/public/currencies/logo/rfx.png", "trading_chart_settings": { "ramzinex": "rfxirr", "international": "null", "charts": [] }, "quote_currency": { "id": 2, "symbol": { "en": "irr", "fa": "ریال" }, "standard_name": "rial", "precision": 0 }, "base_currency": { "id": 406, "symbol": { "en": "rfx", "fa": "رمزفیکس" }, "standard_name": "ramzfix", "precision": 0 }, "slug": "ramzfix", "crypto_box": 0, "is_p2p_enabled": false }, { "id": 678, "name": { "fa": "طلا ۱۸", "en": "gold/rial" }, "logo": "https://public-assets.ramzinex.ir/public/currencies/logo/gold.png", "trading_chart_settings": { "ramzinex": "goldirr", "international": "null", "charts": [] }, "quote_currency": { "id": 2, "symbol": { "en": "irr", "fa": "ریال" }, "standard_name": "rial", "precision": 0 }, "base_currency": { "id": 439, "symbol": { "en": "gold", "fa": "طلا ۱۸" }, "standard_name": "gold", "precision": 2 }, "slug": "gold", "crypto_box": 0, "is_p2p_enabled": false }, ] } } }, "GetAPair": { "summary": "get a pair", "value": { "status": 0, "data": { "pair": { "id": 2, "precision": 5, "logo": "https://public-assets.ramzinex.ir/public/currencies/logo/btc.png", "slug": "bitcoin-btc", "crypto_box": 0, "name": { "fa": "بیت کوین", "en": "bitcoin/rial" }, "trading_chart_settings": { "ramzinex": "btcirr", "international": "BINANCE:BTCUSDT", "charts": { "bitycle": { "source": "binance_spot", "symbol": "BTCUSDT" }, "tradingview": { "source": "BINANCE", "symbol": "BTCUSDT" } } }, "quote_currency": { "id": 2, "symbol": { "en": "irr", "fa": "ریال" }, "standard_name": "rial", "precision": 0 }, "base_currency": { "id": 1, "symbol": { "en": "btc", "fa": "بیت کوین" }, "standard_name": "bitcoin" }, "is_p2p_enabled": false } } } }, "GetPrices": { "summary": "get prices", "value": { "status": 0, "data": { "btcirr": { "sell": 9353000000, "buy": 9310000000, "pair_id": 2, "name": { "fa": "بیت کوین", "en": "bitcoin/rial" }, "icon": "/exchange/img/coins/btc.png", "web_link": "https://ramzinex.ir/exchange/orderbook/2", "base_precision": 5, "quote_precision": 0, "base_currency_id": 1, "base_currency_symbol": { "en": "btc", "fa": "بیت کوین" }, "quote_currency_id": 2, "quote_currency_symbol": { "en": "irr", "fa": "ریال" }, "financial": { "last24h": { "open": 9274019942, "close": 9280001000, "highest": 9418999966, "lowest": 9103710000, "quote_volume": 3797433268, "base_volume": 1.24, "change_percent": 0.06 } }, "price_step": 9353000, "amount_step": 0.0001, "tv_symbol": { "ramzinex": "btcirr", "international": "BINANCE:BTCUSDT" }, "show_order": 50, "url_name": null } } } }, "GetMarketBuyPrice": { "summary": "get prices", "value": { "data": 695572, "status": 0 } }, "GetMarketSellPrice": { "summary": "get market sell price", "value": { "status": 0, "data": { "price": 9310000000 } } }, "PostApiKeyDetail": { "summary": "PostApiKeyDetail", "value": { "status": 0, "data": { "id": 1, "api_key": "ApiKeyVQaSauG:248030519afb1df40adeda047d3748674fc780c29bce31a4ba63f348183601af", "name": "firstTest", "withdraw": 1, "trade": 0, "cancel_order": 1, "excel_output": 0, "ip_free": 0, "address_free": 1, "alert": 0, "ips": [ "89.199.67.117", "94.182.157.67", "2.190.142.183" ], "created_at_ms": 1650456362, "updated_at_ms": 1650456362 } } }, "ApiKeyIdReq": { "summary": "ApiKeyIdReq", "value": { "api_key_id": 2505 } }, "AddressRes": { "summary": "پاسخ صحیح", "value": { "status": 0, "count": 1, "data": [ { "address": "0x521A993a8B4b731E8e1801777722109f3953b6bF", "tag": null, "has_tag": false, "currency_id": 46, "network_id": 116 } ] } }, "AddressRes2": { "summary": "ارسال نتورک آیدی با واریز غیرفعال", "value": { "status": 1, "description": { "fa": "یک یا تعدادی از نتورک های درخواستی برای واریز غیرفعال است، لطفا فقط آدرس نتورک های با واریز فعال را درخواست کنید.", "en": "" } } }, "networksRes": { "summary": "networksRes", "value": { "data": [ { "block": 40, "currency_id": 24, "deposit": 0, "deposit_min": 0, "deposit_temporarily_suspended": 0, "deposit_time": 10, "has_tag": 0, "id": 31, "name": "ERC20", "show_name": "ERC20", "withdraw": 0, "withdraw_fee": 3000, "withdraw_min": 6000, "withdraw_temporarily_suspended": 0, "withdraw_time": 5 }, { "block": 3, "contract_address": "TLa2f6VPqDgRE67v1736s7bJ8Ray5wYjU7", "currency_id": 28, "deposit": 1, "deposit_min": 0, "deposit_temporarily_suspended": 0, "deposit_time": 2.25, "has_tag": 0, "id": 36, "name": "TRC20", "show_name": "TRC20", "withdraw": 1, "withdraw_fee": 200, "withdraw_min": 2000, "withdraw_temporarily_suspended": 0, "withdraw_time": 2.15 }, { "block": 3, "contract_address": "TAFjULxiVgT4qWk6UZwjqwZXTSaGaqnVp4", "currency_id": 22, "deposit": 1, "deposit_min": 0, "deposit_temporarily_suspended": 0, "deposit_time": 2.25, "has_tag": 0, "id": 38, "name": "TRC20", "show_name": "TRC20", "withdraw": 1, "withdraw_fee": 400, "withdraw_min": 800, "withdraw_temporarily_suspended": 0, "withdraw_time": 2.15 }, ], "status": 0 } }, "RefreshFundsRes": { "summary": "RefreshFundsRes", "value": { "status": 0 } }, "RepeatedAddressRes": { "summary": "RepeatedAddressRes", "value": { "status": 2, "description": { "en": "user has already created this currency/network address", "fa": "کاربر قبلا برای این ارز ادرس ایجاد کرده است" } } }, "CreateAddressRes": { "summary": "CreateAddressRes", "value": { "status": 0, "data": [ { "address": "0x521A993a8B4b731E8e1801777722109f3953b6bF", "has_tag": false, "currency_id": 9, "network_id": 1 } ] } }, "DepositListRes": { "summary": "DepositListRes", "value": { "status": 0, "count": 20, "data": [ { "id": 10412179, "amount": "2.00", "amount_nr": 2, "address": "0x06a7730b6a119e4ca2F709BC7458B18C1a16A38d", "currency_id": 9, "txid": "club_60_9057", "link": "https://etherscan.io/tx/club_60_9057", "confirm": 1, "created_at": "03-04-08 02:34", "created_at_ms": 1719529446, "network": "ERC20" }, { "id": 10352193, "amount": "1.25", "amount_nr": 1.25, "address": "TLRhCnZYDLw34rJkVGM4jjRQTuf4DmBrsQ", "currency_id": 9, "txid": "0d6045baeceefbdffa0eedcb8510b9415ca12fc28c76d3489bf294120a134032", "link": "https://tronscan.org/#/transaction/0d6045baeceefbdffa0eedcb8510b9415ca12fc28c76d3489bf294120a134032", "confirm": 1, "created_at": "03-03-29 13:43", "created_at_ms": 1718705625, "network": "TRC20" }, { "id": 10091376, "amount": "1.00", "amount_nr": 1, "address": "0x06a7730b6a119e4ca2F709BC7458B18C1a16A38d", "currency_id": 9, "txid": "club_7668", "link": "https://etherscan.io/tx/club_7668", "confirm": 1, "created_at": "03-02-29 11:59", "created_at_ms": 1716020978, "network": "ERC20" } ] } }, "WithdrawListRes": { "summary": "WithdrawListRes", "value": { "status": 0, "count": 317, "data": [ { "id": 18958, "amount": "26,600,000", "amount_nr": 26600000, "address": "6274121165402926, 760550236170105534203001,", "has_tag": false, "verification_status": { "cell_number": "09155192066", "remained": 300, "verified": false }, "currency_id": 2, "currency": { "name": "rial", "persian_name": "ریال", "show_precision": 0, "id": 2, "symbol": "irr", "has_tag": false, "international_price": null, "withdraw_fee": 25000, "icon": "/exchange/img/coins/irr.png", "show_order": 1000, "related_pairs": [], "rial_related_pair": null }, "txid": "pg583045", "link": null, "status": { "fa_name": "انجام شده(نهایی)", "id": 6 }, "status_id": 6, "can_be_canceled": false, "is_created": false, "verifiable": false, "created_at": "99-08-24 07:11", "created_at_ms": 1605325282 } ] } }, "GeneralAccessRes": { "summary": "GeneralAccessRes", "value": { "status": 0, "data": [], "description": { "fa": "دسترسی ها با موفقیت آپدیت شد", "en": "Accesses were successfully updated" } } }, "GetTokenRes": { "summary": "GeneralAccessRes", "value": { "status": 0, "data": { "token": "abc2eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ8.eyJwcml2YXRlIjoie1wid1wiOjAsXCJ0XCI6MCxcINcIjowLFwiZVwiOjEsXCJpZlwiOjF9IiwiZ2VuZXJhbCI6IntcImFmXCI6MCxcImFsZXJ0XCI6MX0iLCJleHAiOjE2NTcxMTA5MzcsImlwIjoiW10iLCJzaWQiOiJBeWkyQVp3In0.WcEWBQjFH13WRTXMNRq55YxgvKI-5E5NdiJmktYsBpNfeLzyd7L9I-2RZJUfWruSUe7ef76QlP_iSr7udD3fmiPDqlY39FkBkE34lnAjF6xj6xv5CV573JlXjtg78JLba3-h4ga4DwlGiXL1TSPJRWAgglZknSQ4jzu6JO2KXjjie7dWKVvvbR5_Ps3Tja5QGsoIJa_UQDmqMVUZ0ucZ1MbrNSI_jZu9XXWPhEV3xQpVVTXIr5JkGuM7hNzogwel4wITdSbUtl2oiFc441JesnQpqmGibQwzlimFAe_DircKHIi3O4rSBaW873hEBPgvhphoo-mMiUNkGSEc2IkO3A" } } }, "AvailableCurrency": { "summary": "AvailableCurrencyRes", "value": { "status": 0, "data": 6.28 } }, "summaryDesktopRes": { "summary": "summaryDesktopRes", "value": { "status": 0, "data": [ { "currency_id": 1, "total_nr": 0.0001, "in_order_nr": 0 }, { "currency_id": 2, "total_nr": 11190038, "in_order_nr": 7664794 }, { "currency_id": 3, "total_nr": 0, "in_order_nr": 0 }, { "currency_id": 4, "total_nr": 0.0001, "in_order_nr": 0 }, { "currency_id": 5, "total_nr": 0, "in_order_nr": 0 }, ] }, }, "SpecialDepositRes": { "summary": "SpecialDepositRes", "value": { "status": 0, "data": { "id": 10412179, "amount": "2.00", "amount_nr": 2, "address": "0x06a7730b6a119e4ca2F709BC7458B18C1a16A38d", "currency_id": 9, "txid": "club_60_9057", "link": "https://etherscan.io/tx/club_60_9057", "confirm": 1, "created_at": "03-04-08 02:34", "created_at_ms": 1719529446 } } }, "WrongCreateNetworkRes": { "summary": "عدم ارسال شناسه‌ی رمزارز", "value": { "status": -1, "message": [ "The currency id field is required." ] } }, "SpecialWithdrawRes": { "summary": "SpecialWithdrawRes", "value": { "status": 0, "count": 2, "data": [ { "id": 8389403, "amount": "165", "amount_nr": 165, "address": "disable_gift_6877285440", "has_tag": false, "verification_status": { "cell_number": "99939037341", "remained": 300, "verified": false }, "currency_id": 7, "network_id": 10, "network_name": "dogecoin", "currency": { "name": "doge", "persian_name": "دوج کوین", "show_precision": 0, "precision": 2, "id": 7, "symbol": "doge", "has_tag": false, "international_price": null, "withdraw_fee": 10, "icon": "exchange/img/coins/doge.png", "logo": "https://public-assets.ramzinex.ir/public/currencies/logo/doge.png", "show_order": 8000, "color": "b3e5fc", "factor": 1, "url_name": "dogecoin-doge", "crypto_box": 0, "related_pairs": [ 10 ], "rial_related_pair": 10, "withdraw": 1, "deposit": 1 }, "txid": "disable_gift_withdraw_4879543923", "link": "https://blockchair.com/dogecoin/transaction/disable_gift_withdraw_4879543923", "status": { "fa_name": "انجام شده(نهایی)", "id": 6 }, "status_id": 6, "can_be_canceled": false, "is_created": false, "verifiable": false, "created_at": "03-06-25 18:40", "created_at_gar": "2024-09-15 14:10:03", "created_at_ms": 1726409403 }, { "id": 6987730, "amount": "2,000.0", "amount_nr": 2000, "address": "TJYHuRZBa2673p1pL5KT6HAbZaRFYEipzz", "has_tag": false, "verification_status": { "cell_number": "99939037341", "remained": 300, "verified": false }, "currency_id": 28, "network_id": 36, "network_name": "TRC20", "currency": { "name": "wink", "persian_name": "وینک", "show_precision": 1, "precision": 3, "id": 28, "symbol": "win", "has_tag": true, "international_price": null, "withdraw_fee": 200, "icon": "exchange/img/coins/win.png", "logo": "https://public-assets.ramzinex.ir/public/currencies/logo/win.png", "show_order": 17000, "color": "90caf9", "factor": 1, "url_name": "wink-win", "crypto_box": 0, "related_pairs": [ 48 ], "rial_related_pair": 48, "withdraw": 1, "deposit": 1 }, "txid": "bc24d864b4ace69374edbd3a5532fbb26b6cd14f9919507e26f87605d4bc003b", "link": "https://tronscan.org/#/transaction/bc24d864b4ace69374edbd3a5532fbb26b6cd14f9919507e26f87605d4bc003b", "status": { "fa_name": "انجام شده(نهایی)", "id": 6 }, "status_id": 6, "can_be_canceled": false, "is_created": false, "verifiable": false, "created_at": "02-12-09 14:36", "created_at_gar": "2024-02-28 11:06:57", "created_at_ms": 1709118417 }, ] } }, "SpecialOrder2Ex1": { "summary": "SpecialDepositRes", "value": { "status": 0, "data": { "id": 593992781, "pair": "silly dragon/rial", "pair_obj": { "sell": 7999, "buy": 7930, "pair_id": 411, "name": { "fa": "سیلی دراگون", "en": "silly dragon/rial" }, "icon": "exchange/img/coins/silly.png", "logo": "https://public-assets.ramzinex.ir/public/currencies/logo/silly.png", "web_link": "https://ramzinex.ir/exchange/orderbook/411", "base_precision": 2, "quote_precision": 0, "base_currency_id": 299, "base_currency_symbol": { "en": "silly", "fa": "سیلی دراگون" }, "quote_currency_id": 2, "quote_currency_symbol": { "en": "irr", "fa": "ریال" }, "financial": { "last24h": { "open": 8239, "close": 7918, "highest": 8500, "lowest": 7700, "quote_volume": 12801290424, "base_volume": 1590925.7277, "change_percent": -3.9 } }, "price_step": 7, "amount_step": 125, "tv_symbol": { "ramzinex": "sillyirr", "international": "kucoin:sillyUSDT", "charts": { "tradingview": { "source": "kucoin", "symbol": "sillyUSDT" }, "bitycle": { "source": "kucoin_spot", "symbol": "SILLYUSDT" } } }, "show_order": 1000, "url_name": "silly-dragon", "crypto_box": 0, "price_precision": 0, "is_delist": 0 }, "pair_name": { "en": "silly dragon/rial", "fa": "سیلی دراگون" }, "pair_id": 411, "type_id": 1, "type_id_v2": 11, "type_v2_all_lang": { "en": "limit", "fa": " محدود" }, "type": "فروش", "type_en": "sell", "amount": "1,452.36 silly", "stop_price": null, "limit_price": null, "stop_limit_price": null, "amount_nr": 1452.35, "total_quote_amount_nr": 42116987, "amount_quote_nr": 42116987, "average_price": "28,999 irr", "average_price_nr": 28999.001996681403, "order_price": 28999, "order_price_nr": 28999, "total_payment": "0.00 silly", "total_payment_nr": 0, "net_received": "0 irr", "net_received_nr": 0, "commission_currency_id": 2, "commission_nr": 0, "commission_percentage_nr": 0, "filled_nr": 0, "created_at": "03-01-06 15:09", "created_at_ms": 1711363189, "status": { "fa_name": "باز", "id": 1 }, "status_id": 1, "account_id": null, "reference_id": null, "percent": "0 %", "percent_num": 0, "cancel_route": "https://ramzinex.ir/exchange/order/cancelOrder/593992781" } } }, "FeeRes": { "summary": "FeeResSummary", "value": { "status": 0, "data": { "quotes": { "rial": { "makerPercent": 0.2, "takerPercent": 0.25, "makerRatio": 0.002, "takerRatio": 0.0025 }, "tether": { "makerPercent": 0.1, "takerPercent": 0.1, "makerRatio": 0.001, "takerRatio": 0.001 } }, "special_markets": { "339": { "makerPercent": 1, "takerPercent": 1, "makerRatio": 0.01, "takerRatio": 0.01 }, "262": { "makerPercent": 1, "takerPercent": 1, "makerRatio": 0.01, "takerRatio": 0.01 }, "91": { "makerPercent": 1, "takerPercent": 1, "makerRatio": 0.01, "takerRatio": 0.01 }, "614": { "makerPercent": 0, "takerPercent": 0, "makerRatio": 0, "takerRatio": 0 }, "309": { "makerPercent": 0.25, "takerPercent": 0.25, "makerRatio": 0.0025, "takerRatio": 0.0025 } } } } }, "TotalCommissionRes": { "summary": "TotalCommissionRes", "value": { "status": 0, "data": { "more_info_url": "string", "referral_code": "string", "referrals": [ { "coin": "بیت کوین", "income": "0.00002", "currency_id": 1 }, { "coin": "ریال", "income": "0", "currency_id": 2 }, { "coin": "تتر(اومنی)", "income": "0.00", "currency_id": 3 }, { "coin": "اتریوم", "income": "0.0020", "currency_id": 4 }, ], "ref_count": 0 } } }, "feeLevelRes": { "summary": "feeLevelRes", "value": { "status": 0, "data": { "rial": { "monthly_volume": 327209559, "levels": [ { "maker": { "sell": "0.20000", "buy": "0.20000" }, "taker": { "sell": "0.25000", "buy": "0.25000" }, "name": { "fa": "سطح 1", "en": "Level 1" }, "min_volume": "0.00000000", "max_volume": "1000000000.00000000", "current": true }, { "maker": { "sell": "0.18000", "buy": "0.18000" }, "taker": { "sell": "0.22500", "buy": "0.22500" }, "name": { "fa": "سطح 2", "en": "Level 2" }, "min_volume": "1000000000.00000000", "max_volume": "5000000000.00000000", "current": false }, { "maker": { "sell": "0.16000", "buy": "0.16000" }, "taker": { "sell": "0.20000", "buy": "0.20000" }, "name": { "fa": "سطح 3", "en": "Level 3" }, "min_volume": "5000000000.00000000", "max_volume": "10000000000.00000000", "current": false }, { "maker": { "sell": "0.14000", "buy": "0.14000" }, "taker": { "sell": "0.18000", "buy": "0.18000" }, "name": { "fa": "سطح 4", "en": "Level 4" }, "min_volume": "10000000000.00000000", "max_volume": "40000000000.00000000", "current": false }, { "maker": { "sell": "0.12500", "buy": "0.12500" }, "taker": { "sell": "0.17000", "buy": "0.17000" }, "name": { "fa": "سطح 5", "en": "Level 5" }, "min_volume": "40000000000.00000000", "max_volume": "100000000000.00000000", "current": false }, { "maker": { "sell": "0.12000", "buy": "0.12000" }, "taker": { "sell": "0.15000", "buy": "0.15000" }, "name": { "fa": "VIP1", "en": "VIP1" }, "min_volume": "100000000000.00000000", "max_volume": "200000000000.00000000", "current": false }, { "maker": { "sell": "0.10000", "buy": "0.10000" }, "taker": { "sell": "0.13500", "buy": "0.13500" }, "name": { "fa": "VIP2", "en": "VIP2" }, "min_volume": "200000000000.00000000", "max_volume": "1000000000000.00000000", "current": false }, { "maker": { "sell": "0.07500", "buy": "0.07500" }, "taker": { "sell": "0.12000", "buy": "0.12000" }, "name": { "fa": "VIP3", "en": "VIP3" }, "min_volume": "1000000000000.00000000", "max_volume": "5000000000000.00000000", "current": false }, { "maker": { "sell": "0.07000", "buy": "0.07000" }, "taker": { "sell": "0.12000", "buy": "0.12000" }, "name": { "fa": "VIP4", "en": "VIP4" }, "min_volume": "5000000000000.00000000", "max_volume": null, "current": false } ] }, "tether": { "monthly_volume": 1, "levels": [ { "maker": { "sell": "0.09500", "buy": "0.09500" }, "taker": { "sell": "0.10000", "buy": "0.10000" }, "name": { "fa": "سطح 1", "en": "Level 1" }, "min_volume": "0.00000000", "max_volume": "1000.00000000", "current": true }, { "maker": { "sell": "0.09000", "buy": "0.09000" }, "taker": { "sell": "0.09500", "buy": "0.09500" }, "name": { "fa": "سطح 2", "en": "Level 2" }, "min_volume": "1000.00000000", "max_volume": "5000.00000000", "current": false }, { "maker": { "sell": "0.08000", "buy": "0.08000" }, "taker": { "sell": "0.09000", "buy": "0.09000" }, "name": { "fa": "سطح 3", "en": "Level 3" }, "min_volume": "5000.00000000", "max_volume": "20000.00000000", "current": false }, { "maker": { "sell": "0.07500", "buy": "0.07500" }, "taker": { "sell": "0.08500", "buy": "0.08500" }, "name": { "fa": "سطح 4", "en": "Level 4" }, "min_volume": "20000.00000000", "max_volume": "50000.00000000", "current": false }, { "maker": { "sell": "0.06500", "buy": "0.06500" }, "taker": { "sell": "0.08000", "buy": "0.08000" }, "name": { "fa": "سطح 5", "en": "Level 5" }, "min_volume": "50000.00000000", "max_volume": "200000.00000000", "current": false }, { "maker": { "sell": "0.06000", "buy": "0.06000" }, "taker": { "sell": "0.07500", "buy": "0.07500" }, "name": { "fa": "سطح 6", "en": "Level 6" }, "min_volume": "200000.00000000", "max_volume": "500000.00000000", "current": false }, { "maker": { "sell": "0.05000", "buy": "0.05000" }, "taker": { "sell": "0.06500", "buy": "0.06500" }, "name": { "fa": "سطح 7", "en": "Level 7" }, "min_volume": "500000.00000000", "max_volume": "1000000.00000000", "current": false }, { "maker": { "sell": "0.04000", "buy": "0.04000" }, "taker": { "sell": "0.05500", "buy": "0.05500" }, "name": { "fa": "سطح 8", "en": "Level 8" }, "min_volume": "1000000.00000000", "max_volume": "5000000.00000000", "current": false }, { "maker": { "sell": "0.03000", "buy": "0.03000" }, "taker": { "sell": "0.04500", "buy": "0.04500" }, "name": { "fa": "سطح 9", "en": "Level 9" }, "min_volume": "5000000.00000000", "max_volume": null, "current": false } ] }, "special_markets": [ { "maker": { "sell": "0.08000", "buy": "0.00000" }, "taker": { "sell": "0.08000", "buy": "0.00000" }, "name": "رمزفیکس" }, { "maker": { "sell": "0.25000", "buy": "0.25000" }, "taker": { "sell": "0.25000", "buy": "0.25000" }, "name": "رمزباکس" }, { "maker": { "sell": "1.00000", "buy": "1.00000" }, "taker": { "sell": "1.00000", "buy": "1.00000" }, "name": "انکور پروتکل" } ] } } }, "DepositsRes": { "summary": "DepositsRes", "value": { "status": 0, "data": [ { "id": 10413843, "amount": "2.00", "amount_nr": 2, "address": "0x06a7730b6a119e4ca2F709BC7458B18C1a16A38d", "currency_id": 9, "txid": "club_60_9062", "link": "https://etherscan.io/tx/club_60_9062", "confirm": 1, "created_at": "03-04-08 14:41", "created_at_ms": 1719573105 }, { "id": 10081252, "amount": "1.00", "amount_nr": 1, "address": "0x06a7730b6a119e4ca2F709BC7458B18C1a16A38d", "currency_id": 9, "txid": "club_7636", "link": "https://etherscan.io/tx/club_7636", "confirm": 1, "created_at": "03-02-28 02:49", "created_at_ms": 1715901567 }, { "id": 10078493, "amount": "2.00", "amount_nr": 2, "address": "0x06a7730b6a119e4ca2F709BC7458B18C1a16A38d", "currency_id": 9, "txid": "club_7624", "link": "https://etherscan.io/tx/club_7624", "confirm": 1, "created_at": "03-02-27 20:40", "created_at_ms": 1715879429 }, { "id": 10077384, "amount": "2.00", "amount_nr": 2, "address": "0x06a7730b6a119e4ca2F709BC7458B18C1a16A38d", "currency_id": 9, "txid": "club_7621", "link": "https://etherscan.io/tx/club_7621", "confirm": 1, "created_at": "03-02-27 19:04", "created_at_ms": 1715873645 }, { "id": 10067544, "amount": "1.00", "amount_nr": 1, "address": "0x06a7730b6a119e4ca2F709BC7458B18C1a16A38d", "currency_id": 9, "txid": "club_7566", "link": "https://etherscan.io/tx/club_7566", "confirm": 1, "created_at": "03-02-26 12:12", "created_at_ms": 1715762573 }, { "id": 10058253, "amount": "1.00", "amount_nr": 1, "address": "0x06a7730b6a119e4ca2F709BC7458B18C1a16A38d", "currency_id": 9, "txid": "club_7359", "link": "https://etherscan.io/tx/club_7359", "confirm": 1, "created_at": "03-02-24 14:41", "created_at_ms": 1715598662 } ] } }, }, "parameters": { "PairId": { "name": "pairId", "in": "path", "description": "شناسه بازار می‌باشد و مقدار آن عدد است", "schema": { "type": "integer", "example": 11 } }, "CurrencyId": { "name": "currency_id", "in": "path", "description": "شناسه ارز می‌باشد و مقدار آن عدد است", "schema": { "type": "integer", "example": 9 } }, "CurrencyIdV2": { "name": "id", "in": "path", "required": true, "description": "شناسه ارز می‌باشد و مقدار آن عدد است", "schema": { "type": "integer", "example": 9 } }, "marketSymbol": { "name": "symbol", "in": "query", "description": "نماد انگلیسی بازار", "schema": { "type": "string", "example": "GOLDIRR" } }, "resolution": { "name": "resolution", "in": "query", "description": "تعیین بازه زمانی کندل‌ها (برحسب دقیقه). مقادیر پشتیبانی‌شده: 1، 5، 15، 30، 60، 120، 240، 720، 1D و 1W. هر مقدار دیگر به بازهٔ یک‌ساعته نگاشت می‌شود.", "schema": { "type": "string", "enum": ["1", "5", "15", "30", "60", "120", "240", "720", "1D", "1W"], "example": "60" } }, "fromDate": { "name": "from", "in": "query", "description": "زمان شروع بازه زمانی کندل‌ها", "schema": { "type": "timestamp", "example": "1724576847" } }, "toDate": { "name": "to", "in": "query", "description": "زمان پایان بازه زمانی کندل‌ها", "schema": { "type": "timestamp", "example": "1729760907" } }, "CurrencyIdQuery": { "name": "currency_id", "in": "query", "description": "شناسه ارز می‌باشد و مقدار آن عدد است", "schema": { "type": "integer", "example": 9 } }, "NetworkIdQuery": { "name": "network_id", "in": "query", "description": "شناسه شبکه می‌باشد و مقدار آن عدد است", "schema": { "type": "integer", "example": 216 } }, "WithdrawQuery": { "name": "withdraw", "in": "query", "description": "شناسه یک برداشت خاص می‌باشد و مقدار آن عدد است", "schema": { "type": "integer", "example": 72385076 } }, "WithdrawBooleanQuery": { "name": "withdraw", "in": "query", "description": "وجود یا عدم وجود شبکه‌های برداشت در لیست پاسخ", "schema": { "type": "integer", "example": 1 } }, "DepositBooleanQuery": { "name": "deposit", "in": "query", "description": "وجود یا عدم وجود شبکه‌های واریز در لیست پاسخ", "schema": { "type": "integer", "example": 0 } }, "DepositQuery": { "name": "deposit_id", "in": "query", "description": "شناسه یک واریز خاص می‌باشد و مقدار آن عدد است", "schema": { "type": "integer", "example": 45238401 } }, "DepositId": { "name": "deposit_id", "in": "path", "description": "شناسه یک واریز خاص می‌باشد و مقدار آن عدد است", "schema": { "type": "integer", "example": 45238401 } }, "WithdrawId": { "name": "withdraw_id", "in": "path", "description": "شناسه یک برداشت خاص می‌باشد و مقدار آن عدد است", "schema": { "type": "integer", "example": 72385076 } }, "OrderId": { "name": "order_id", "in": "path", "description": "شناسه یک سفارش خاص می‌باشد و مقدار آن عدد است", "schema": { "type": "integer", "example": 12492304507 } }, }, "responses": { "BadRequest": { "description": "Bad request.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "NotFound": { "description": "Not found.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "Unauthorized": { "description": "Unauthorized.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "tags": [ { "name": "راهنمای ساخت و مدیریت کلیدهای API", "description": "

برای ساخت و مدیریت کلیدهای API باید به بخش مدیریت API سایت رمزینکس مراجعه کنید. برای ساخت کلید جدید بر روی دکمهٔ «ساخت کلید API» کلیک کنید.

API Management

در بخش ساخت API، لازم است که برای کلید جدید نامی منحصربه‌فرد و دلخواه انتخاب کنید. در ادامه دسترسی‌های لازم برای این کلید API از بین خواندن، برداشت، لغو سفارش و معامله انتخاب کنید. برای امنیت بیشتر در انتخاب مجوزهای دسترسی دقت کافی داشته باشید و در صورت امکان فهرستی از IPهای مجاز که با استفاده از کلید می‌توانند به اندپوینت‌های شخصی دسترسی داشته باشند را وارد کنید. در صورتی که گزینه بدون محدودیت را انتخاب کنید به معنای اعطای مجوز به تمام IPها است. توجه داشته باشید برای کلیدهایی که دسترسی «برداشت» دارند، مشخص کردن حداقل یک IP الزامی‌ست. همچنین حتما در حفاظت از کلیدهای API خود دقت کافی داشته و آن را با دیگران به اشتراک نگذارید. اگر به طور ناخواسته دیگران به کلید API شما دسترسی یافتند، از طریق بخش مدیریت API در سایت رمزینکس اقدام به حذف کلید افشاشده نمایید.

" }, { "name": "راهنمای استفاده از کلید‌ API", "description": "

برای استفاده از API های خصوصی، به دو مولفه ضروری نیاز دارید:

کلید خصوصی(API-Key): طبق راهنمای بخش قبلی، کلید خصوصی (API Key) خود را دریافت کنید.

توکن خصوصی(Private-Token): از API دریافت توکن خصوصی در بخش احراز هویت استفاده کنید.

چطور از کلید و توکن استفاده کنیم؟

کلید خصوصی و توکن خصوصی را در هدر درخواست HTTP به این صورت وارد کنید: 

Authorization2: Bearer Private-Token
x-api-key: API-Key
" }, { "name": "احراز هویت", "description": "

برای دسترسی به API ‌های خصوصی، داشتن توکن خصوصی الزامیست. برای دریافت توکن و کلید خصوصی به بخش مدیریت API مراجعه کنید.

برای دسترسی به این API ها نیاز به ارسال HTTP Header ها و ارسال کلید خصوصی و توکن خصوصی به صورت زیر است :

Authorization2: Bearer Your-Token

x-api-key: Your-Api-Key

" }, { "name": "اطلاعات بازار (عمومی)", "description": "این مجموعه برای دسترسی به اطلاعات عمومی بازار می‌باشد و برای درخواست های این مجموعه نیاز به احراز هویت و استفاده از کلید خصوصی نیست." }, { "name": "کیف پول", "description": "جمع میزان دارایی در دسترس و درحال معامله باید معادل مقدار کل دارایی باشد." }, { "name": "واریزها و برداشت‌ها", "description": "" }, { "name": "کارمزد‌ها و پاداش‌ها", "description": "" }, { "name": "سفارشات و معاملات", "description": "" }, { "name": "وب‌سوکت", "description": "

رمزینکس برای ارائه اطلاعات لحظه‌ای از وب‌سوکت استفاده می‌کند. این سرویس با استفاده از سرور Centrifugo پیاده‌سازی شده و برای زبان‌های مختلف، SDKهای رسمی متعددی ارائه شده است که فرآیند اتصال را ساده‌تر می‌کنند.

لیست SDKهای قابل استفاده برای اتصال به وب‌سوکت رمزینکس :

ماژول SDK

توضیح

centrifuge-js

برای مرورگر، NodeJS

centrifuge-python

برای استفاده در پایتون

centrifuge-java

برای استفاده در جاوا

centrifuge-golang

برای استفاده در گولنگ

اتصال به وب‌سوکت

برای اتصال به وب‌سوکت رمزینکس از آدرس زیر استفاده کنید:

پس از اتصال به وب سوکت رمزینکس، سرور Centrifuge به صورت دوره‌ای پیام‌های ping ارسال می‌کند. در صورت استفاده از SDKهای رسمی، این ابزارها خودکار به پیام‌های ping پاسخ pong می‌دهند. توجه داشته باشید که اگر در زمان ۲۵ ثانیه به پیام‌های ping پاسخ داده نشود، سرور (به دلیل مدیریت بهینه منابع) اتصال را قطع خواهد کرد. در نتیجه اگر از SDK رسمی استفاده نمی‌کنید، از ارسال پیام PONG قبل از زمان ذکر شده اطمینان حاصل فرمایید.

نکته: مکانیزم PingPong به این شکل است که پیام خالی با محتوای {} به کلاینت ارسال شده و پیام Pong نیز با همان محتوای {} است.

نمونه اتصال با Postman

  1. به بخش WebSocket در Postman بروید.
  2. آدرس wss://websocket.ramzinex.ir/websocket را وارد کنید.
  3. روی Connect کلیک کنید.
  4. پیام زیر را برای اتصال ارسال کنید: {
    'connect': {'name': 'js'},
    'id': 1
    }
  5. برای دریافت آخرین تراکنش‌ها و لیست سفارشات، پیام‌های زیر را ارسال کنید: {'subscribe':{'channel':'last-trades:11', 'recover':true, 'delta': 'fossil'}, 'id':2}

    {'subscribe':{'channel':'orderbook:11', 'recover':true, 'delta': 'fossil'}, 'id':3}

نمونه اتصال با NodeJs

npm install centrifuge import { Centrifuge } from 'centrifuge';
const client = new Centrifuge('wss://websocket.ramzinex.ir/websocket', {});
client.on('connected', (ctx) => { \n console.log('connected', ctx);
});
client.connect();

اتصال به چند کانال با استفاده از یک کلاینت:

const channels = ['public:orderbook:46', 'orderbook:2', 'orderbook:11']
const subs = channels.map(channel => {
const sub = client.newSubscription(channel, { delta: 'fossil' })
sub.subscribe()
sub.on('publication', (ctx) => {
console.log(channel, ctx.data);
})
return sub
});

استریم لیست سفارش‌ها (اردربوک)

کانال‌ با پیشوند زیر شامل اطلاعات اردربوک است و با هر تغییری در اردربوک، پیامی ارسال می‌کند:

الگوی کانال‌های اردربوک: orderbook:{pair_id}

مثال: برای دریافت تغییرات اردربوک بیت‌کوین به ریال، کافیست به کانال orderbook:2 متصل شوید.

توجه داشته باشید که استفاده از فلگ { delta: 'fossil' } در تابع newSubscription اختیاری است. با استفاده از این فلگ، اطلاعات اردربوک به صورت diff به کلاینت ارسال می‌شود.

در صورتی که از SDK استفاده نمی‌کنید پیام زیر را ارسال نمایید:

{
'id': 2,
'subscribe': { 'channel': 'orderbook:2' }
}

پارامترهای پاسخ

پارامترهای پاسخ وب‌سوکت همانند پاسخ اندپوینت buys_sells/ شامل دو آرایه sells و buys بوده که در هر یک قیمت و مقدار سفارش‌های بازار وجود دارد. سفارش‌های خرید در buys و سفارش‌های فروش در sells بازگردانده می‌شوند..

{
'sells': [ [ 640000, 6789.5199, 4345292736, false, null, 87, 1727945621848 ], [ 635000, 8051.66, 5112804100, false, null, 102, 1727945044697 ] ],
'buys': [ [ 631000, 365.84, 230845039.99999997, false, null, 5, 1727945696541 ], [ 630604, 23.91, 15077741.64, false, null, 0, 1727945561696 ] ],
}

همچنین اگر از SDK رسمی استفاده نمی‌کنید، در صورت اتصال و اشتراک صحیح، پیام‌های دریافتی از کانال به شکل زیر خواهد بود:

{
'push': {
'channel': 'orderbook:11',
'pub': {
'data': '{\"buys\": [[\"35077909990\", \"0.009433\"], [\"35078000000\", \"0.000274\"], [\"35078009660\", \"0.00057\"]], \"sells\": [[\"35020080080\", \"0.185784\"], [\"35020070060\", \"0.086916\"], [\"35020030010\", \"0.000071\"]], \"lastTradePrice\": \"35077909990\", \"lastUpdate\": 1726581829816}',
'offset': 49890
} } }

استریم لیست آخرین تراکنش‌ها (lastTrades)

الگوی کانال‌های آخرین تراکنش: last-trades:{pair_id}

مثال: برای دریافت تغییرات اردربوک تتر به ریال، کافیست به کانال last-trades:11 متصل شوید.

در صورتی که از SDK استفاده نمی‌کنید پیام زیر را ارسال نمایید:

{
'id': 3,
'subscribe': { 'channel': 'last-trades:11' }
}

پارامترهای پاسخ

{
'push': {
'channel': 'last-trades:11',
'pub': {
'data': '16E\nB:[[923501,15K@WG,1:5J@3G,q:140,\"d451e9f4872f920fe78126e173c3d5f1\"],[923500,0.029H@Jl,14K@V,1:]2oTULX;',
'offset': 111384
'delta': true
}
}
} " }, { "name": "خطاها", "description": " جدول کدهای وضعیت HTTP
کدهای وضعیت HTTP
توضیحات کد وضعیت
موفقیت آمیز 200
ساخته شد 201
درخواست نامعتبر 400
عدم احراز هویت 401
درخواست شما یافت نشد. 404
ارسال بدون پارامتر 422
خطای داخلی سرور 500
سرویس در دسترس نمی‌باشد 503
" } ] }