Welcome to the API Documentation for our crypto services platform. This document provides comprehensive details on how to interact with our API to perform a wide range of operations, including managing crypto withdrawals, retrieving requisites, handling exchanges, and more.
\nOur API is designed to provide secure, efficient, and easy-to-use access to our platform's capabilities. It supports various operations crucial for integrating crypto services into your applications. This includes endpoints for creating and managing withdrawals, listing and filtering requisites, handling currency exchanges, and estimating exchange rates.
\nRequests to our API should be made using standard HTTP methods, such as GET, POST, and DELETE. Each endpoint details the required method, parameters, and possible responses.
Our API responses are formatted in JSON, providing a clear and consistent structure for handling data. Each endpoint's documentation includes examples of successful responses and potential error messages.
\nIn case of errors, the API will return appropriate HTTP status codes along with a message describing the error. Common error codes include:
\n400 Bad Request: The request was invalid or cannot be served.
401 Unauthorized: Authentication failed or user does not have permissions for the desired action.
404 Not Found: The requested resource could not be found.
500 Internal Server Error: An error occurred on the server.
Authenticated requests must include a digital signature generated with the HMAC-SHA256 algorithm.
\nSignature Overview
\nThe signature is generated from the canonical message:
\n{HTTP_METHOD}|{REQUEST_PATH}|{DATA_TO_SIGN}\n\nHTTP_METHOD — the HTTP method used (GET, POST, PUT, DELETE, etc.)
REQUEST_PATH — the endpoint path starting from the API root (for example /api/v1/order)
DATA_TO_SIGN — serialized request parameters, built according to the rules below
\nDATA_TO_SIGN:GET requests:Include all query parameters except access_key, nonce, and empty values.
Decode parameter names and values.
\nGroup parameters by name and sort alphabetically.
\nIf duplicate keys exist, join their values with commas.
\nkey1=value1&key2=value2,value3
\nPOST, PUT, PATCH, DELETE requests:Flatten the JSON body into key–value pairs.
\nNested objects use underscore notation: parent_child=value.
Arrays are converted to comma-separated strings.
\nExclude empty or null values.
\nSort keys alphabetically and join them with &.
key1=value1&key2=value2&key3=value3
\nThe signature is generated using the HMAC-SHA256 algorithm with your private key.
\nsignature = HMAC_SHA256(message, secret_key)\n\nwheremessage = {method}|{path}|{dataToSign}
The result must be a lowercase hex-encoded string.
It must be passed in the apisign HTTP header.
apisign — required. Contains the generated HMAC-SHA256 signature.
\napikey — optional. Added automatically if the variable access_key exists in the client environment. Not used in signature calculation.
Below is the complete working example used to automatically generate the signature and add the headers before sending a request:
\nconsole.log('start');\n// === common variables ===\nconst secretKey = pm.collectionVariables.get('secret_key');\nconst method = pm.request.method;\nconst endpoint = pm.request.url.getPath();\nlet dataToSign = '';\n/**\n * Groups key-value pairs, keeping array indexes [0], [1], [] \n * and preserving their original order\n */\nfunction groupPairsWithIndex(pairs) {\n const grouped = {};\n for (const [k, v, idx, order] of pairs) {\n if (!grouped[k]) grouped[k] = [];\n grouped[k].push({ v, idx, order });\n }\n const keys = Object.keys(grouped).sort();\n const parts = [];\n for (const k of keys) {\n const items = grouped[k];\n const hasIndex = items.some(it => Number.isInteger(it.idx));\n const sorted = hasIndex\n ? items\n .map(it => ({\n ...it,\n idx: Number.isInteger(it.idx) ? it.idx : Number.MAX_SAFE_INTEGER,\n }))\n .sort((a, b) => a.idx - b.idx || a.order - b.order)\n : items.sort((a, b) => a.order - b.order);\n const joined = sorted.map(it => it.v).join(',');\n parts.push(`${k}=${joined}`);\n }\n return parts.join('&');\n}\n// flatten JSON body \n// (objects → key_subkey; arrays → comma-joined string)\nfunction flattenObject(obj, parentKey = '', res = {}) {\n for (const key of Object.keys(obj || {})) {\n const prop = parentKey ? `${parentKey}_${key}` : key;\n const val = obj[key];\n if (val === null || val === undefined) continue;\n if (Array.isArray(val)) {\n const joined = val.map(v => String(v).trim()).filter(Boolean).join(',');\n res[prop] = joined;\n } else if (typeof val === 'object') {\n flattenObject(val, prop, res);\n } else {\n const s = typeof val === 'string' ? val.trim() : String(val);\n if (s.length > 0) res[prop] = s;\n }\n }\n return res;\n}\n// === build dataToSign ===\nif (method === 'GET') {\n const qs = pm.request.url.getQueryString({ ignoreDisabled: true, encode: false }) || '';\n let order = 0;\n const pairs = qs\n .split('&')\n .filter(Boolean)\n .map(s => {\n const eq = s.indexOf('=');\n const rawK = eq >= 0 ? s.slice(0, eq) : s;\n const rawV = eq >= 0 ? s.slice(eq + 1) : '';\n let k = decodeURIComponent(rawK);\n const v = decodeURIComponent(rawV);\n // skip unnecessary params\n if (k === 'access_key' || k === 'nonce' || v === '' || v == null) return null;\n let idx = null;\n const m = k.match(/^(.+)\\[(\\d*)\\]$/);\n if (m) {\n k = m[1];\n idx = m[2] === '' ? null : Number(m[2]);\n } else if (/\\[\\]$/.test(k)) {\n k = k.replace(/\\[\\]$/, '');\n idx = null;\n }\n return [k, v, idx, order++];\n })\n .filter(Boolean);\n dataToSign = groupPairsWithIndex(pairs);\n console.log('qs', qs);\n console.log(['dataToSign GET', dataToSign]);\n} else if (['POST', 'PUT', 'PATCH', 'DELETE'].includes(method)) {\n let raw = '{}';\n try { raw = pm.request.body?.raw ?? '{}'; } catch (_) {}\n let body;\n try { body = JSON.parse(raw || '{}'); } catch (_) { body = {}; }\n const flat = flattenObject(body);\n const keys = Object.keys(flat).sort();\n dataToSign = keys.map(k => `${k}=${flat[k]}`).join('&');\n console.log(['dataToSign POST/...', dataToSign]);\n} else {\n dataToSign = '';\n}\n// === final message for signing ===\nconst message = `${method}|${endpoint}|${dataToSign}`;\nconst signature = CryptoJS.HmacSHA256(message, secretKey).toString(CryptoJS.enc.Hex);\n// === set signature ===\npm.collectionVariables.set('signature', signature);\npm.request.headers.upsert({ key: 'apisign', value: signature });\n// (optional) if apikey is stored in the collection\nconst apiKey = pm.collectionVariables.get('access_key');\nif (apiKey) pm.request.headers.upsert({ key: 'apikey', value: apiKey });\nconsole.log(['message', message]);\nconsole.log(['signature', signature]);\n\napisign must be included in every authenticated request.
apikey may be included automatically if defined in the environment (optional).
Empty or null parameters are skipped.
\nArrays are comma-joined; nested objects use underscore (_).
The signature is based only on {HTTP_METHOD}|{REQUEST_PATH}|{DATA_TO_SIGN}.
Header names are case-insensitive.
\nUpdates on system objects can be received through a WebSocket connection.
\nWebSocket URL: wss://my.kyrrex.com
\nTo connect, you need to use api_key, api_secret (which can be obtained when generating a token in your account api_keys page), user_uuid (which can be obtained by requesting /api/v2/members/me as the uuid attribute), and api_sign - this is an HMAC signature created based on canonicalString. More details in the example.
Here is an example of connecting to the WebSocket server in JavaScript using the socket.io-client library:
const io = require('socket.io-client');\nconst crypto = require('crypto');\nconst SERVER_URL = 'wss://my.kyrrex.com';\nconst api_key = 'kjdh723ncs73ncdsnc72ncs73kds32L3skD2';\nconst api_secret = 'GJSsaK3PpwOjgLK2lkPmQ5TZRtF2pPoQBZ9yyuAa';\nconst user_uuid = 'dfgkh45p8';\nconst canonicalString = `${user_uuid}|${api_key}`;\nconst ioClient = io.connect(SERVER_URL, {\n path: '/zsu/ws/v1',\n query: {\n api_key,\n api_sign: generateHmac(canonicalString, api_secret)\n },\n reconnection: true,\n reconnectionAttempts: Infinity,\n reconnectionDelay: 5000,\n reconnectionDelayMax: 10000,\n randomizationFactor: 0.5\n});\nfunction generateHmac(canonicalString, secret) {\n const hmac = crypto.createHmac('sha256', secret);\n return hmac.update(canonicalString).digest('hex');\n}\nioClient.on('connect', () => {\n console.log('connected to:', SERVER_URL);\n console.log('with this api_key:', api_key);\n});\nioClient.on('disconnect', (reason) => {\n console.log('Disconnected:', reason);\n});\nioClient.on('close', (msg) => console.log('Connection closed:', msg));\nioClient.on('connect_error', (error) => console.log('Connection error:', error));\n// Subscriptions for the selected objects, such as account, deposit_address, etc.\nioClient.on('account', (msg) => console.log('Message from server:', msg));\nioClient.on('deposit_address', (msg) => console.log('Message from server:', msg));\n\ncustomer
\ndeposit
\norder
\nwithdrawal
\ntrade
\ndeposit_address
\naccount
\nExample data for the account object received from the server:
{ \"data\": { \"version\": \"1\", \"action\": \"update\", \"object\": { \"aml_locked\": \"0.0\", \"balance\": \"82.9858332031\", \"bonus\": \"10.0\", \"coin_type\": \"crypto\", \"currency\": \"usdt\", \"launchpad\": \"0.0\", \"locked\": \"14.12\", \"name\": \"usdt\", \"savings\": \"0.0\", \"stacking\": \"0.0\", \"tag\": \"\", \"total\": \"97.1058332031\" } } }\n\nThis example demonstrates how a client can connect to the WebSocket server and process the messages received from it. Use the appropriate api_key, api_secret, and user_uuid for your connection.
This endpoint retrieves the details of the currently authenticated member.
\nRequest
\nMethod: GET
\nURL: https://my.kyrrex.com/api/v2/members/me
Response
The response will include the following fields:
activated (boolean): Indicates if the member is activated
average_holding (number): The average holding value
banned (boolean): Indicates if the member is banned
email (string): The email address of the member
fee_grid_id (number): The fee grid ID
fee_grid_note (object): Details of the fee grid including ID, market ID, name, stacking, volume, fee taker, fee maker, fee fiat system, fee fiat exchange, fee fiat provider, created at, and updated at
trading_volume (number): The trading volume
uuid (string): The UUID of the member
verified (boolean): Indicates if the member is verified
The endpoint retrieves the total balance of members in a specific output asset, such as EUR.
\n{\n \"type\": \"object\",\n \"properties\": {\n \"output_asset\": {\n \"type\": \"string\"\n },\n \"total\": {\n \"type\": \"string\"\n },\n \"accounts\": {\n \"type\": \"object\",\n \"properties\": {\n \"xrp\": {\n \"type\": \"string\"\n },\n \"xlm\": {\n \"type\": \"string\"\n },\n \"eth\": {\n \"type\": \"string\"\n },\n \"ltc\": {\n \"type\": \"string\"\n },\n \"bch\": {\n \"type\": \"string\"\n },\n \"trx\": {\n \"type\": \"string\"\n },\n \"btc\": {\n \"type\": \"string\"\n },\n \"eur\": {\n \"type\": \"string\"\n },\n \"usdt\": {\n \"type\": \"string\"\n }\n }\n },\n \"crypto\": {\n \"type\": \"object\",\n \"properties\": {\n \"total\": {\n \"type\": \"string\"\n },\n \"accounts\": {\n \"type\": \"object\",\n \"properties\": {\n \"xrp\": {\n \"type\": \"string\"\n },\n \"xlm\": {\n \"type\": \"string\"\n },\n \"eth\": {\n \"type\": \"string\"\n },\n \"ltc\": {\n \"type\": \"string\"\n },\n \"bch\": {\n \"type\": \"string\"\n },\n \"trx\": {\n \"type\": \"string\"\n },\n \"btc\": {\n \"type\": \"string\"\n },\n \"usdt\": {\n \"type\": \"string\"\n }\n }\n }\n }\n },\n \"fiat\": {\n \"type\": \"object\",\n \"properties\": {\n \"total\": {\n \"type\": \"string\"\n },\n \"accounts\": {\n \"type\": \"object\",\n \"properties\": {\n \"eur\": {\n \"type\": \"string\"\n }\n }\n }\n }\n },\n \"udr\": {\n \"type\": \"object\",\n \"properties\": {\n \"total\": {\n \"type\": \"string\"\n },\n \"accounts\": {\n \"type\": \"object\",\n \"properties\": {}\n }\n }\n }\n }\n}\nAsset against which all balances will be calculated
\n","type":"text/plain"},"key":"output_asset","value":"eur"}],"variable":[]}},"response":[{"id":"d99e3c07-68b5-4df8-9595-6265365557fc","name":"Retrieves total balances for the authenticated member","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"https://my.marinoxchange.com/api/v2/members/total_balance?output_asset=eur","protocol":"https","host":["my","marinoxchange","com"],"path":["api","v2","members","total_balance"],"query":[{"key":"output_asset","value":"eur","description":"Asset against which all balances will be calculated"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"output_asset\": \"eur\",\n \"total\": \"4438.83\",\n \"accounts\": {\n \"xrp\": \"235.0950789903159103\",\n \"xlm\": \"0.0750362495041061\",\n \"eth\": \"3193.73\",\n \"ltc\": \"0.0\",\n \"bch\": \"13.6653525787875554\",\n \"trx\": \"81.7213782040986528\",\n \"btc\": \"82.6923843934999999\",\n \"eur\": \"41.55\",\n \"usdt\": \"790.3031303915326683\"\n },\n \"crypto\": {\n \"total\": \"4397.28\",\n \"accounts\": {\n \"xrp\": \"235.0950789903159103\",\n \"xlm\": \"0.0750362495041061\",\n \"eth\": \"3193.73\",\n \"ltc\": \"0.0\",\n \"bch\": \"13.6653525787875554\",\n \"trx\": \"81.7213782040986528\",\n \"btc\": \"82.6923843934999999\",\n \"usdt\": \"790.3031303915326683\"\n }\n },\n \"fiat\": {\n \"total\": \"41.55\",\n \"accounts\": {\n \"eur\": \"41.55\"\n }\n },\n \"udr\": {\n \"total\": \"0.0\",\n \"accounts\": {}\n }\n}"}],"_postman_id":"e604f71b-18dd-4153-84fe-f33a61161c21"},{"name":"Retrieves a list of accounts for the authenticated member","id":"992c1fd5-45e5-4567-8cde-e82216850184","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://my.kyrrex.com/api/v2/members/accounts?only_positive_accounts=true&tags","urlObject":{"path":["v2","members","accounts"],"host":["https://my.kyrrex.com/api"],"query":[{"description":{"content":"Filter accounts with nonzero balance
\n","type":"text/plain"},"key":"only_positive_accounts","value":"true"},{"description":{"content":"Filter accounts by tags
\n","type":"text/plain"},"key":"tags","value":null}],"variable":[]}},"response":[{"id":"5f620f6c-4da6-4d07-9caa-46d583b7283b","name":"Retrieves a list of accounts for the authenticated member","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://my.marinoxchange.com/api/v2/members/accounts?only_positive_accounts=true&tags","protocol":"https","host":["my","marinoxchange","com"],"path":["api","v2","members","accounts"],"query":[{"key":"only_positive_accounts","value":"true","description":"Filter accounts with nonzero balance"},{"key":"tags","value":null,"description":"Filter accounts by tags"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"total_count\": 9,\n \"per_page\": 10,\n \"total_pages\": 1,\n \"page\": 1,\n \"prev_page\": null,\n \"next_page\": null,\n \"items\": [\n {\n \"aml_locked\": 0.0,\n \"balance\": 514.240678,\n \"bonus\": 0.0,\n \"coin_type\": \"crypto\",\n \"currency\": \"xrp\",\n \"launchpad\": 0.0,\n \"locked\": 6.0,\n \"name\": \"xrp\",\n \"savings\": 0.0,\n \"stacking\": 0.0,\n \"tag\": \"\",\n \"total\": 520.240678\n },\n {\n \"aml_locked\": 0.0,\n \"balance\": 0.8755,\n \"bonus\": 0.0,\n \"coin_type\": \"crypto\",\n \"currency\": \"xlm\",\n \"launchpad\": 0.0,\n \"locked\": 2374.0,\n \"name\": \"xlm\",\n \"savings\": 0.0,\n \"stacking\": 0.0,\n \"tag\": \"\",\n \"total\": 2374.8755\n },\n {\n \"aml_locked\": 0.0,\n \"balance\": 1.0,\n \"bonus\": 0.0,\n \"coin_type\": \"crypto\",\n \"currency\": \"eth\",\n \"launchpad\": 0.0,\n \"locked\": 0.0,\n \"name\": \"eth\",\n \"savings\": 0.0,\n \"stacking\": 0.0,\n \"tag\": \"\",\n \"total\": 1.0\n },\n {\n \"aml_locked\": 0.0,\n \"balance\": 0.0,\n \"bonus\": 0.0,\n \"coin_type\": \"crypto\",\n \"currency\": \"ltc\",\n \"launchpad\": 0.0,\n \"locked\": 0.0,\n \"name\": \"ltc\",\n \"savings\": 0.0,\n \"stacking\": 0.0,\n \"tag\": \"\",\n \"total\": 0.0\n },\n {\n \"aml_locked\": 0.0,\n \"balance\": 0.0368,\n \"bonus\": 0.0,\n \"coin_type\": \"crypto\",\n \"currency\": \"bch\",\n \"launchpad\": 0.0,\n \"locked\": 0.0,\n \"name\": \"Bitcoin Cash\",\n \"savings\": 0.0,\n \"stacking\": 0.0,\n \"tag\": \"\",\n \"total\": 0.0368\n },\n {\n \"aml_locked\": 0.0,\n \"balance\": 769.22288906,\n \"bonus\": 0.0,\n \"coin_type\": \"crypto\",\n \"currency\": \"trx\",\n \"launchpad\": 0.0,\n \"locked\": 1028.0,\n \"name\": \"Tron\",\n \"savings\": 0.0,\n \"stacking\": 0.0,\n \"tag\": \"\",\n \"total\": 1797.22288906\n },\n {\n \"aml_locked\": 0.0,\n \"balance\": 0.00137649,\n \"bonus\": 0.0,\n \"coin_type\": \"crypto\",\n \"currency\": \"btc\",\n \"launchpad\": 0.0,\n \"locked\": 0.0,\n \"name\": \"Bitcoin\",\n \"savings\": 0.0,\n \"stacking\": 0.0,\n \"tag\": \"\",\n \"total\": 0.00137649\n },\n {\n \"aml_locked\": 0.0,\n \"balance\": 41.55,\n \"bonus\": 0.0,\n \"coin_type\": \"fiat\",\n \"currency\": \"eur\",\n \"launchpad\": 0.0,\n \"locked\": 0.0,\n \"name\": \"eur\",\n \"savings\": 0.0,\n \"stacking\": 0.0,\n \"tag\": \"\",\n \"total\": 41.55\n },\n {\n \"aml_locked\": 0.0,\n \"balance\": 849.0260299,\n \"bonus\": 0.0,\n \"coin_type\": \"crypto\",\n \"currency\": \"usdt\",\n \"launchpad\": 0.0,\n \"locked\": 0.0,\n \"name\": \"usdt\",\n \"savings\": 0.0,\n \"stacking\": 0.0,\n \"tag\": \"\",\n \"total\": 849.0260299\n }\n ],\n \"accounts\": {\n \"crypto\": [\n {\n \"aml_locked\": 0.0,\n \"balance\": 514.240678,\n \"bonus\": 0.0,\n \"coin_type\": \"crypto\",\n \"currency\": \"xrp\",\n \"launchpad\": 0.0,\n \"locked\": 6.0,\n \"name\": \"xrp\",\n \"savings\": 0.0,\n \"stacking\": 0.0,\n \"tag\": \"\",\n \"total\": 520.240678\n },\n {\n \"aml_locked\": 0.0,\n \"balance\": 0.8755,\n \"bonus\": 0.0,\n \"coin_type\": \"crypto\",\n \"currency\": \"xlm\",\n \"launchpad\": 0.0,\n \"locked\": 2374.0,\n \"name\": \"xlm\",\n \"savings\": 0.0,\n \"stacking\": 0.0,\n \"tag\": \"\",\n \"total\": 2374.8755\n },\n {\n \"aml_locked\": 0.0,\n \"balance\": 1.0,\n \"bonus\": 0.0,\n \"coin_type\": \"crypto\",\n \"currency\": \"eth\",\n \"launchpad\": 0.0,\n \"locked\": 0.0,\n \"name\": \"eth\",\n \"savings\": 0.0,\n \"stacking\": 0.0,\n \"tag\": \"\",\n \"total\": 1.0\n },\n {\n \"aml_locked\": 0.0,\n \"balance\": 0.0,\n \"bonus\": 0.0,\n \"coin_type\": \"crypto\",\n \"currency\": \"ltc\",\n \"launchpad\": 0.0,\n \"locked\": 0.0,\n \"name\": \"ltc\",\n \"savings\": 0.0,\n \"stacking\": 0.0,\n \"tag\": \"\",\n \"total\": 0.0\n },\n {\n \"aml_locked\": 0.0,\n \"balance\": 0.0368,\n \"bonus\": 0.0,\n \"coin_type\": \"crypto\",\n \"currency\": \"bch\",\n \"launchpad\": 0.0,\n \"locked\": 0.0,\n \"name\": \"Bitcoin Cash\",\n \"savings\": 0.0,\n \"stacking\": 0.0,\n \"tag\": \"\",\n \"total\": 0.0368\n },\n {\n \"aml_locked\": 0.0,\n \"balance\": 769.22288906,\n \"bonus\": 0.0,\n \"coin_type\": \"crypto\",\n \"currency\": \"trx\",\n \"launchpad\": 0.0,\n \"locked\": 1028.0,\n \"name\": \"Tron\",\n \"savings\": 0.0,\n \"stacking\": 0.0,\n \"tag\": \"\",\n \"total\": 1797.22288906\n },\n {\n \"aml_locked\": 0.0,\n \"balance\": 0.00137649,\n \"bonus\": 0.0,\n \"coin_type\": \"crypto\",\n \"currency\": \"btc\",\n \"launchpad\": 0.0,\n \"locked\": 0.0,\n \"name\": \"Bitcoin\",\n \"savings\": 0.0,\n \"stacking\": 0.0,\n \"tag\": \"\",\n \"total\": 0.00137649\n },\n {\n \"aml_locked\": 0.0,\n \"balance\": 849.0260299,\n \"bonus\": 0.0,\n \"coin_type\": \"crypto\",\n \"currency\": \"usdt\",\n \"launchpad\": 0.0,\n \"locked\": 0.0,\n \"name\": \"usdt\",\n \"savings\": 0.0,\n \"stacking\": 0.0,\n \"tag\": \"\",\n \"total\": 849.0260299\n }\n ],\n \"fiat\": [\n {\n \"aml_locked\": 0.0,\n \"balance\": 41.55,\n \"bonus\": 0.0,\n \"coin_type\": \"fiat\",\n \"currency\": \"eur\",\n \"launchpad\": 0.0,\n \"locked\": 0.0,\n \"name\": \"eur\",\n \"savings\": 0.0,\n \"stacking\": 0.0,\n \"tag\": \"\",\n \"total\": 41.55\n }\n ],\n \"udr\": []\n }\n}"}],"_postman_id":"992c1fd5-45e5-4567-8cde-e82216850184"}],"id":"d049dbf4-13c6-4b2e-aee1-9db45cfc1557","_postman_id":"d049dbf4-13c6-4b2e-aee1-9db45cfc1557","description":""},{"name":"Assets","item":[{"name":"Retrieves a list of assets with optional filters","id":"227608b6-a6dd-423e-8e2c-7ab066877392","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://my.kyrrex.com/api/v2/assets?page=integer&per_page=integer&active_deposit=boolean&active_withdrawal=boolean","description":"This endpoint retrieves a list of assets with optional pagination and filtering parameters.
\npage (integer): The page number to retrieve.per_page (integer): The number of assets to retrieve per page.active_deposit (boolean): Filter by active deposit status.active_withdrawal (boolean): Filter by active withdrawal status.The response includes the total count of assets, pagination details, and an array of asset items. Each asset item includes information such as AML locked amount, balance, bonus, coin type, currency, launchpad status, locked amount, name, savings, stacking, tag, and total amount. Additionally, the response includes account details categorized as crypto, fiat, and udr (undefined) accounts, each containing similar asset item details.
\nExample response:
\n{\n \"total_count\": 0,\n \"per_page\": 0,\n \"total_pages\": 0,\n \"page\": 0,\n \"prev_page\": null,\n \"next_page\": null,\n \"items\": [\n {\n \"aml_locked\": 0,\n \"balance\": 0,\n \"bonus\": 0,\n \"coin_type\": \"\",\n \"currency\": \"\",\n \"launchpad\": 0,\n \"locked\": 0,\n \"name\": \"\",\n \"savings\": 0,\n \"stacking\": 0,\n \"tag\": null,\n \"total\": 0\n }\n ],\n \"accounts\": {\n \"crypto\": [\n {\n \"aml_locked\": 0,\n \"balance\": 0,\n \"bonus\": 0,\n \"coin_type\": \"\",\n \"currency\": \"\",\n \"launchpad\": 0,\n \"locked\": 0,\n \"name\": \"\",\n \"savings\": 0,\n \"stacking\": 0,\n \"tag\": null,\n \"total\": 0\n }\n ],\n \"fiat\": [\n {\n \"aml_locked\": 0,\n \"balance\": 0,\n \"bonus\": 0,\n \"coin_type\": \"\",\n \"currency\": \"\",\n \"launchpad\": 0,\n \"locked\": 0,\n \"name\": \"\",\n \"savings\": 0,\n \"stacking\": 0,\n \"tag\": null,\n \"total\": 0\n }\n ],\n \"udr\": []\n }\n}\nPagination page number
\n","type":"text/plain"},"key":"page","value":"integer"},{"description":{"content":"Number of items per page
\n","type":"text/plain"},"key":"per_page","value":"integer"},{"description":{"content":"Filter assets with active deposits
\n","type":"text/plain"},"key":"active_deposit","value":"boolean"},{"description":{"content":"Filter assets with active withdrawals
\n","type":"text/plain"},"key":"active_withdrawal","value":"boolean"}],"variable":[]}},"response":[{"id":"a967893c-973e-4038-bd55-04532c39d296","name":"Retrieves a list of assets with optional filters","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://my.marinoxchange.com/api/v2/assets?page=integer&per_page=integer&active_deposit=boolean&active_withdrawal=boolean","protocol":"https","host":["my","marinoxchange","com"],"path":["api","v2","assets"],"query":[{"key":"page","value":"integer","description":"Pagination page number"},{"key":"per_page","value":"integer","description":"Number of items per page"},{"key":"active_deposit","value":"boolean","description":"Filter assets with active deposits"},{"key":"active_withdrawal","value":"boolean","description":"Filter assets with active withdrawals"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"total_count\": 9,\n \"per_page\": 10,\n \"total_pages\": 1,\n \"page\": 1,\n \"prev_page\": null,\n \"next_page\": null,\n \"items\": [\n {\n \"aml_locked\": 0.0,\n \"balance\": 514.240678,\n \"bonus\": 0.0,\n \"coin_type\": \"crypto\",\n \"currency\": \"xrp\",\n \"launchpad\": 0.0,\n \"locked\": 6.0,\n \"name\": \"xrp\",\n \"savings\": 0.0,\n \"stacking\": 0.0,\n \"tag\": null,\n \"total\": 520.240678\n },\n {\n \"aml_locked\": 0.0,\n \"balance\": 0.8755,\n \"bonus\": 0.0,\n \"coin_type\": \"crypto\",\n \"currency\": \"xlm\",\n \"launchpad\": 0.0,\n \"locked\": 2374.0,\n \"name\": \"xlm\",\n \"savings\": 0.0,\n \"stacking\": 0.0,\n \"tag\": null,\n \"total\": 2374.8755\n },\n {\n \"aml_locked\": 0.0,\n \"balance\": 1.0,\n \"bonus\": 0.0,\n \"coin_type\": \"crypto\",\n \"currency\": \"eth\",\n \"launchpad\": 0.0,\n \"locked\": 0.0,\n \"name\": \"eth\",\n \"savings\": 0.0,\n \"stacking\": 0.0,\n \"tag\": null,\n \"total\": 1.0\n },\n {\n \"aml_locked\": 0.0,\n \"balance\": 0.0,\n \"bonus\": 0.0,\n \"coin_type\": \"crypto\",\n \"currency\": \"ltc\",\n \"launchpad\": 0.0,\n \"locked\": 0.0,\n \"name\": \"ltc\",\n \"savings\": 0.0,\n \"stacking\": 0.0,\n \"tag\": null,\n \"total\": 0.0\n },\n {\n \"aml_locked\": 0.0,\n \"balance\": 0.0368,\n \"bonus\": 0.0,\n \"coin_type\": \"crypto\",\n \"currency\": \"bch\",\n \"launchpad\": 0.0,\n \"locked\": 0.0,\n \"name\": \"Bitcoin Cash\",\n \"savings\": 0.0,\n \"stacking\": 0.0,\n \"tag\": null,\n \"total\": 0.0368\n },\n {\n \"aml_locked\": 0.0,\n \"balance\": 769.22288906,\n \"bonus\": 0.0,\n \"coin_type\": \"crypto\",\n \"currency\": \"trx\",\n \"launchpad\": 0.0,\n \"locked\": 1028.0,\n \"name\": \"Tron\",\n \"savings\": 0.0,\n \"stacking\": 0.0,\n \"tag\": null,\n \"total\": 1797.22288906\n },\n {\n \"aml_locked\": 0.0,\n \"balance\": 0.00137649,\n \"bonus\": 0.0,\n \"coin_type\": \"crypto\",\n \"currency\": \"btc\",\n \"launchpad\": 0.0,\n \"locked\": 0.0,\n \"name\": \"Bitcoin\",\n \"savings\": 0.0,\n \"stacking\": 0.0,\n \"tag\": null,\n \"total\": 0.00137649\n },\n {\n \"aml_locked\": 0.0,\n \"balance\": 41.55,\n \"bonus\": 0.0,\n \"coin_type\": \"fiat\",\n \"currency\": \"eur\",\n \"launchpad\": 0.0,\n \"locked\": 0.0,\n \"name\": \"eur\",\n \"savings\": 0.0,\n \"stacking\": 0.0,\n \"tag\": null,\n \"total\": 41.55\n },\n {\n \"aml_locked\": 0.0,\n \"balance\": 849.0260299,\n \"bonus\": 0.0,\n \"coin_type\": \"crypto\",\n \"currency\": \"usdt\",\n \"launchpad\": 0.0,\n \"locked\": 0.0,\n \"name\": \"usdt\",\n \"savings\": 0.0,\n \"stacking\": 0.0,\n \"tag\": null,\n \"total\": 849.0260299\n }\n ],\n \"accounts\": {\n \"crypto\": [\n {\n \"aml_locked\": 0.0,\n \"balance\": 514.240678,\n \"bonus\": 0.0,\n \"coin_type\": \"crypto\",\n \"currency\": \"xrp\",\n \"launchpad\": 0.0,\n \"locked\": 6.0,\n \"name\": \"xrp\",\n \"savings\": 0.0,\n \"stacking\": 0.0,\n \"tag\": null,\n \"total\": 520.240678\n },\n {\n \"aml_locked\": 0.0,\n \"balance\": 0.8755,\n \"bonus\": 0.0,\n \"coin_type\": \"crypto\",\n \"currency\": \"xlm\",\n \"launchpad\": 0.0,\n \"locked\": 2374.0,\n \"name\": \"xlm\",\n \"savings\": 0.0,\n \"stacking\": 0.0,\n \"tag\": null,\n \"total\": 2374.8755\n },\n {\n \"aml_locked\": 0.0,\n \"balance\": 1.0,\n \"bonus\": 0.0,\n \"coin_type\": \"crypto\",\n \"currency\": \"eth\",\n \"launchpad\": 0.0,\n \"locked\": 0.0,\n \"name\": \"eth\",\n \"savings\": 0.0,\n \"stacking\": 0.0,\n \"tag\": null,\n \"total\": 1.0\n },\n {\n \"aml_locked\": 0.0,\n \"balance\": 0.0,\n \"bonus\": 0.0,\n \"coin_type\": \"crypto\",\n \"currency\": \"ltc\",\n \"launchpad\": 0.0,\n \"locked\": 0.0,\n \"name\": \"ltc\",\n \"savings\": 0.0,\n \"stacking\": 0.0,\n \"tag\": null,\n \"total\": 0.0\n },\n {\n \"aml_locked\": 0.0,\n \"balance\": 0.0368,\n \"bonus\": 0.0,\n \"coin_type\": \"crypto\",\n \"currency\": \"bch\",\n \"launchpad\": 0.0,\n \"locked\": 0.0,\n \"name\": \"Bitcoin Cash\",\n \"savings\": 0.0,\n \"stacking\": 0.0,\n \"tag\": null,\n \"total\": 0.0368\n },\n {\n \"aml_locked\": 0.0,\n \"balance\": 769.22288906,\n \"bonus\": 0.0,\n \"coin_type\": \"crypto\",\n \"currency\": \"trx\",\n \"launchpad\": 0.0,\n \"locked\": 1028.0,\n \"name\": \"Tron\",\n \"savings\": 0.0,\n \"stacking\": 0.0,\n \"tag\": null,\n \"total\": 1797.22288906\n },\n {\n \"aml_locked\": 0.0,\n \"balance\": 0.00137649,\n \"bonus\": 0.0,\n \"coin_type\": \"crypto\",\n \"currency\": \"btc\",\n \"launchpad\": 0.0,\n \"locked\": 0.0,\n \"name\": \"Bitcoin\",\n \"savings\": 0.0,\n \"stacking\": 0.0,\n \"tag\": null,\n \"total\": 0.00137649\n },\n {\n \"aml_locked\": 0.0,\n \"balance\": 849.0260299,\n \"bonus\": 0.0,\n \"coin_type\": \"crypto\",\n \"currency\": \"usdt\",\n \"launchpad\": 0.0,\n \"locked\": 0.0,\n \"name\": \"usdt\",\n \"savings\": 0.0,\n \"stacking\": 0.0,\n \"tag\": null,\n \"total\": 849.0260299\n }\n ],\n \"fiat\": [\n {\n \"aml_locked\": 0.0,\n \"balance\": 41.55,\n \"bonus\": 0.0,\n \"coin_type\": \"fiat\",\n \"currency\": \"eur\",\n \"launchpad\": 0.0,\n \"locked\": 0.0,\n \"name\": \"eur\",\n \"savings\": 0.0,\n \"stacking\": 0.0,\n \"tag\": null,\n \"total\": 41.55\n }\n ],\n \"udr\": []\n }\n}"}],"_postman_id":"227608b6-a6dd-423e-8e2c-7ab066877392"},{"name":"Retrieves information about a specific asset","id":"41b640e6-966b-4971-89f1-7d34a8af9bf2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://my.kyrrex.com/api/v2/assets/{code}","description":"This endpoint retrieves details of a specific asset identified by its code.
\nMethod: GET
\nURL: https://my.kyrrex.com/api/v2/assets/{code}
The response will include the details of the asset, such as asset ID, name, precision, and type. Additionally, it provides information about the asset's digital chains, including their active status, minimum deposit and withdrawal amounts, and tag requirements.
\nExample response:
\n{\n \"asset_id\": \"\",\n \"dchains\": [\n {\n \"active_deposit\": true,\n \"active_withdrawal\": true,\n \"aml_active\": true,\n \"asset_id\": \"\",\n \"chain\": null,\n \"confirmations_deposit\": 0,\n \"confirmations_withdrawal\": 0,\n \"contact_aml\": null,\n \"contract_address\": null,\n \"dchain_id\": \"\",\n \"digit\": 0,\n \"display_name\": \"\",\n \"dtype\": \"\",\n \"min_deposit\": 0,\n \"min_withdrawal\": 0,\n \"tag\": null,\n \"tag_require\": true,\n \"tag_visible\": true\n }\n ],\n \"name\": \"\",\n \"precision\": 0,\n \"tag\": null,\n \"type\": \"\"\n}\n\nThe endpoint retrieves a list of markets with optional pagination and filtering parameters.
\nThe response for this request can be documented as a JSON schema as follows:
\n{\n \"type\": \"object\",\n \"properties\": {\n \"total_count\": {\n \"type\": \"integer\"\n },\n \"per_page\": {\n \"type\": \"integer\"\n },\n \"total_pages\": {\n \"type\": \"integer\"\n },\n \"page\": {\n \"type\": \"integer\"\n },\n \"prev_page\": {\n \"type\": [\"integer\", \"null\"]\n },\n \"next_page\": {\n \"type\": [\"integer\", \"null\"]\n },\n \"items\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"active\": {\n \"type\": \"boolean\"\n },\n \"available_quote_balance\": {\n \"type\": \"integer\"\n },\n \"base_asset\": {\n \"type\": \"string\"\n },\n \"base_asset_tag\": {\n \"type\": [\"string\", \"null\"]\n },\n \"base_precision\": {\n \"type\": \"integer\"\n },\n \"id\": {\n \"type\": \"string\"\n },\n \"market\": {\n \"type\": \"string\"\n },\n \"name\": {\n \"type\": \"string\"\n },\n \"quote_asset\": {\n \"type\": \"string\"\n },\n \"quote_asset_tag\": {\n \"type\": [\"string\", \"null\"]\n },\n \"quote_precision\": {\n \"type\": \"integer\"\n }\n },\n \"required\": [\"active\", \"base_asset\", \"base_precision\", \"id\", \"market\", \"name\", \"quote_asset\", \"quote_precision\"]\n }\n }\n },\n \"required\": [\"total_count\", \"per_page\", \"total_pages\", \"page\", \"items\"]\n}\nPagination page number
\n","type":"text/plain"},"key":"page","value":null},{"description":{"content":"Number of items per page
\n","type":"text/plain"},"key":"per_page","value":null},{"description":{"content":"Filter only active markets
\n","type":"text/plain"},"key":"active","value":null},{"description":{"content":"Mutually exclusive with base_asset and quote_asset. Filters markets including the specified asset as either base or quote currency.
\n","type":"text/plain"},"key":"asset","value":null},{"description":{"content":"Filters markets including the specified asset as the base currency.
\n","type":"text/plain"},"key":"base_asset","value":null},{"description":{"content":"Filters markets including the specified asset as the quote currency.
\n","type":"text/plain"},"key":"quote_asset","value":null},{"description":{"content":"Filters markets by asset type (crypto, fiat).
\n","type":"text/plain"},"key":"type","value":null},{"description":{"content":"Filters markets by tags
\n","type":"text/plain"},"key":"tags","value":null}],"variable":[]}},"response":[{"id":"356c5db3-6265-4726-b806-531568d54726","name":"Retrieves a list of markets","originalRequest":{"method":"GET","header":[],"url":""},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"total_count\": 18,\n \"per_page\": 2,\n \"total_pages\": 9,\n \"page\": 1,\n \"prev_page\": null,\n \"next_page\": 2,\n \"items\": [\n {\n \"active\": true,\n \"available_quote_balance\": 0.9,\n \"base_asset\": \"usdt\",\n \"base_asset_tag\": null,\n \"base_precision\": 8,\n \"id\": \"usdteur\",\n \"market\": \"usdteur\",\n \"name\": \"USDT/EUR\",\n \"quote_asset\": \"eur\",\n \"quote_asset_tag\": null,\n \"quote_precision\": 4\n },\n {\n \"active\": true,\n \"available_quote_balance\": 0.9,\n \"base_asset\": \"trx\",\n \"base_asset_tag\": null,\n \"base_precision\": 8,\n \"id\": \"trxeur\",\n \"market\": \"trxeur\",\n \"name\": \"TRX/EUR\",\n \"quote_asset\": \"eur\",\n \"quote_asset_tag\": null,\n \"quote_precision\": 6\n }\n ]\n}"}],"_postman_id":"2ecc38fe-6c8e-43ca-be20-5f91d2a5c646"},{"name":"Retrieves information about a specific market","id":"d0146951-305a-4577-a2f1-a723d2818e9e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://my.kyrrex.com/api/v2/markets/info?market","description":"This endpoint retrieves information about a specific market.
\nMethod: GET
\nURL: https://my.kyrrex.com/api/v2/markets/info?market
The response will include the following fields:
\nactive (boolean): Indicates if the market is active.
available_quote_balance (number): The available quote balance.
base_asset (string): The base asset for the market.
base_precision (number): The precision for the base asset.
id (string): The ID of the market.
market (string): The market name.
name (string): The name of the market.
quote_asset (string): The quote asset for the market.
quote_precision (number): The precision for the quote asset.
Market identifier
\n","type":"text/plain"},"key":"market","value":null}],"variable":[]}},"response":[{"id":"97eda206-d3df-4156-90e1-b9356fa6f090","name":"Retrieves information about a specific market","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://my.kyrrex.com/api/v2/markets/info?market","host":["https://my.kyrrex.com/api"],"path":["v2","markets","info"],"query":[{"key":"market","value":null,"description":"Market identifier"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"active\": true,\n \"available_quote_balance\": 0.9,\n \"base_asset\": \"trx\",\n \"base_asset_tag\": null,\n \"base_precision\": 8,\n \"id\": \"trxeur\",\n \"market\": \"trxeur\",\n \"name\": \"TRX/EUR\",\n \"quote_asset\": \"eur\",\n \"quote_asset_tag\": null,\n \"quote_precision\": 6\n}"}],"_postman_id":"d0146951-305a-4577-a2f1-a723d2818e9e"}],"id":"405ffe51-f474-4c59-91bd-2084201fa555","_postman_id":"405ffe51-f474-4c59-91bd-2084201fa555","description":""},{"name":"Deposit addresses","item":[{"name":"Retrieves a list of deposit addresses","id":"e448b0dd-340f-414c-9bbb-376d12a5ad15","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://my.kyrrex.com/api/v2/deposit_addresses?page&per_page&dchains&gateway","description":"This endpoint retrieves a list of deposit addresses with the option to paginate the results.
\npage (optional): The page number for paginating the results.
per_page (optional): The number of items to include per page.
dchains (optional): Filter by specific dchains.
gateway (optional): Filter by gateway.
The response is a JSON object with the following properties:
\nlimit (number): The maximum number of items to return.
total_count (number): The total count of deposit addresses.
per_page (number): The number of items per page.
total_pages (number): The total number of pages.
page (number): The current page number.
prev_page (null): The previous page number, if available.
next_page (null): The next page number, if available.
items (array): An array of deposit address objects with the following properties:
address (string): The deposit address.
asset (string): The asset associated with the deposit address.
dchain (string): The dchain associated with the deposit address.
expired_at (null): The expiration date of the deposit address, if applicable.
name (null): The name associated with the deposit address, if available.
tag (null): The tag associated with the deposit address, if available.
type (string): The type of the deposit address.
uuid (number): The unique identifier for the deposit address.
{\n \"type\": \"object\",\n \"properties\": {\n \"limit\": { \"type\": \"number\" },\n \"total_count\": { \"type\": \"number\" },\n \"per_page\": { \"type\": \"number\" },\n \"total_pages\": { \"type\": \"number\" },\n \"page\": { \"type\": \"number\" },\n \"prev_page\": { \"type\": \"null\" },\n \"next_page\": { \"type\": \"null\" },\n \"items\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"address\": { \"type\": \"string\" },\n \"asset\": { \"type\": \"string\" },\n \"dchain\": { \"type\": \"string\" },\n \"expired_at\": { \"type\": \"null\" },\n \"name\": { \"type\": \"null\" },\n \"tag\": { \"type\": \"null\" },\n \"type\": { \"type\": \"string\" },\n \"uuid\": { \"type\": \"number\" }\n }\n }\n }\n }\n}\n\nPagination page number
\n","type":"text/plain"},"key":"page","value":null},{"description":{"content":"Number of items per page
\n","type":"text/plain"},"key":"per_page","value":null},{"description":{"content":"Filters addresses by blockchain identifiers
\n","type":"text/plain"},"key":"dchains","value":null},{"description":{"content":"Filters addresses by gateway
\n","type":"text/plain"},"key":"gateway","value":null}],"variable":[]}},"response":[{"id":"7b432b44-09c6-4996-83b7-7e4490131907","name":"Retrieves a list of deposit addresses","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://my.kyrrex.com/api/v2/deposit_addresses?page&per_page&dchains&gateway","host":["https://my.kyrrex.com/api"],"path":["v2","deposit_addresses"],"query":[{"key":"page","value":null,"description":"Pagination page number"},{"key":"per_page","value":null,"description":"Number of items per page"},{"key":"dchains","value":null,"description":"Filters addresses by blockchain identifiers"},{"key":"gateway","value":null,"description":"Filters addresses by gateway"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"limit\": 7,\n \"total_count\": 1,\n \"per_page\": 2,\n \"total_pages\": 1,\n \"page\": 1,\n \"prev_page\": null,\n \"next_page\": null,\n \"items\": [\n {\n \"address\": \"TQrqHrKwZ99GDbec7u77JH85k2e7gYixYo\",\n \"asset\": \"usdt\",\n \"dchain\": \"trc20usdt\",\n \"expired_at\": null,\n \"name\": null,\n \"tag\": null,\n \"type\": \"crypto_address\",\n \"uuid\": 2174\n }\n ]\n}"}],"_postman_id":"e448b0dd-340f-414c-9bbb-376d12a5ad15"},{"name":"Creates a new deposit address","id":"4035e55f-47c8-4b76-b1c3-ab3cbc609e36","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://my.kyrrex.com/api/v2/deposit_addresses?dchain","description":"This endpoint allows you to create deposit addresses with specific parameters.
\nThe response will be a JSON object with the following properties:
\naddress (string): The deposit address created.
\nasset (string): The asset associated with the deposit address.
\ndchain (string): The blockchain network for which the deposit address is created.
\nexpired_at (null or string): The expiration date of the deposit address, if applicable.
\nname (null or string): The name associated with the deposit address, if provided.
\ntag (null or string): The tag associated with the deposit address, if provided.
\ntype (string): The type of deposit address created.
\nuuid (number): The unique identifier for the deposit address.
\n{\n \"type\": \"object\",\n \"properties\": {\n \"address\": { \"type\": \"string\" },\n \"asset\": { \"type\": \"string\" },\n \"dchain\": { \"type\": \"string\" },\n \"expired_at\": { \"anyOf\": [{ \"type\": \"null\" }, { \"type\": \"string\" }] },\n \"name\": { \"anyOf\": [{ \"type\": \"null\" }, { \"type\": \"string\" }] },\n \"tag\": { \"anyOf\": [{ \"type\": \"null\" }, { \"type\": \"string\" }] },\n \"type\": { \"type\": \"string\" },\n \"uuid\": { \"type\": \"number\" }\n }\n}\n\nBlockchain identifier
\n","type":"text/plain"},"key":"dchain","value":null}],"variable":[]}},"response":[{"id":"de3d654e-4da4-42f7-acb9-4e6f8450f76d","name":"Creates a new deposit address","originalRequest":{"method":"POST","header":[],"url":{"raw":"https://my.kyrrex.com/api/v2/deposit_addresses?dchain","host":["https://my.kyrrex.com/api"],"path":["v2","deposit_addresses"],"query":[{"key":"dchain","value":null,"description":"Blockchain identifier"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"address\": \"TQrqHrKwZ99GDbec7u77JH85k2e7gYixYo\",\n \"asset\": \"usdt\",\n \"dchain\": \"trc20usdt\",\n \"expired_at\": null,\n \"name\": null,\n \"tag\": null,\n \"type\": \"crypto_address\",\n \"uuid\": 2174\n}"}],"_postman_id":"4035e55f-47c8-4b76-b1c3-ab3cbc609e36"}],"id":"b89c085a-f8b1-485f-a5b5-1c67d88b9fb9","_postman_id":"b89c085a-f8b1-485f-a5b5-1c67d88b9fb9","description":""},{"name":"Transaction","item":[{"name":"Retrieves a list of deposit transactions","id":"9ae49b24-fc16-4c6f-8aa0-d42434f14ae6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://my.kyrrex.com/api/v2/transactions?page= &per_page= &asset= &status= &from= &to= &sort= &sort_by= ","description":"This endpoint retrieves a list of transactions based on the provided parameters.
\npage (optional): The page number for paginated results.
per_page (optional): The number of transactions to be included per page.
asset (optional): Filter transactions by asset type.
status (optional): Filter transactions by status.
from (optional): Filter transactions created from this date.
to (optional): Filter transactions created up to this date.
sort (optional): Sort order (e.g., asc, desc).
sort_by (optional): Sort transactions by a specific attribute.
The response will be a JSON object with the following schema:
\n{\n \"type\": \"object\",\n \"properties\": {\n \"total_count\": { \"type\": \"integer\" },\n \"per_page\": { \"type\": \"integer\" },\n \"total_pages\": { \"type\": \"integer\" },\n \"page\": { \"type\": \"integer\" },\n \"prev_page\": { \"type\": [\"integer\", \"null\"] },\n \"next_page\": { \"type\": [\"integer\", \"null\"] },\n \"items\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"address\": { \"type\": \"string\" },\n \"amount\": { \"type\": \"number\" },\n \"asset\": { \"type\": \"string\" },\n \"asset_type\": { \"type\": \"string\" },\n \"control\": { \"type\": [\"object\", \"null\"] },\n \"created_at\": { \"type\": \"string\" },\n \"dchain_id\": { \"type\": \"string\" },\n \"done_at\": { \"type\": \"string\" },\n \"fee\": { \"type\": \"number\" },\n \"high_risk\": { \"type\": [\"boolean\", \"null\"] },\n \"status\": { \"type\": \"string\" },\n \"tag\": { \"type\": [\"string\", \"null\"] },\n \"tx_id\": { \"type\": \"string\" },\n \"tx_link\": { \"type\": \"string\" },\n \"type\": { \"type\": \"string\" },\n \"updated_at\": { \"type\": \"string\" },\n \"uuid\": { \"type\": \"integer\" }\n },\n \"required\": [\"address\", \"amount\", \"asset\", \"asset_type\", \"created_at\", \"status\", \"tx_id\", \"type\", \"updated_at\", \"uuid\"]\n }\n }\n },\n \"required\": [\"total_count\", \"per_page\", \"total_pages\", \"page\", \"prev_page\", \"next_page\", \"items\"]\n}\n\nPagination page number
\n","type":"text/plain"},"key":"page","value":" "},{"description":{"content":"Number of items per page
\n","type":"text/plain"},"key":"per_page","value":" "},{"description":{"content":"Filters transactions by asset
\n","type":"text/plain"},"key":"asset","value":" "},{"description":{"content":"Filters transactions by status
\n","type":"text/plain"},"key":"status","value":" "},{"description":{"content":"Filters transactions from this date
\n","type":"text/plain"},"key":"from","value":" "},{"description":{"content":"Filters transactions until this date
\n","type":"text/plain"},"key":"to","value":" "},{"description":{"content":"Sort order (asc or desc)
\n","type":"text/plain"},"key":"sort","value":" "},{"description":{"content":"Sort by specific field
\n","type":"text/plain"},"key":"sort_by","value":" "}],"variable":[]}},"response":[{"id":"d3a9e582-b747-43f1-b6b0-524f82d1acbe","name":"Retrieves a list of deposit transactions","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://my.kyrrex.com/api/v2/transactions?page= &per_page= &asset= &status= &from= &to= &sort= &sort_by= ","host":["https://my.kyrrex.com/api"],"path":["v2","transactions"],"query":[{"key":"page","value":" ","description":"Pagination page number"},{"key":"per_page","value":" ","description":"Number of items per page"},{"key":"asset","value":" ","description":"Filters transactions by asset"},{"key":"status","value":" ","description":"Filters transactions by status"},{"key":"from","value":" ","description":"Filters transactions from this date"},{"key":"to","value":" ","description":"Filters transactions until this date"},{"key":"sort","value":" ","description":"Sort order (asc or desc)"},{"key":"sort_by","value":" ","description":"Sort by specific field"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"total_count\": 37,\n \"per_page\": 2,\n \"total_pages\": 19,\n \"page\": 1,\n \"prev_page\": null,\n \"next_page\": 2,\n \"items\": [\n {\n \"address\": \"TVGCgRowpN8Yg1eLqiKAzGAY9HcNy6z9bD\",\n \"amount\": 100.0,\n \"asset\": \"trx\",\n \"asset_type\": \"crypto\",\n \"control\": null,\n \"created_at\": \"2023-05-08T14:02:06.213Z\",\n \"dchain_id\": \"trx\",\n \"done_at\": \"2023-05-08T14:02:16.088Z\",\n \"fee\": 0.0,\n \"high_risk\": null,\n \"status\": \"blocked_limit_exceeded\",\n \"tag\": null,\n \"tx_id\": \"23d01ab620a2a56ec78a31b35647adea8afeb95e89eeedc33c98270700c0ba2c\",\n \"tx_link\": \"https://e.tronscan.org/#/transaction/23d01ab620a2a56ec78a31b35647adea8afeb95e89eeedc33c98270700c0ba2c\",\n \"type\": \"deposit\",\n \"updated_at\": \"2023-05-08T14:02:16.088Z\",\n \"uuid\": 149697474\n },\n {\n \"address\": \"TVGCgRowpN8Yg1eLqiKAzGAY9HcNy6z9bD\",\n \"amount\": 101.0,\n \"asset\": \"trx\",\n \"asset_type\": \"crypto\",\n \"control\": null,\n \"created_at\": \"2023-05-08T14:18:04.268Z\",\n \"dchain_id\": \"trx\",\n \"done_at\": \"2023-05-08T14:18:12.207Z\",\n \"fee\": 0.0,\n \"high_risk\": null,\n \"status\": \"blocked_limit_exceeded\",\n \"tag\": null,\n \"tx_id\": \"848150859adb64d396e72869c7a7d6edf3c87e8bcee1492b6c58ee2214438bfe\",\n \"tx_link\": \"https://e.tronscan.org/#/transaction/848150859adb64d396e72869c7a7d6edf3c87e8bcee1492b6c58ee2214438bfe\",\n \"type\": \"deposit\",\n \"updated_at\": \"2023-05-08T14:18:12.207Z\",\n \"uuid\": 386122122\n }\n ]\n}"}],"_postman_id":"9ae49b24-fc16-4c6f-8aa0-d42434f14ae6"},{"name":"Retrieves a list of withdrawal transactions","id":"9c8ffc49-8650-4cd1-aec6-c9a3e9bc1d30","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://my.kyrrex.com/api/v2/transactions/withdrawals?page= &per_page= &asset= &status= &from= &to= &sort= &sort_by= ","description":"This endpoint retrieves a list of withdrawal transactions based on the provided query parameters. The available query parameters include page, per_page, asset, status, from, to, sort, and sort_by.
\nThe response of this request can be documented as a JSON schema to provide a structured definition of the expected JSON response format.
\n","urlObject":{"path":["v2","transactions","withdrawals"],"host":["https://my.kyrrex.com/api"],"query":[{"key":"page","value":" "},{"key":"per_page","value":" "},{"key":"asset","value":" "},{"key":"status","value":" "},{"key":"from","value":" "},{"key":"to","value":" "},{"key":"sort","value":" "},{"key":"sort_by","value":" "}],"variable":[]}},"response":[{"id":"1eb3d649-fe58-4864-84e5-b276c252e2e1","name":"Retrieves a list of withdrawal transactions","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://my.kyrrex.com/api/v2/transactions?page= &per_page= &asset= &status= &from= &to= &sort= &sort_by= ","host":["https://my.kyrrex.com/api"],"path":["v2","transactions"],"query":[{"key":"page","value":" ","description":"Pagination page number"},{"key":"per_page","value":" ","description":"Number of items per page"},{"key":"asset","value":" ","description":"Filters transactions by asset"},{"key":"status","value":" ","description":"Filters transactions by status"},{"key":"from","value":" ","description":"Filters transactions from this date"},{"key":"to","value":" ","description":"Filters transactions until this date"},{"key":"sort","value":" ","description":"Sort order (asc or desc)"},{"key":"sort_by","value":" ","description":"Sort by specific field"}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"total_count\": 55,\n \"per_page\": 2,\n \"total_pages\": 28,\n \"page\": 1,\n \"prev_page\": null,\n \"next_page\": 2,\n \"items\": [\n {\n \"address\": \"TWXqPj9ikL4xtGN3DUyj51ozUGCwYjsBa5\",\n \"amount\": 50.0,\n \"asset\": \"usdt\",\n \"asset_type\": \"crypto\",\n \"control\": true,\n \"created_at\": \"2024-01-12T10:57:51.300Z\",\n \"dchain_id\": \"trc20usdt\",\n \"done_at\": \"2024-01-12T10:59:24.394Z\",\n \"fee\": 2.0,\n \"high_risk\": false,\n \"status\": \"done\",\n \"tag\": null,\n \"tx_id\": \"dfe96f073732878a94ae7c1688e0b17d3004ae7447e64bfebe141aa24d30e213\",\n \"tx_link\": \"https://e.tronscan.org/#/transaction/dfe96f073732878a94ae7c1688e0b17d3004ae7447e64bfebe141aa24d30e213\",\n \"type\": \"withdrawal\",\n \"updated_at\": \"2024-01-12T10:59:24.394Z\",\n \"uuid\": 15604287746\n },\n {\n \"address\": \"TWXqPj9ikL4xtGN3DUyj51ozUGCwYjsBa5\",\n \"amount\": 100.0,\n \"asset\": \"trx\",\n \"asset_type\": \"crypto\",\n \"control\": true,\n \"created_at\": \"2024-01-12T10:58:50.070Z\",\n \"dchain_id\": \"trx\",\n \"done_at\": \"2024-01-12T11:01:16.476Z\",\n \"fee\": 16.0,\n \"high_risk\": false,\n \"status\": \"done\",\n \"tag\": null,\n \"tx_id\": \"5b35ee233002317f8ecb9ca3578af629af0234913efb18693452445079e8832a\",\n \"tx_link\": \"https://e.tronscan.org/#/transaction/5b35ee233002317f8ecb9ca3578af629af0234913efb18693452445079e8832a\",\n \"type\": \"withdrawal\",\n \"updated_at\": \"2024-01-12T11:01:16.476Z\",\n \"uuid\": 15604287808\n }\n ]\n}"}],"_postman_id":"9c8ffc49-8650-4cd1-aec6-c9a3e9bc1d30"}],"id":"1fd4b08f-ece8-44af-aa09-2b04ca16a4d4","_postman_id":"1fd4b08f-ece8-44af-aa09-2b04ca16a4d4","description":""},{"name":"Requisites","item":[{"name":"Retrieves a list of requisites based on various filters","id":"07aa53e1-41ea-4629-b062-c21f75a3e009","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://my.kyrrex.com/api/v2/requisites?page=&per_page=&search=&asset=&dchain&name&address&sort&sort_by","description":"This endpoint retrieves a list of requisites with optional pagination, search, and sorting parameters.
\npage (optional, integer): The page number for paginating the results.
per_page (optional, integer): The number of items to include per page.
search (optional, string): Search keyword to filter the requisites.
asset (optional, string): Filter requisites by asset.
dchain (optional, string): Filter requisites by dchain.
name (optional, string): Filter requisites by name.
address (optional, string): Filter requisites by address.
sort (optional, string): Sort order ('asc' or 'desc').
sort_by (optional, string): Field to sort the requisites.
The response will be a JSON object with the following properties:
\ntotal_count (integer): Total count of requisites.
per_page (integer): Number of requisites per page.
total_pages (integer): Total number of pages.
page (integer): Current page number.
prev_page (nullable): Previous page number, if available.
next_page (nullable): Next page number, if available.
items (array): An array of requisite objects with the following properties:
address (string): The address of the requisite.
address_control_verified (boolean): Indicates if the address control is verified.
asset_id (string): The asset ID associated with the requisite.
created_at (string): Timestamp of creation.
dchain_id (string): The dchain ID associated with the requisite.
deleted_at (nullable): Timestamp of deletion, if deleted.
description (nullable): Description of the requisite.
id (integer): Unique identifier of the requisite.
name (string): The name of the requisite.
otp (boolean): Indicates if OTP (One-Time Password) is enabled.
tag (nullable): Tag associated with the requisite.
uid (integer): Unique identifier associated with the requisite.
updated_at (string): Timestamp of last update.
whitelist (boolean): Indicates if the requisite is whitelisted.
{\n \"type\": \"object\",\n \"properties\": {\n \"total_count\": { \"type\": \"integer\" },\n \"per_page\": { \"type\": \"integer\" },\n \"total_pages\": { \"type\": \"integer\" },\n \"page\": { \"type\": \"integer\" },\n \"prev_page\": { \"type\": [\"integer\", \"null\"] },\n \"next_page\": { \"type\": [\"integer\", \"null\"] },\n \"items\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"address\": { \"type\": \"string\" },\n \"address_control_verified\": { \"type\": \"boolean\" },\n \"asset_id\": { \"type\": \"string\" },\n \"created_at\": { \"type\": \"string\" },\n \"dchain_id\": { \"type\": \"string\" },\n \"deleted_at\": { \"type\": [\"string\", \"null\"] },\n \"description\": { \"type\": [\"string\", \"null\"] },\n \"id\": { \"type\": \"integer\" },\n \"name\": { \"type\": \"string\" },\n \"otp\": { \"type\": \"boolean\" },\n \"tag\": { \"type\": [\"string\", \"null\"] },\n \"uid\": { \"type\": \"integer\" },\n \"updated_at\": { \"type\": \"string\" },\n \"whitelist\": { \"type\": \"boolean\" }\n },\n \"required\": [\"address\", \"address_control_verified\", \"asset_id\", \"created_at\", \"dchain_id\", \"id\", \"name\", \"otp\", \"uid\", \"updated_at\", \"whitelist\"]\n }\n }\n },\n \"required\": [\"total_count\", \"per_page\", \"total_pages\", \"page\", \"items\"]\n}\n\nPagination page number
\n","type":"text/plain"},"key":"page","value":""},{"description":{"content":"Number of items per page
\n","type":"text/plain"},"key":"per_page","value":""},{"description":{"content":"Search by partial match on address, tag, description, or name
\n","type":"text/plain"},"key":"search","value":""},{"description":{"content":"Filter by asset (mutually exclusive with dchain)
\n","type":"text/plain"},"key":"asset","value":""},{"description":{"content":"Filter by dchain (mutually exclusive with asset)
\n","type":"text/plain"},"key":"dchain","value":null},{"description":{"content":"Search by name
\n","type":"text/plain"},"key":"name","value":null},{"description":{"content":"Search by address
\n","type":"text/plain"},"key":"address","value":null},{"description":{"content":"Sort order, either asc or desc
\n","type":"text/plain"},"key":"sort","value":null},{"description":{"content":"Field to sort by
\n","type":"text/plain"},"key":"sort_by","value":null}],"variable":[]}},"response":[{"id":"3783074c-ba04-461a-b951-ffd2756e1509","name":"Retrieves a list of requisites based on various filters","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://my.kyrrex.com/api/v2/requisites?page=&per_page=&search=&asset=&dchain&name&address&sort&sort_by","host":["https://my.kyrrex.com/api"],"path":["v2","requisites"],"query":[{"key":"page","value":"","description":"Pagination page number"},{"key":"per_page","value":"","description":"Number of items per page"},{"key":"search","value":"","description":"Search by partial match on address, tag, description, or name"},{"key":"asset","value":"","description":"Filter by asset (mutually exclusive with dchain)"},{"key":"dchain","value":null,"description":"Filter by dchain (mutually exclusive with asset)"},{"key":"name","value":null,"description":"Search by name"},{"key":"address","value":null,"description":"Search by address"},{"key":"sort","value":null,"description":"Sort order, either asc or desc"},{"key":"sort_by","value":null,"description":"Field to sort by"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"total_count\": 2,\n \"per_page\": 2,\n \"total_pages\": 1,\n \"page\": 1,\n \"prev_page\": null,\n \"next_page\": null,\n \"items\": [\n {\n \"address\": \"TWYEoEaLDRLDjnBqbQcupYkcPxyHzNVj2J\",\n \"address_control_verified\": true,\n \"asset_id\": \"usdt\",\n \"created_at\": \"2024-06-03T21:23:38.784Z\",\n \"dchain_id\": \"trc20usdt\",\n \"deleted_at\": null,\n \"description\": null,\n \"id\": 1050,\n \"name\": \"ggg\",\n \"otp\": true,\n \"tag\": null,\n \"uid\": 15589053726,\n \"updated_at\": \"2024-06-03T21:23:38.816Z\",\n \"whitelist\": false\n },\n {\n \"address\": \"TVUkrxZUU2b4o21VGbcvZi32knibRoFCmU\",\n \"address_control_verified\": true,\n \"asset_id\": \"usdt\",\n \"created_at\": \"2024-05-31T20:14:48.949Z\",\n \"dchain_id\": \"trc20usdt\",\n \"deleted_at\": null,\n \"id\": 1037,\n \"name\": \"test\",\n \"otp\": true,\n \"soiled\": false,\n \"tag\": null,\n \"uid\": 15589046472,\n \"updated_at\": \"2024-05-31T20:14:49.312Z\",\n \"whitelist\": false\n }\n ]\n}"}],"_postman_id":"07aa53e1-41ea-4629-b062-c21f75a3e009"},{"name":"Lists requisites with optional filters","id":"7b5c8040-f1a8-46e2-b3b6-974cf3c09a8c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://my.kyrrex.com/api/v2/fiat/requisites?page=&per_page=&dchain&gateway","description":"This endpoint retrieves a list of fiat requisites with optional pagination parameters.
\nRequest
\npage (optional, integer): The page number for paginated results.per_page (optional, integer): The number of items to be included per page.dchain (optional): The blockchain or distributed ledger technology used.gateway (optional): The gateway for fiat transactions.Response\nThe response includes the following fields:
\nlimit (integer): The maximum number of items to be returned.total_count (integer): The total count of items available.per_page (integer): The number of items per page.total_pages (integer): The total number of pages available.page (integer): The current page number.prev_page (nullable): The previous page number, if available.next_page (nullable): The next page number, if available.items (array): An array of fiat requisite objects, each containing the following fields:address (string): The address associated with the requisite.asset (string): The asset type.dchain (string): The blockchain or distributed ledger technology used.expired_at (nullable): The expiry date of the requisite, if applicable.name (nullable): The name associated with the requisite.tag (nullable): The tag associated with the requisite.type (string): The type of the requisite.id (integer): The unique identifier of the requisite.Pagination page number
\n","type":"text/plain"},"key":"page","value":""},{"description":{"content":"Number of items per page
\n","type":"text/plain"},"key":"per_page","value":""},{"description":{"content":"Filter by dchain (mutually exclusive with asset)
\n","type":"text/plain"},"key":"dchain","value":null},{"description":{"content":"Filter by gateway
\n","type":"text/plain"},"key":"gateway","value":null}],"variable":[]}},"response":[{"id":"e37cb5eb-2aa1-43d1-b03b-3d9984664a87","name":"Lists requisites with optional filters","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://my.kyrrex.com/api/v2/requisites?page=&per_page=&asset=&gateway","host":["https://my.kyrrex.com/api"],"path":["v2","requisites"],"query":[{"key":"page","value":"","description":"Pagination page number"},{"key":"per_page","value":"","description":"Number of items per page"},{"key":"asset","value":"","description":"Filter by asset (mutually exclusive with dchain)"},{"key":"gateway","value":null,"description":"Filter by gateway"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"limit\": 7,\n \"total_count\": 1,\n \"per_page\": 2,\n \"total_pages\": 1,\n \"page\": 1,\n \"prev_page\": null,\n \"next_page\": null,\n \"items\": [\n {\n \"address\": \"559606 **** 0931\",\n \"asset\": \"eur\",\n \"dchain\": \"cjeur\",\n \"expired_at\": null,\n \"name\": null,\n \"tag\": null,\n \"type\": \"card_address\",\n \"id\": 2174\n }\n ]\n}"}],"_postman_id":"7b5c8040-f1a8-46e2-b3b6-974cf3c09a8c"}],"id":"a719c824-7ae4-4bfc-ae1b-fefecfde6bcb","_postman_id":"a719c824-7ae4-4bfc-ae1b-fefecfde6bcb","description":""},{"name":"Withdrawals","item":[{"name":"Creates a new withdrawal","id":"8d140d9b-83d2-47e1-be85-ab927a9cbb44","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"dchain\": \"trc20usdt\", //Identifier of the dchain\n \"amount\": 50.0, //Amount to be withdrawn\n \"destination\": \"TVGCgRowpN8Yg1eLqiKAzGAY9HcNy6z9bD\", //Address to which the withdrawal will be sent (mutually exclusive with requisite_id)\n \"destination_tag\": \"12345\",//Tag of the destination address\n \"requisite_id\": \"15604287808\"//Identifier of the requisite (mutually exclusive with destination)\n}","options":{"raw":{"language":"json"}}},"url":"https://my.kyrrex.com/api/v2/withdrawals","description":"This endpoint allows you to initiate a withdrawal with the specified parameters.
\ndchain (string): The blockchain type for the withdrawal.
amount (number): The amount to be withdrawn.
destination (string): The destination address for the withdrawal.
destination_tag (string): The destination tag for the withdrawal.
requisite_id (string): The requisite ID for the withdrawal.
The response will be in JSON format and will include the following fields:
\naddress (string): The address of the withdrawal.
amount (number): The amount withdrawn.
asset (string): The asset type.
asset_type (string): The type of asset.
control (boolean): Indicates if the withdrawal is under control.
created_at (string): The timestamp of creation.
dchain_id (string): The blockchain ID.
done_at (string): The timestamp of completion.
fee (number): The fee for the withdrawal.
high_risk (boolean): Indicates if the withdrawal is high risk.
status (string): The status of the withdrawal.
tag (string): The tag associated with the withdrawal.
tx_id (string): The transaction ID.
tx_link (string): The link to the transaction.
type (string): The type of withdrawal.
updated_at (string): The timestamp of last update.
uuid (number): The UUID of the withdrawal.
{\n \"address\": \"\",\n \"amount\": 0,\n \"asset\": \"\",\n \"asset_type\": \"\",\n \"control\": true,\n \"created_at\": \"\",\n \"dchain_id\": \"\",\n \"done_at\": \"\",\n \"fee\": 0,\n \"high_risk\": true,\n \"status\": \"\",\n \"tag\": null,\n \"tx_id\": \"\",\n \"tx_link\": \"\",\n \"type\": \"\",\n \"updated_at\": \"\",\n \"uuid\": 0\n}\n\nThis endpoint retrieves a list of exchanges based on the provided query parameters.
\npage (optional): The page number for paginated results.per_page (optional): The number of items to be included per page.input_asset (optional): The input asset for the exchange.output_asset (optional): The output asset for the exchange.state (optional): The state of the exchange.from (optional): The start date for the exchange.to (optional): The end date for the exchange.sort (optional): The sorting order for the results.sort_by (optional): The parameter to sort the results by.The response includes the following fields:
\ntotal_count: The total count of exchanges.per_page: The number of items per page.total_pages: The total number of pages.page: The current page number.prev_page: The previous page number, if available.next_page: The next page number, if available.items: An array of exchange items, each containing the following fields:amount: The amount of the exchange.created: The creation date of the exchange.currency: The currency of the exchange.executed: The execution status of the exchange.input_currency_id: The input currency ID.output_amount: The output amount of the exchange.output_currency_id: The output currency ID.state: The state of the exchange.uuid: The unique identifier of the exchange.{\n \"total_count\": 0,\n \"per_page\": 0,\n \"total_pages\": 0,\n \"page\": 0,\n \"prev_page\": null,\n \"next_page\": 0,\n \"items\": [\n {\n \"amount\": 0,\n \"created\": \"\",\n \"currency\": \"\",\n \"executed\": 0,\n \"input_currency_id\": \"\",\n \"output_amount\": 0,\n \"output_currency_id\": \"\",\n \"state\": \"\",\n \"uuid\": 0\n }\n ]\n}\nPagination page number
\n","type":"text/plain"},"key":"page","value":" "},{"description":{"content":"Number of items per page
\n","type":"text/plain"},"key":"per_page","value":" "},{"description":{"content":"Identifier of the input asset
\n","type":"text/plain"},"key":"input_asset","value":null},{"description":{"content":"Identifier of the output asset
\n","type":"text/plain"},"key":"output_asset","value":null},{"description":{"content":"Filter by status
\n","type":"text/plain"},"key":"state","value":" "},{"description":{"content":"Filter by start date
\n","type":"text/plain"},"key":"from","value":" "},{"description":{"content":"Filter by end date
\n","type":"text/plain"},"key":"to","value":" "},{"description":{"content":"Sort order (asc or desc)
\n","type":"text/plain"},"key":"sort","value":" "},{"description":{"content":"Sort by specified field
\n","type":"text/plain"},"key":"sort_by","value":""}],"variable":[]}},"response":[{"id":"a41f7914-c071-4eeb-b043-267ab2769efc","name":"Lists exchanges with optional filters","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://my.kyrrex.com/api/v2/exchanges?page= &per_page= &input_asset&output_asset&state= &from= &to= &sort= &sort_by=","host":["https://my.kyrrex.com/api"],"path":["v2","exchanges"],"query":[{"key":"page","value":" ","description":"Pagination page number"},{"key":"per_page","value":" ","description":"Number of items per page"},{"key":"input_asset","value":null,"description":"Identifier of the input asset"},{"key":"output_asset","value":null,"description":"Identifier of the output asset"},{"key":"state","value":" ","description":"Filter by status"},{"key":"from","value":" ","description":"Filter by start date"},{"key":"to","value":" ","description":"Filter by end date"},{"key":"sort","value":" ","description":"Sort order (asc or desc)"},{"key":"sort_by","value":"","description":"Sort by specified field"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"total_count\": 25,\n \"per_page\": 2,\n \"total_pages\": 13,\n \"page\": 1,\n \"prev_page\": null,\n \"next_page\": 2,\n \"items\": [\n {\n \"amount\": 0.00072279,\n \"created\": \"2024-02-19T23:36:25.421Z\",\n \"currency\": \"btceur\",\n \"executed\": 1.0,\n \"input_currency_id\": \"btc\",\n \"output_amount\": 34.0,\n \"output_currency_id\": \"eur\",\n \"state\": \"done\",\n \"uuid\": 230567216545007490\n },\n {\n \"amount\": 10.0,\n \"created\": \"2024-02-19T23:33:13.281Z\",\n \"currency\": \"eurbtc\",\n \"executed\": 1.0,\n \"input_currency_id\": \"eur\",\n \"output_amount\": 0.000208,\n \"output_currency_id\": \"btc\",\n \"state\": \"done\",\n \"uuid\": 230567216545007428\n }\n ]\n}"}],"_postman_id":"51797b9a-ee15-43ce-a7dd-c9e9c9649dc7"},{"name":"Creates a new exchange","id":"47fa1001-5a5f-48c9-929d-0de7627799af","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://my.kyrrex.com/api/v2/exchanges?input_asset&output_asset&amount","description":"This endpoint allows you to create an exchange by specifying the input asset, output asset, and the amount.
\ninput_asset (required): The input asset for the exchange.
\noutput_asset (required): The output asset for the exchange.
\namount (required): The amount of input asset to be exchanged.
\nThe response will be a JSON object with the following properties:
\namount: The amount of input asset for the exchange.
\ncreated: The timestamp of when the exchange was created.
\ncurrency: The currency of the exchange.
\nexecuted: The amount executed for the exchange.
\ninput_currency_id: The ID of the input currency.
\noutput_amount: The amount of output asset received.
\noutput_currency_id: The ID of the output currency.
\nstate: The state of the exchange.
\nuuid: The universally unique identifier for the exchange.
\n{\n \"type\": \"object\",\n \"properties\": {\n \"amount\": {\"type\": \"number\"},\n \"created\": {\"type\": \"string\"},\n \"currency\": {\"type\": \"string\"},\n \"executed\": {\"type\": \"number\"},\n \"input_currency_id\": {\"type\": \"string\"},\n \"output_amount\": {\"type\": \"number\"},\n \"output_currency_id\": {\"type\": \"string\"},\n \"state\": {\"type\": \"string\"},\n \"uuid\": {\"type\": \"string\"}\n }\n}\n\nIdentifier of the input asset
\n","type":"text/plain"},"key":"input_asset","value":null},{"description":{"content":"Identifier of the output asset
\n","type":"text/plain"},"key":"output_asset","value":null},{"description":{"content":"Amount to be exchanged
\n","type":"text/plain"},"key":"amount","value":null}],"variable":[]}},"response":[{"id":"927911af-cf15-42b3-9a20-b71411b73eec","name":"Creates a new exchange","originalRequest":{"method":"POST","header":[],"url":{"raw":"https://my.kyrrex.com/api/v2/exchanges?input_asset&output_asset&amount","host":["https://my.kyrrex.com/api"],"path":["v2","exchanges"],"query":[{"key":"input_asset","value":null,"description":"Identifier of the input asset"},{"key":"output_asset","value":null,"description":"Identifier of the output asset"},{"key":"amount","value":null,"description":"Amount to be exchanged"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"amount\": 10.0,\n \"created\": \"2024-02-19T23:33:13.281Z\",\n \"currency\": \"eurbtc\",\n \"executed\": 1.0,\n \"input_currency_id\": \"eur\",\n \"output_amount\": 0.000208,\n \"output_currency_id\": \"btc\",\n \"state\": \"done\",\n \"uuid\": 230567216545007428\n}"}],"_postman_id":"47fa1001-5a5f-48c9-929d-0de7627799af"},{"name":"Estimates an exchange rate for given assets and amount","id":"b68590c5-e76a-45ce-b62f-6c3de24a1469","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://my.kyrrex.com/api/v2/exchanges/estimate?input_asset=&output_asset=&amount","description":"This endpoint retrieves an estimate for exchanging one asset to another based on the provided input.
\ninput_asset (string): The input asset for the exchange.
output_asset (string): The output asset for the exchange.
amount (number): The amount of input asset to be exchanged.
The response will include the following fields:
\ninput (object):
amount (number): The amount of input asset provided.
currency (string): The currency of the input asset.
minimum_amount (number): The minimum amount of input asset required for the exchange.
output (object):
amount (number): The amount of output asset after the exchange.
currency (string): The currency of the output asset.
rate (number): The exchange rate for the specified input and output assets.
Identifier of the input asset
\n","type":"text/plain"},"key":"input_asset","value":""},{"description":{"content":"Identifier of the output asset
\n","type":"text/plain"},"key":"output_asset","value":""},{"description":{"content":"Amount to be exchanged
\n","type":"text/plain"},"key":"amount","value":null}],"variable":[]}},"response":[{"id":"d6fdf6c9-ca01-416f-b570-09d5c41c8733","name":"Estimates an exchange rate for given assets and amount","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://my.kyrrex.com/api/v2/exchanges/estimate?input_asset=&output_asset=&amount","host":["https://my.kyrrex.com/api"],"path":["v2","exchanges","estimate"],"query":[{"key":"input_asset","value":"","description":"Identifier of the input asset"},{"key":"output_asset","value":"","description":"Identifier of the output asset"},{"key":"amount","value":null,"description":"Amount to be exchanged"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"input\": {\n \"amount\": 1000.0,\n \"currency\": \"usdt\",\n \"minimum_amount\": 5.0\n },\n \"output\": {\n \"amount\": 0.01538802,\n \"currency\": \"btc\"\n },\n \"rate\": 64985.6\n}"}],"_postman_id":"b68590c5-e76a-45ce-b62f-6c3de24a1469"}],"id":"e8c37069-4220-4ba8-9a17-630181d40bd6","_postman_id":"e8c37069-4220-4ba8-9a17-630181d40bd6","description":""},{"name":"Order","item":[{"name":"Lists orders with optional filters","id":"10d741d0-204b-4352-a372-f11eb3d4725c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://my.kyrrex.com/api/v2/orders?market=&from=&to=&asset=&state=&side=&ord_type=&price_min=&price_max=&sort= &sort_by=&page=&per_page=","description":"This endpoint retrieves a list of orders based on the provided query parameters.
\nRequest:
\nmarket (optional): Filter by market.
from (optional): Filter orders created after this timestamp.
to (optional): Filter orders created before this timestamp.
asset (optional): Filter by asset.
state (optional): Filter by order state.
side (optional): Filter by order side.
ord_type (optional): Filter by order type.
price_min (optional): Filter by minimum price.
price_max (optional): Filter by maximum price.
sort (optional): Sort order (asc/desc).
sort_by (optional): Sort by a specific attribute.
page (optional): Page number for pagination.
per_page (optional): Number of items per page.
Response:
\n{\n \"prices\": {\n \"sell\": [],\n \"buy\": [0]\n },\n \"order\": null,\n \"total_count\": 0,\n \"per_page\": 0,\n \"total_pages\": 0,\n \"page\": 0,\n \"prev_page\": null,\n \"next_page\": 0,\n \"items\": [\n {\n \"avg_price\": null,\n \"created_at\": \"\",\n \"executed_volume\": 0,\n \"fulfillment\": 0,\n \"id\": 0,\n \"market_id\": \"\",\n \"ord_type\": \"\",\n \"price\": 0,\n \"remaining_volume\": 0,\n \"side\": \"\",\n \"state\": \"\",\n \"trades_count\": 0,\n \"volume\": 0\n }\n ]\n}\n\nThis endpoint retrieves the details of a specific order by providing the order ID in the request URL.
\nRequest:
\nMethod: GET
\nURL: https://my.kyrrex.com/api/v2/orders/{id}
Response:
The response will include the following order details:
avg_price (number): The average price of the order
created_at (string): The timestamp when the order was created
executed_volume (number): The volume of the order that has been executed
fulfillment (number): The fulfillment status of the order
id (number): The unique identifier of the order
market_id (string): The ID of the market
ord_type (string): The type of order
price (number): The price of the order
remaining_volume (number): The remaining volume of the order
side (string): The side of the order (buy/sell)
state (string): The state of the order
trades_count (number): The number of trades associated with the order
volume (number): The total volume of the order
This endpoint allows you to place a new order by sending an HTTP POST request to the specified URL. The request should include the following parameters in the request body:
\nmarket (required): The market for the order.side (required): The side of the order, either buy or sell.ord_type (required): The type of order, e.g., limit, market, etc.volume (required): The volume of the order.price (required): The price of the order.The response will include the details of the newly placed order, including the order ID, timestamp, status, and any other relevant information.
\n","urlObject":{"path":["v2","orders"],"host":["https://my.kyrrex.com/api"],"query":[{"description":{"content":"Market identifier
\n","type":"text/plain"},"key":"market","value":null},{"description":{"content":"Order direction
\n","type":"text/plain"},"key":"side","value":null},{"description":{"content":"Order type
\n","type":"text/plain"},"key":"ord_type","value":null},{"description":{"content":"Order volume
\n","type":"text/plain"},"key":"volume","value":null},{"description":{"content":"Order price (required for limit order type)
\n","type":"text/plain"},"key":"price","value":null}],"variable":[]}},"response":[{"id":"0d36b604-6939-490b-bf35-b1811e5622f5","name":"Creates a new order","originalRequest":{"method":"POST","header":[],"url":{"raw":"https://my.kyrrex.com/api/v2/orders?market&side&ord_type&volume&price","host":["https://my.kyrrex.com/api"],"path":["v2","orders"],"query":[{"key":"market","value":null,"description":"Market identifier"},{"key":"side","value":null,"description":"Order direction"},{"key":"ord_type","value":null,"description":"Order type"},{"key":"volume","value":null,"description":"Order volume"},{"key":"price","value":null,"description":"Order price (required for limit order type)"}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"avg_price\": null,\n \"created_at\": \"2022-08-26T09:36:56.629Z\",\n \"executed_volume\": 0.0024,\n \"fulfillment\": 0.24,\n \"id\": 737,\n \"market_id\": \"btcusdt\",\n \"ord_type\": \"limit\",\n \"price\": 1000.0,\n \"remaining_volume\": 0.0076,\n \"side\": \"buy\",\n \"state\": \"wait\",\n \"trades_count\": 5,\n \"volume\": 0.01\n}"}],"_postman_id":"88eda464-53e6-46af-8ffd-70498dac0c50"},{"name":"Cancels an order by ID","id":"146b680c-a1e5-45e8-8c55-8695c09836d1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://my.kyrrex.com/api/v2/orders/{id}","description":"This endpoint is used to delete a specific order by its ID.
\nThis request does not require a request body.
\nstatus (boolean): Indicates the status of the deletion operation. A value of true indicates a successful deletion.{\n \"status\": true\n}\n\nThis endpoint is used to delete an order.
\nMethod: DELETE
\nURL: https://my.kyrrex.com/api/v2/orders
The response for this request is a JSON object with a status key, which indicates whether the deletion was successful (true) or not.
{\n \"status\": true\n}\n\nThis endpoint allows you to retrieve a list of trades based on the specified filters.
\nmarket (optional): Filter trades by market.
side (optional): Filter trades by side (buy/sell).
asset (optional): Filter trades by asset.
from (optional): Filter trades by start date.
to (optional): Filter trades by end date.
page (optional): Specify the page number for paginated results.
per_page (optional): Specify the number of trades per page.
sort (optional): Specify the sort order (asc/desc).
sort_by (optional): Specify the attribute to sort the trades by.
The response will include a list of trades based on the specified filters, including trade details such as trade ID, market, side, asset, price, quantity, and timestamp.
\n","urlObject":{"path":["v2","trades"],"host":["https://my.kyrrex.com/api"],"query":[{"description":{"content":"Market identifier
\n","type":"text/plain"},"key":"market","value":""},{"description":{"content":"Trade direction
\n","type":"text/plain"},"key":"side","value":""},{"description":{"content":"Asset identifier
\n","type":"text/plain"},"key":"asset","value":""},{"description":{"content":"Filter by start date
\n","type":"text/plain"},"key":"from","value":""},{"description":{"content":"Filter by end date
\n","type":"text/plain"},"key":"to","value":""},{"description":{"content":"Pagination page
\n","type":"text/plain"},"key":"page","value":""},{"description":{"content":"Number of items per page
\n","type":"text/plain"},"key":"per_page","value":""},{"description":{"content":"Sort order (asc or desc)
\n","type":"text/plain"},"key":"sort","value":" "},{"description":{"content":"Sort by specified field
\n","type":"text/plain"},"key":"sort_by","value":""}],"variable":[]}},"response":[{"id":"019fb774-e29c-4bec-81c3-bfe9c2641017","name":"Lists trades with optional filters","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://my.kyrrex.com/api/v2/trades?market=&side=&asset=&from=&to=&page=&per_page=&sort= &sort_by=","host":["https://my.kyrrex.com/api"],"path":["v2","trades"],"query":[{"key":"market","value":"","description":"Market identifier"},{"key":"side","value":"","description":"Trade direction"},{"key":"asset","value":"","description":"Asset identifier"},{"key":"from","value":"","description":"Filter by start date"},{"key":"to","value":"","description":"Filter by end date"},{"key":"page","value":"","description":"Pagination page"},{"key":"per_page","value":"","description":"Number of items per page"},{"key":"sort","value":" ","description":"Sort order (asc or desc)"},{"key":"sort_by","value":"","description":"Sort by specified field"}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"order\": \"created_at desc\",\n \"total_count\": 104,\n \"per_page\": 2,\n \"total_pages\": 52,\n \"page\": 1,\n \"prev_page\": null,\n \"next_page\": 2,\n \"items\": [\n {\n \"created_at\": \"2022-08-17T20:28:36Z\",\n \"fee\": 0.00001,\n \"fee_asset\": \"btc\",\n \"funds\": 10.0,\n \"funds_asset\": \"usdt\",\n \"id\": 482,\n \"in_asset_id\": \"btc\",\n \"market\": \"btcusdt\",\n \"order_id\": 669,\n \"out_asset_id\": \"usdt\",\n \"price\": 1000.0,\n \"side\": \"buy\",\n \"type\": \"buy\",\n \"volume\": 0.01,\n \"volume_asset\": \"btc\"\n },\n {\n \"created_at\": \"2022-09-01T16:40:37Z\",\n \"fee\": 0.000001,\n \"fee_asset\": \"btc\",\n \"funds\": 1.0,\n \"funds_asset\": \"usdt\",\n \"id\": 2060,\n \"in_asset_id\": \"btc\",\n \"market\": \"btcusdt\",\n \"order_id\": 737,\n \"out_asset_id\": \"usdt\",\n \"price\": 1000.0,\n \"side\": \"sell\",\n \"type\": \"sell\",\n \"volume\": 0.001,\n \"volume_asset\": \"btc\"\n }\n ]\n}"}],"_postman_id":"b8731b27-1ac0-4030-a4bf-e2c7186c62e5"}],"id":"c1529c53-3428-4121-a17a-f4447199b99d","_postman_id":"c1529c53-3428-4121-a17a-f4447199b99d","description":""},{"name":"Settings","item":[{"name":"Lists available markets with their configurations","id":"56c90f25-e8b8-49d6-8fc1-a22908fa3744","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://my.kyrrex.com/api/v2/settings/markets","description":"This endpoint retrieves the settings for markets.
\nMethod: GET
\nURL: https://my.kyrrex.com/api/v2/settings/markets
The response will include the settings for markets, including the market name, currency, and other relevant details.
\n[{\"active\":true,\"base_precision\":0,\"base_unit\":\"\",\"maker_fee\":0,\"market\":\"\",\"min_amount\":0,\"min_volume\":0,\"quote_precision\":0,\"quote_unit\":\"\",\"taker_fee\":0}]\n\nThis endpoint retrieves the settings for markets.
\nMethod: GET
\nURL: https://my.kyrrex.com/api/v2/settings/markets
The request does not include a request body.
\nThe response will include an array of market settings objects, each containing the following attributes:
\nactive (boolean): Indicates if the market is active.
base_precision (number): The precision for the base currency.
base_unit (string): The base currency unit.
maker_fee (number): The maker fee for the market.
market (string): The market name.
min_amount (number): The minimum amount for the market.
min_volume (number): The minimum volume for the market.
quote_precision (number): The precision for the quote currency.
quote_unit (string): The quote currency unit.
taker_fee (number): The taker fee for the market.
This endpoint retrieves the currency settings from the server.
\nMethod: GET
\nURL: https://my.kyrrex.com/api/v2/settings/currencies
The response will include the following parameters:
\n{\n \"currencyCode\": \"string\",\n \"dchains\": [\n {\n \"dcode\": \"string\",\n \"display_name\": \"string\",\n \"account\": {\n \"min_account_balance\": \"string\",\n \"max_account_balance\": \"string\"\n },\n \"deposit\": {\n \"static_fee\": \"string\",\n \"dynamic_fee\": \"string\",\n \"aml_fee\": \"string\",\n \"min_amount\": \"string\",\n \"max_amount\": \"string\"\n },\n \"withdraw\": {\n \"static_fee\": \"string\",\n \"dynamic_fee\": \"string\",\n \"aml_fee\": \"string\",\n \"min_amount\": \"string\",\n \"max_amount\": \"string\"\n }\n }\n ],\n \"currencyName\": \"string\",\n \"precision\": 0,\n \"type\": \"string\"\n}\n\nThis endpoint makes an HTTP GET request to retrieve the current timestamp.
\nNo request body is required for this endpoint.
\nThe response for this request is a JSON object with a single key \"timestamp\" which contains the current timestamp.
\n{\n \"timestamp\": \"0\"\n}\n\nThis endpoint makes an HTTP GET request to retrieve information about services available.
\nEndpoint: https://my.kyrrex.com//api/v2/tools/services
Method: GET
\nThe response will contain the following fields:
\nbonus_service (object)
status (boolean): Indicates the status of the bonus service.
asset (string): The asset related to the bonus service.
minimum_bonus_withdrawal_amount (string): The minimum amount allowed for bonus withdrawal.
Example response:
\n{\n \"bonus_service\": {\n \"status\": true,\n \"asset\": \"\",\n \"minimum_bonus_withdrawal_amount\": \"\"\n }\n}\n\nThis endpoint makes an HTTP GET request to retrieve information about the tools.
\nThe response of this request is documented as a JSON schema. Below is an example of the response schema:
\n{\n \"tool1\": \"description1\",\n \"tool2\": \"description2\",\n \"tool3\": \"description3\"\n // Additional tools and descriptions\n}\n\n