This page contains documentation for version 4 of our Exchange API. Please note that past versions of the exchange API have been deprecated and should not be used.
\n\nThis API describes all the methods available for interacting with the exchange.
\n\nMany requests require an Authorization header to be provided:
\n\nAuthorization: Bearer exchange_access_token
where exchange_access_token is the user access token obtained when a user logs in.
In addition to this authentication method, the platform supports API key authentication.
\n\nThis API uses GraphQL.
","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"51571007","collectionId":"a58f7bff-50c7-440b-8c47-60c75be139ce","publishedId":"2sBXVhEWoj","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"9747FF"},"publishDate":"2026-01-16T12:54:05.000Z"},"item":[{"name":"Authentication","item":[{"name":"First Login Initialization","id":"8983876b-36ad-4fa2-bace-9c5509115e13","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"authorization","value":"{{vault:bearer-token}}","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"mutation checkin {\n checkin\n}","variables":"{}"}},"url":"https://live-api.ouinex.com/graphql","description":"Initializes necessary user data structures and configurations upon first login. Safe for multiple executions - subsequent calls will not affect existing data.
\n","urlObject":{"protocol":"https","path":["graphql"],"host":["live-api","ouinex","com"],"query":[],"variable":[]}},"response":[{"id":"09c4e24f-c867-4d2f-9e24-62799265eaee","name":"First Login Initialization","originalRequest":{"method":"POST","header":[{"key":"authorization","value":"{{vault:bearer-token}}","type":"text"}],"body":{"mode":"graphql"},"url":"https://live-api.ouinex.com/graphql"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 11 Dec 2024 23:58:18 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"26"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Security-Policy","value":"default-src 'self';connect-src 'self' https://live-api.ouinex.com wss://live-api.ouinex.com;base-uri 'self';font-src 'self' https: data:;form-action 'self' https://live-api.ouinex.com;img-src * data:;object-src *;script-src 'self' 'unsafe-inline' https://cdn.jsdelivr.net;script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"Cross-Origin-Resource-Policy","value":"same-origin"},{"key":"Origin-Agent-Cluster","value":"?1"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"X-XSS-Protection","value":"0"},{"key":"cache-control","value":"no-store"},{"key":"ETag","value":"W/\"1a-iNlNY5X0wncQ1Cxe9+IUKAT/weQ\""},{"key":"Vary","value":"Accept-Encoding"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"checkin\": true\n }\n}"}],"_postman_id":"8983876b-36ad-4fa2-bace-9c5509115e13"}],"id":"da74c821-ce91-4ef2-99bb-2ce17a6095d3","description":"All the endpoints in this API that require Authorization can be called using an authentication token obtained by a user logging into the exchange at a url like https://live.ouinex.com/login
\n\nIn addition to this, users may use their authentication token to generate API keys with similar or reduced permissions. These API keys can be used to authenticate with the Authenticate with API Key endpoint, which will return a session token that can also be used in the Authorization header for secured endpoints.
","_postman_id":"da74c821-ce91-4ef2-99bb-2ce17a6095d3"},{"name":"API Keys","item":[{"name":"Create API Key","id":"471f001d-a89f-46c3-9b32-7192a076e6a7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"{{vault:bearer-token}}","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"mutation ($name: String!, $expires_at: String!) {\n create_api_key(\n name: $name\n expires_at: $expires_at\n is_active: on\n permissions: [\n accounts_balances\n conversions\n create_conversion_order\n create_conversion_quote\n open_orders\n cancel_order\n closed_orders\n create_order\n ]\n ) {\n api_key_id\n api_key_secret\n expires_at\n }\n}","variables":"{\"name\":\"My Trader API Key 1\",\"expires_at\": \"2025-01-01 00:00:00\"}"}},"url":"https://live-api.ouinex.com/graphql","urlObject":{"protocol":"https","path":["graphql"],"host":["live-api","ouinex","com"],"query":[],"variable":[]}},"response":[{"id":"ce4aadfd-6db8-4c1b-9bb7-764e148fc0e4","name":"Create API Key","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"{{vault:bearer-token}}","type":"text"}],"body":{"mode":"graphql"},"url":"https://live-api.ouinex.com/graphql"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 01 Mar 2023 21:08:54 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"179"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"ETag","value":"W/\"b3-4g6AaBQJK5gXJBX6N5ovSdvaIGw\""},{"key":"Vary","value":"Accept-Encoding"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"create_api_key\": {\n \"api_key_id\": \"a337c967-250d-4c8d-xxxx-xxxxxxxxxxxx\",\n \"api_key_secret\": \"RY437XJ4G7RFTLF9xxxxxxxxxxxxxxxxxxxxxxxxxx\",\n \"expires_at\": \"2025-01-01 00:00:00\"\n }\n }\n}"}],"_postman_id":"471f001d-a89f-46c3-9b32-7192a076e6a7"},{"name":"Create API Key with IP Whitelist","id":"40568826-8922-4791-bdd9-2db406807521","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"{{vault:bearer-token}}","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"mutation ($name: String!, $expires_at: String!, $ip_address: String!) {\n create_api_key(\n name: $name\n expires_at: $expires_at\n is_active: on\n ip_address: [$ip_address]\n permissions: [\n accounts_balances\n conversions\n create_conversion_order\n create_conversion_quote\n open_orders\n cancel_order\n closed_orders\n create_order\n ]\n ) {\n api_key_id\n api_key_secret\n expires_at\n }\n}","variables":"{\"name\":\"My Trader API Key with IP Whitelist\",\"expires_at\": \"2025-01-01 00:00:00\", \"ip_address\": \"67.85.198.23\"}"}},"url":"https://live-api.ouinex.com/graphql","urlObject":{"protocol":"https","path":["graphql"],"host":["live-api","ouinex","com"],"query":[],"variable":[]}},"response":[{"id":"4bc0f8c5-943b-4b6f-8651-d7926c5cbae7","name":"Create API Key with IP Whitelist","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"{{vault:bearer-token}}","type":"text"}],"body":{"mode":"graphql"},"url":"https://live-api.ouinex.com/graphql"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 01 Mar 2023 21:17:19 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"181"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"ETag","value":"W/\"b5-ibvCu8vwlQ+8H9R4cTzr8yJqvXs\""},{"key":"Vary","value":"Accept-Encoding"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"create_api_key\": {\n \"api_key_id\": \"506c070b-feba-4cbb-xxxx-xxxxxxxxxxxx\",\n \"api_key_secret\": \"3BGEEGBKU5V3U9G7Qxxxxxxxxxxxxxxxxxxxxxxxxxxx\",\n \"expires_at\": \"2025-01-01 00:00:00\"\n }\n }\n}"}],"_postman_id":"40568826-8922-4791-bdd9-2db406807521"},{"name":"Authenticate with API Key","event":[{"listen":"test","script":{"exec":["pm.test(\"Successfully authenticated\", function(){"," pm.response.to.have.status(200);"," pm.environment.set(\"accessToken\", pm.response.json().data.service_signin.jwt); ","});"],"type":"text/javascript","id":"b5743fe6-49fa-447f-bf0d-6c4e10100ebe"}}],"id":"1fa95ba4-1489-4934-8955-e16c0b384a4b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"graphql","graphql":{"query":"mutation ($service_api_key: String!, $service_api_secret: String!) {\n service_signin(\n service_api_key: $service_api_key\n service_api_secret: $service_api_secret\n ) {\n jwt\n expires_at\n }\n}","variables":"{\n \"service_api_key\":\"506c070b-feba-4cbb-xxxx-xxxxxxxxxxxx\",\n \"service_api_secret\": \"3BGEEGBKU5V3U9G7Qxxxxxxxxxxxxxxxxxxxxxxxxxxx\"\n}"}},"url":"https://live-api.ouinex.com/graphql","urlObject":{"protocol":"https","path":["graphql"],"host":["live-api","ouinex","com"],"query":[],"variable":[]}},"response":[{"id":"84a17564-7324-43d4-b3f6-91fb8a4d3bff","name":"Authenticate with API Key","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"{{vault:bearer-token}}","type":"text"}],"body":{"mode":"graphql"},"url":"https://live-api.ouinex.com/graphql"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 02 Mar 2023 23:08:36 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"ETag","value":"W/\"469-C5rwlOAGeKA7t4pgaXBcvkGyBfw\""},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"service_signin\": {\n \"jwt\": \"eyJhbGciOiJSUzI1NiIs...\",\n \"expires_at\": 1735689600000\n }\n }\n}"}],"_postman_id":"1fa95ba4-1489-4934-8955-e16c0b384a4b"}],"id":"21c64491-0af8-40f8-9b08-f2376375eff0","description":"This folder contains endpoints for managing API keys, which provide more granular control over API access. API keys are linked to an authentication token and can be generated with specific permissions or tied to IP whitelists for enhanced security. These keys are often used for integration services or automated systems needing restricted access.
\nAvailable permissions that can be associated with the API key:
\n{\n \"data\": {\n \"permissions\": [\n \"instruments\",\n \"currencies\",\n \"account_transactions\",\n \"closed_orders\",\n \"estimate_order\",\n \"open_orders\",\n \"trades\",\n \"payments\",\n \"estimate_network_fee\",\n \"create_withdrawal_crypto\",\n \"create_withdrawal_fiat\",\n \"conversions\",\n \"create_conversion_order\",\n \"conversion_quotes\",\n \"create_conversion_quote\",\n \"deposit_addresses_crypto\",\n \"accounts_balances\"\n ]\n }\n}\n\nValidates if a user has permission to access an exchange. Currently implements geographical restrictions based on user's country, with infrastructure in place for future expansion of access control mechanisms.
\n","urlObject":{"protocol":"https","path":["graphql"],"host":["live-api","ouinex","com"],"query":[],"variable":[]}},"response":[{"id":"c5b0b832-c3db-426b-9073-9bf1228631ce","name":"Check User Exchange Access","originalRequest":{"method":"POST","header":[],"body":{"mode":"graphql"},"url":"https://live-api.ouinex.com/graphql"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 11 Dec 2024 23:45:09 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"37"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Security-Policy","value":"default-src 'self';connect-src 'self' https://live-api.ouinex.com wss://live-api.ouinex.com;base-uri 'self';font-src 'self' https: data:;form-action 'self' https://live-api.ouinex.com;img-src * data:;object-src *;script-src 'self' 'unsafe-inline' https://cdn.jsdelivr.net;script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"Cross-Origin-Resource-Policy","value":"same-origin"},{"key":"Origin-Agent-Cluster","value":"?1"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"X-XSS-Protection","value":"0"},{"key":"cache-control","value":"no-store"},{"key":"ETag","value":"W/\"25-CXy8drjMGxsQ4yiBdtv2EZu+Sps\""},{"key":"Vary","value":"Accept-Encoding"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"restrictions_check\": true\n }\n}"}],"_postman_id":"b2e37448-cc2b-42fd-bd2f-cbd8f02e1025"},{"name":"Initiate Websocket Connection","id":"897a8527-30fc-4641-a88d-f1e716dfda5a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":"{\n \"type\": \"connection_init\",\n \"payload\": {\n \"authorization\": \"{{vault:bearer-token}}\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"Websocket Only - wss://live-api.ouinex.com/graphql","urlObject":{"protocol":"Websocket Only - wss","path":["graphql"],"host":["live-api","ouinex","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"897a8527-30fc-4641-a88d-f1e716dfda5a"}],"id":"f5c4b25e-b939-4a17-88cd-44d44496c512","_postman_id":"f5c4b25e-b939-4a17-88cd-44d44496c512","description":""},{"name":"User","item":[{"name":"Security","item":[{"name":"Update Anti-Phishing Code","id":"e45c50dd-6b11-428c-9ea3-6165ca66cbb3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"{{vault:bearer-token}}","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"mutation ($anti_phishing_code: String!, $token: String!) {\n update_anti_phishing_code(\n anti_phishing_code: $anti_phishing_code\n token: $token\n )\n}","variables":"{\n \"anti_phishing_code\": \"123456\",\n \"token\": \"059707\"\n}"}},"url":"https://live-api.ouinex.com/graphql","description":"This endpoint allows users to update their anti-phishing code, enhancing security by providing an additional verification layer for identifying legitimate platform communications.
\nThis endpoint generates a Multi-Factor Authentication (MFA) secret for a user. The secret can be used to set up MFA authentication, adding an extra layer of security to the user’s account.
\n","urlObject":{"protocol":"https","path":["graphql"],"host":["live-api","ouinex","com"],"query":[],"variable":[]}},"response":[{"id":"3d21aa73-88ff-472f-bc3c-2eff1e060a52","name":"Get 2FA Code","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"{{vault:bearer-token}}","type":"text"}],"body":{"mode":"graphql"},"url":"https://live-api.ouinex.com/graphql"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 05 Mar 2025 20:42:02 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"479"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"cache-control","value":"no-store"},{"key":"ETag","value":"W/\"1df-fOovLO0E1RIEDaf6JhPHXSU1/iI\""},{"key":"Vary","value":"Accept-Encoding"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"create_user_mfa_secret\": {\n \"secret\": \"*****************************************\",\n \"uri\": \"otpauth://totp/*********:usermail@example.com?secret=***************&issuer=********\",\n \"qr\": \"https://api.qrserver.com/v1/create-qr-code/?size=166x166&data=otpauth%3A%2F%2Ftotp%2F**********%3Auseremail@example.com%3Fsecret%*********************\"\n }\n }\n}"}],"_postman_id":"e3d61307-b65a-4bc0-a26c-8be31ffbb74a"},{"name":"Update User MFA Status","id":"c0b12ee7-de96-4229-a59e-58729f501db1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"{{vault:bearer-token}}","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"mutation ($status: ToggleSwitch!, $secret: String, $token: String!) {\n update_user_mfa_status(status: $status, secret: $secret, token: $token)\n}","variables":"{\n \"status\": \"on\",\n \"secret\": \"*************\",\n \"token\": \"123456\"\n}"}},"url":"https://live-api.ouinex.com/graphql","description":"This endpoint allows updating the Multi-Factor Authentication (MFA) status for a user. It enables or disables MFA based on the provided status and verifies the update using an MFA token.
\nGet All Active Currencies.
\nThis folder contains endpoints providing access to essential market data for the crypto exchange. These endpoints enable users to retrieve detailed information about available trading instruments, historical price data, and current market conditions. Developers can use this data to build trading algorithms, display market insights, or power analytical tools.
\n","_postman_id":"bc2890e0-2f2c-46ea-b56e-8e70422d0ea5"},{"name":"Accounts / Wallets","item":[{"name":"Deposit","item":[{"name":"Get Deposit Address","id":"e21dd637-39a7-4f9e-be8a-b6720e2921b4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"{{vault:bearer-token}}","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"query ($network: String, $currency_id: String!, $reference: String) {\n deposit_address_crypto(network: $network, currency_id: $currency_id, reference: $reference) {\n deposit_address_crypto_id\n currency_id\n address\n address_tag_type\n address_tag_value\n network\n created_at\n updated_at\n }\n}","variables":"{\n \"currency_id\":\"ETH\",\n \"network\":\"Ethereum\",\n \"reference\":\"abc1234\"\n}"}},"url":"https://live-api.ouinex.com/graphql","description":"When requesting a crypto deposit address for a particular currency, an optional reference field can be included. When a reference is provided, the system will generate a unique address for that reference value. This allows for the on-demand generation of unique deposit addresses as well as the ability to look-up previously assigned addresses by their reference code.
Get fiat bank details.
\nThis endpoint allows users to initiate a fiat currency withdrawal from their account. It supports various payment methods and banking details through either direct fields or the newer properties array. The withdrawal can be customized with specific banking information, beneficiary details, and transfer preferences.
\nThis endpoint allows users to initiate a fiat currency withdrawal from their account. It supports various payment methods and banking details through either direct fields or the newer properties array. The withdrawal can be customized with specific banking information, beneficiary details, and transfer preferences.
\nThis endpoint allows users to estimate the network fees for a given withdrawal amount in a specified currency. The estimated fees are categorized into three priority levels: low, medium, and high. Each priority level also impacts the execution time of the transaction, with higher priority levels generally leading to faster processing times.
\nThis endpoint allows users to estimate the payment fees for a given withdrawal amount in a specified currency. The estimated fees are categorized into three priority levels: low, medium, and high. Each category includes detailed fee parameters such as base fee, fee per byte, gas limit, gas price, network fee, and priority fee.
\nReturns transaction history and balance updates for accounts. Each account represents a different currency or asset type (e.g., BTC, USD).
\nGet list of payment methods.
\nA stop market order is an order that triggers a market order when the price reaches a specified stop price. This is useful for executing trades automatically when a certain price level is reached, often for risk management or breakout strategies.
\nIf a buy stop market order is placed, it will execute a market buy once the price reaches or exceeds the stop price.
\nIf a sell stop market order is placed, it will execute a market sell once the price reaches or drops below the stop price.
\nQuote Mode: The quantity refers to the quote currency (e.g., the USD value of BTC). This means the order size is defined in terms of how much of the quote currency is being spent or received.
\nBase Mode: The quantity refers to the base currency (e.g., BTC in a BTC/USD pair). This means the order size is defined in terms of how much of the base currency is being bought or sold.
\nA stop limit order is an order that triggers a limit order when the price reaches a specified stop price. This order type is useful for risk management and breakout strategies, as it allows traders to define both the trigger price (stop price) and the price at which the order should be executed (limit price).
\nIf a buy stop limit order is placed, it will activate a buy limit order once the price reaches or exceeds the stop price. The order will only execute at the limit price or better.
\nIf a sell stop limit order is placed, it will activate a sell limit order once the price reaches or drops below the stop price. The order will only execute at the limit price or better.
\nQuote Mode: The quantity refers to the quote currency (e.g., the USD value of BTC). This means the order size is defined in terms of how much of the quote currency is being spent or received.
\nBase Mode: The quantity refers to the base currency (e.g., BTC in a BTC/USD pair). This means the order size is defined in terms of how much of the base currency is being bought or sold.
\nThis request retrieves a list of currency conversions, optionally filtered by a search term. It supports pagination to limit the number of results per request.
\nWhen creating a webhook, be sure to note the webhook_id in the response and treat this as a secure secret. This important value can be used to validate the signature of the messages that the exchange sends to the url you provide when creating the webhook.
Each webhook message will include an x-webhook-signature header that is the result of running the following encryption function on the combination of the webhood_id and JSON stringified body of the webhook message. You can validate the signature by running the same function at your receiving service and comparing the signature outputs to ensure they match. This is a very important security process to implement as otherwise a malicious attacker may attempt to spoof webhooks to your receiving service.
/**\n * https://www.sohamkamani.com/nodejs/rsa-encryption/\n * @param payload\n * @returns\n */\n private createSignature(webhookId: string, payload: any) {\n return crypto\n .createHash('sha256')\n .update(webhookId + JSON.stringify(payload))\n .digest('hex');\n }\n\nWebhooks are automated messages sent from the exchange when something happens. They have a payload and are sent to a unique URL that you provide when creating your webhook. Webhooks are almost always faster than polling, and require less work on your end.
\nThe Derivatives module of the exchange allows traders to open leveraged long and short positions on a selection of Crypto Perpetual Instruments.
\nAlthough the derivatives module utilizes the same user accounts and transaction history as the core exchange, the derivatives API currently resides at a different root domain. For the demo exchange, this root url is https://live-margin-api.ouinex.com/graphql.
\n","_postman_id":"715f4683-2d88-46ba-a8c9-b8e116fe155b"},{"name":"Earn","item":[{"name":"Get Earn Currencies and Terms","id":"4328e9c0-1e22-4e1d-a7d2-a45e64e9ddc6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"{{vault:bearer-token}}","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"query (\n $vault_id: String\n $currency_id: String\n $is_active: ToggleSwitch\n $withdrawal_enabled: ToggleSwitch\n $deposit_enabled: ToggleSwitch\n $search: String\n $pager: PagerInput\n $sort: SortInput\n) {\n vaults(\n vault_id: $vault_id\n currency_id: $currency_id\n is_active: $is_active\n withdrawal_enabled: $withdrawal_enabled\n deposit_enabled: $deposit_enabled\n search: $search\n pager: $pager\n sort: $sort\n ) {\n serial_id\n vault_id\n currency_id\n name\n annual_rate_percent\n max_withdrawal_amount\n max_deposit_amount\n min_withdrawal_amount\n min_deposit_amount\n cut_off_time_seconds\n lock_in_period_seconds\n effective_date_from\n effective_date_to\n rate_type\n is_active\n withdrawal_enabled\n deposit_enabled\n last_interest_at\n created_at\n updated_at\n total_balance\n }\n}","variables":"{\n}"}},"url":"https://live-api.ouinex.com/graphql","description":"Get All Active Earn Currencies and Terms.
\n","urlObject":{"protocol":"https","path":["graphql"],"host":["live-api","ouinex","com"],"query":[],"variable":[]}},"response":[{"id":"a035e22e-0f93-44a0-846f-7fadfcd6c567","name":"Get Earn Currencies and Terms","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"{{vault:bearer-token}}","type":"text"}],"body":{"mode":"graphql"},"url":"https://live-api.ouinex.com/graphql"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 03 Mar 2025 20:57:47 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"cache-control","value":"no-store"},{"key":"ETag","value":"W/\"12b3-VDUGC7PatSoWXr4SRUh/Eew+iLE\""},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"vaults\": [\n {\n \"serial_id\": 6,\n \"vault_id\": \"6550d0ca-6673-4e3f-b70b-e25d2086f5f7\",\n \"currency_id\": \"BCH\",\n \"name\": \"fixed /30day/2.5%\",\n \"annual_rate_percent\": 2.5,\n \"max_withdrawal_amount\": 10000,\n \"max_deposit_amount\": 10000,\n \"min_withdrawal_amount\": 0,\n \"min_deposit_amount\": 0,\n \"cut_off_time_seconds\": 0,\n \"lock_in_period_seconds\": 2592000,\n \"effective_date_from\": \"2026-07-30 22:00:00\",\n \"effective_date_to\": \"2026-07-30 22:00:00\",\n \"rate_type\": \"fixed\",\n \"is_active\": \"on\",\n \"withdrawal_enabled\": \"on\",\n \"deposit_enabled\": \"on\",\n \"last_interest_at\": null,\n \"created_at\": \"2024-08-26 12:39:47\",\n \"updated_at\": \"2024-08-26 12:39:47\",\n \"total_balance\": 0.85974815\n },\n {\n \"serial_id\": 4,\n \"vault_id\": \"44a0fa20-edd6-4b38-95f6-589b06419438\",\n \"currency_id\": \"ETH\",\n \"name\": \"fixed /1 day/4%\",\n \"annual_rate_percent\": 4,\n \"max_withdrawal_amount\": 100,\n \"max_deposit_amount\": 100,\n \"min_withdrawal_amount\": 0,\n \"min_deposit_amount\": 0,\n \"cut_off_time_seconds\": 86400,\n \"lock_in_period_seconds\": 86400,\n \"effective_date_from\": \"2024-06-26 21:00:00\",\n \"effective_date_to\": \"2025-06-30 20:59:59\",\n \"rate_type\": \"fixed\",\n \"is_active\": \"on\",\n \"withdrawal_enabled\": \"on\",\n \"deposit_enabled\": \"on\",\n \"last_interest_at\": \"2025-03-03 00:00:00\",\n \"created_at\": \"2024-06-27 09:11:52\",\n \"updated_at\": \"2024-06-27 09:11:52\",\n \"total_balance\": 0\n },\n {\n \"serial_id\": 3,\n \"vault_id\": \"d130a489-b0b4-4a68-8821-01ee95868832\",\n \"currency_id\": \"ETH\",\n \"name\": \"flexible /3%\",\n \"annual_rate_percent\": 3,\n \"max_withdrawal_amount\": 1,\n \"max_deposit_amount\": 1,\n \"min_withdrawal_amount\": 0.001,\n \"min_deposit_amount\": 0.001,\n \"cut_off_time_seconds\": 86400,\n \"lock_in_period_seconds\": 0,\n \"effective_date_from\": \"2024-06-26 21:00:00\",\n \"effective_date_to\": \"2025-06-30 20:59:59\",\n \"rate_type\": \"flexible\",\n \"is_active\": \"on\",\n \"withdrawal_enabled\": \"on\",\n \"deposit_enabled\": \"on\",\n \"last_interest_at\": \"2025-03-03 00:00:00\",\n \"created_at\": \"2024-06-27 09:10:35\",\n \"updated_at\": \"2024-06-27 14:03:32\",\n \"total_balance\": 1.563453033482\n },\n {\n \"serial_id\": 1,\n \"vault_id\": \"e3ea32a1-5fff-4ee7-a45f-95085218b13e\",\n \"currency_id\": \"BTC\",\n \"name\": \"flexible /3%\",\n \"annual_rate_percent\": 3,\n \"max_withdrawal_amount\": 100,\n \"max_deposit_amount\": 100,\n \"min_withdrawal_amount\": 0,\n \"min_deposit_amount\": 0,\n \"cut_off_time_seconds\": 86400,\n \"lock_in_period_seconds\": 0,\n \"effective_date_from\": \"2024-06-26 21:00:00\",\n \"effective_date_to\": \"2025-06-30 20:59:59\",\n \"rate_type\": \"flexible\",\n \"is_active\": \"on\",\n \"withdrawal_enabled\": \"on\",\n \"deposit_enabled\": \"on\",\n \"last_interest_at\": \"2025-03-03 00:00:00\",\n \"created_at\": \"2024-06-27 09:07:16\",\n \"updated_at\": \"2024-06-27 09:08:36\",\n \"total_balance\": 5.332942758707\n }\n ]\n }\n}"}],"_postman_id":"4328e9c0-1e22-4e1d-a7d2-a45e64e9ddc6"},{"name":"Get Earn Balances","id":"f9d2e768-601c-41bb-a046-d0b4576323b8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"{{vault:bearer-token}}","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"query {\n accounts_balances {\n currency_id\n total_balance\n exposed_balance\n margin_exposure\n free_balance\n }\n}","variables":"{\n}"}},"url":"https://live-api.ouinex.com/graphql","description":"This request retrieves the balances of a user's earn accounts
\n","urlObject":{"protocol":"https","path":["graphql"],"host":["live-api","ouinex","com"],"query":[],"variable":[]}},"response":[{"id":"3a257d4e-e583-4f34-bb86-fb69035cefd9","name":"Get Earn Balances","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"{{vault:bearer-token}}","type":"text"}],"body":{"mode":"graphql"},"url":"https://live-api.ouinex.com/graphql"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 03 Mar 2025 20:49:37 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"cache-control","value":"no-store"},{"key":"ETag","value":"W/\"12ab-+b3Ajn7aBTsfG8JFEnaevKiFY8I\""},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"accounts_balances\": [\n {\n \"currency_id\": \"AVAX\",\n \"total_balance\": 0,\n \"exposed_balance\": 0,\n \"margin_exposure\": 0,\n \"free_balance\": 0\n },\n {\n \"currency_id\": \"BCH\",\n \"total_balance\": 0,\n \"exposed_balance\": 0,\n \"margin_exposure\": 0,\n \"free_balance\": 0\n },\n {\n \"currency_id\": \"BNB\",\n \"total_balance\": 0,\n \"exposed_balance\": 0,\n \"margin_exposure\": 0,\n \"free_balance\": 0\n },\n {\n \"currency_id\": \"BTC\",\n \"total_balance\": 0.0026484,\n \"exposed_balance\": 0.001,\n \"margin_exposure\": 0,\n \"free_balance\": 0.0016484\n }\n ]\n }\n}"}],"_postman_id":"f9d2e768-601c-41bb-a046-d0b4576323b8"},{"name":"Create Earn Deposit","id":"611acf80-1799-44f6-b99d-da94f28fec4f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"{{vault:bearer-token}}","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"mutation ($vault_id: String!, $amount: Float!, $user_id: String) {\n create_vault_deposit(\n vault_id: $vault_id\n amount: $amount\n user_id: $user_id\n ) {\n amount\n balance_after\n currency_id\n transaction_type\n transaction_class\n comment\n created_by\n created_at\n }\n}","variables":"{\n \"vault_id\": \"d130a489-b0b4-4a68-8821-01ee95868832\",\n \"amount\": 0.01\n}"}},"url":"https://live-api.ouinex.com/graphql","description":"This request initiates a deposit into an earn program, allocating a specified amount of funds to generate yield.
\nThis query estimates the interest that would be earned for a given deposit amount in a specified vault over a certain duration. It helps users understand potential earnings before making a deposit.
\nThis request initiates a withdrawal from an earn program, allocating a specified amount of funds to spot wallet.
\nThis query retrieves a all earb transactions, including deposits, withdrawals, and interests.
\nRetrieves user's referral codes from the system.
\n","urlObject":{"protocol":"https","path":["graphql"],"host":["live-api","ouinex","com"],"query":[],"variable":[]}},"response":[{"id":"23e3a298-8045-444b-8dcd-e28272131af6","name":"Get Referral Codes","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"{{vault:bearer-token}}","type":"text"}],"body":{"mode":"graphql"},"url":"https://live-api.ouinex.com/graphql"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 04 Mar 2025 19:56:04 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"115"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"cache-control","value":"no-store"},{"key":"ETag","value":"W/\"73-36kESiJxEzWMw9C+0oMnZXqAvMI\""},{"key":"Vary","value":"Accept-Encoding"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"referrals\": [\n {\n \"referral_id\": \"7ced21d6-e45d-4712-ad66-*********\",\n \"created_at\": \"2025-02-25 14:28:44\"\n }\n ]\n }\n}"}],"_postman_id":"fb06958d-8550-49f9-9ebd-d4347ed7d7d5"},{"name":"Generate Referral Code","id":"4f4aa68f-3afe-4547-98db-41aa54c66fb9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"{{vault:bearer-token}}","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"mutation {\n create_referral {\n referral_id\n created_at\n }\n}","variables":"{}"}},"url":"https://live-api.ouinex.com/graphql","description":"This endpoint allows users to generate a referral code that can be shared with others.
\n","urlObject":{"protocol":"https","path":["graphql"],"host":["live-api","ouinex","com"],"query":[],"variable":[]}},"response":[{"id":"83ffa60d-146e-4b8b-84e1-4f58f077bd44","name":"Generate Referral Code","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"}],"body":{"mode":"graphql"},"url":"https://live-api.ouinex.com/graphql"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 04 Mar 2025 20:05:17 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"119"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"cache-control","value":"no-store"},{"key":"ETag","value":"W/\"77-xrj1C839e5InqnEWxkJHHEvRiQE\""},{"key":"Vary","value":"Accept-Encoding"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"create_referral\": {\n \"referral_id\": \"ca93916f-70ed-4006-80a2-*********\",\n \"created_at\": \"2025-03-04 20:05:17\"\n }\n }\n}"}],"_postman_id":"4f4aa68f-3afe-4547-98db-41aa54c66fb9"},{"name":"Number of Referred Users","id":"b400cdc4-333e-41c9-9b56-5153259eb029","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"{{vault:bearer-token}}","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"query {\n referred_users_count\n}","variables":"{}"}},"url":"https://live-api.ouinex.com/graphql","description":"This endpoint retrieves the total number of users who have signed up using a referral code with the requesting user.
\n","urlObject":{"protocol":"https","path":["graphql"],"host":["live-api","ouinex","com"],"query":[],"variable":[]}},"response":[{"id":"b058a3d0-e26b-4434-8239-e125a3d151a1","name":"Number of Referred Users","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"{{vault:bearer-token}}","type":"text"}],"body":{"mode":"graphql"},"url":"https://live-api.ouinex.com/graphql"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 04 Mar 2025 20:34:39 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"36"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"cache-control","value":"no-store"},{"key":"ETag","value":"W/\"24-3Lg/2Vp8uYNsavoV9KcKQ1u11Aw\""},{"key":"Vary","value":"Accept-Encoding"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"referred_users_count\": 193\n }\n}"}],"_postman_id":"b400cdc4-333e-41c9-9b56-5153259eb029"},{"name":"Referrer Total Reward in Quoted Currency","id":"1463453b-bb58-47c0-91b8-5811fbd53d0a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"{{vault:bearer-token}}","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"query Query($quoteCurrencyId: String!) {\n referrer_total_reward_quoted(quote_currency_id: $quoteCurrencyId)\n}","variables":"{\n \"quoteCurrencyId\": \"USD\"\n}"}},"url":"https://live-api.ouinex.com/graphql","description":"This endpoint retrieves the total number of users who have signed up using a referral code with the requesting user.
\n","urlObject":{"protocol":"https","path":["graphql"],"host":["live-api","ouinex","com"],"query":[],"variable":[]}},"response":[{"id":"c416ab7d-91f1-4c05-847a-f2479a8a5d9f","name":"Referrer Total Reward in Quoted Currency","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"{{vault:bearer-token}}","type":"text"}],"body":{"mode":"graphql"},"url":"https://live-api.ouinex.com/graphql"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 04 Mar 2025 20:49:48 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"44"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"cache-control","value":"no-store"},{"key":"ETag","value":"W/\"2c-mt7fbMPPSytDKzfZCON+oRnW2J4\""},{"key":"Vary","value":"Accept-Encoding"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"referrer_total_reward_quoted\": 2000\n }\n}"}],"_postman_id":"1463453b-bb58-47c0-91b8-5811fbd53d0a"},{"name":"Get Referral Transactions","id":"7990edba-3c6d-4483-8516-c5c223e9decc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"{{vault:bearer-token}}","type":"text"}],"body":{"mode":"graphql","graphql":{"query":"query (\n $account_transaction_id: String\n $pager: PagerInput\n $date_range: DateRangeInput\n $search: String\n $referral_id: String\n $reward_type: ReferralRewardType\n $target_user_id: String\n) {\n referrals_transactions_info(\n account_transaction_id: $account_transaction_id\n pager: $pager\n date_range: $date_range\n search: $search\n referral_id: $referral_id\n reward_type: $reward_type\n target_user_id: $target_user_id\n ) {\n target_user_id\n referral_id\n reward_type\n account_transaction_id\n created_at\n account_transaction {\n currency_id\n amount\n }\n }\n}","variables":"{\n \"pager\": {\n \"offset\": 0,\n \"limit\": 10\n }\n}"}},"url":"https://live-api.ouinex.com/graphql","description":"This endpoint retrieves the full transaction history related to referral rewards.
\nThis endpoint retrieves the user's notification preferences, detailing which event types trigger notifications across different communication channels. The response categorizes notifications into four channels:
\n- Client: In-app notifications for key events like order updates, payments, conversions, ect...
- Email: A broader set of notifications, including order status, payments, trades, KYC updates, security events (e.g., MFA enabled), and referral rewards.
- Push: Push notifications can be enabled for clients, allowing real-time updates on order statuses, payments, security events, and other platform activities.
- SMS: SMS notifications are available for clients who enable them, providing alerts on critical trading and order status updates.
This endpoint allows users to customize their notification preferences by enabling or disabling specific event alerts across different communication channels.
\n","urlObject":{"protocol":"https","path":["graphql"],"host":["live-api","ouinex","com"],"query":[],"variable":[]}},"response":[{"id":"c4d3c446-7851-4c4c-b43c-398229b499b7","name":"Update Notification Preferences","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"{{vault:bearer-token}}","type":"text"}],"body":{"mode":"graphql"},"url":"https://live-api.ouinex.com/graphql"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 04 Mar 2025 21:21:48 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"360"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"cache-control","value":"no-store"},{"key":"ETag","value":"W/\"168-etk4jXD3mBtUrq5M7EvBsbhqqWE\""},{"key":"Vary","value":"Accept-Encoding"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"update_user\": {\n \"notifications_options\": {\n \"client\": [\n \"signin\",\n \"user_created\",\n \"user_updated\",\n \"account_created\",\n \"crypto_address_created\",\n \"kyc_approved\",\n \"kyc_rejected\",\n \"kyc_incomplete\",\n \"trade_completed\",\n \"order_completed\",\n \"order_rejected\",\n \"conversion_completed\",\n \"conversion_rejected\",\n \"payment_rejected\",\n \"payment_completed\"\n ],\n \"push\": [],\n \"email\": [],\n \"sms\": []\n }\n }\n }\n}"}],"_postman_id":"cca9a5ae-920c-4fab-a188-7f0ecc1f855d"}],"id":"74796000-ba48-4a7c-822d-3f10dd5f4a3e","_postman_id":"74796000-ba48-4a7c-822d-3f10dd5f4a3e","description":""},{"name":"Type Definitions","item":[],"id":"db90fb0b-2f85-4476-8385-2f6a394cc1cb","description":"An enum that defines the type of currency.
\nValues:
- `fiat`: Standard government-issued currency
- `crypto`: Cryptocurrency like Bitcoin or Ethereum
An enum that defines the classification of account transactions.
Values:
trade: Transactions related to trading activities
fee: Service or transaction fee charges
payment: Payment transactions (deposits/withdrawals)
reward: Bonus or reward transactions
conversion: Currency conversion transactions
manual: Manually adjusted transactions
referral_reward: Rewards from referral program
An enum that defines the direction of the transaction.
Values:
debit: Outgoing transaction (decrease in balance)
credit: Incoming transaction (increase in balance)
An object that defines pagination parameters.
Properties:
limit: Maximum number of records to return (default: 30)
offset: Number of records to skip (default: 0)
An object that defines sorting parameters.
Properties:
direction: Sort direction (\"ASC\" or \"DESC\", default: \"DESC\")
property: Field name to sort by
An object that defines a time period filter.
Properties:
time_from: Start date-time
time_to: End date-time
An enum that defines the method for calculating fees.
Values:
sum: Total sum of all applicable fees
max: Maximum value among all applicable fees
A key-value pair structure for specifying withdrawal properties.
\nValues:
\nname: Property identifier (string). Possible values:
fiat_transfer_type: Type of bank transfer (e.g., \"wire\", \"sepa\", \"ach\")
fiat_bank_name: Name of the receiving bank
fiat_bank_bic: BIC/SWIFT code of the bank
fiat_bank_iban: IBAN number of the bank account
fiat_beneficiary_name: Full name of the beneficiary
etc...
\nvalue: The corresponding value for the selected property name (string)