{"info":{"_postman_id":"21992b88-3050-4a52-a4b6-8b559a24d676","name":"Forex Api Documentation","description":"

Order Types

\n

The order_type parameter is represented as an integer value in the request. Below are the supported order types:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
TypeDescription
0BuyPlaces a standard Buy order.
1SellPlaces a standard Sell order.
2Buy LimitPlaces a Buy order at or below a specific price.
3Sell LimitPlaces a Sell order at or above a specific price.
4Buy StopTriggers a Buy order once the price rises to a set level.
5Sell StopTriggers a Sell order once the price falls to a set level.
6Buy StopLimitCombination of Stop and Limit for Buy orders.
7Sell StopLimitCombination of Stop and Limit for Sell orders.
\n

States

\n

The state field in the response indicates the current status of the order as an integer value:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ValueStateDescription
0STARTEDThe order creation process has started.
1PLACEDThe order has been successfully placed.
2CANCELEDThe order has been canceled by the user/system.
3PARTIALThe order has been partially filled.
4FILLEDThe order has been fully filled.
5REJECTEDThe order was rejected by the exchange or system.
6EXPIREDThe order expired due to time-in-force or market conditions.
7REQUEST_ADDThe order is queued and waiting to be added to the system.
\n
","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"31840486","collectionId":"21992b88-3050-4a52-a4b6-8b559a24d676","publishedId":"2sB2xFfTme","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2025-12-17T11:39:06.000Z"},"item":[{"name":"Admin API","item":[{"name":"GetMasterToken","id":"63f779ab-51c7-4aec-86fb-57c18095fbea","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"email\": \"{{email}}\", // AlgoDeltaFx Login Email\r\n \"password\": {{password}}, // AlgoDeltaFx Login Password\r\n \"domain\": \"https://algodeltafx.com\" // Use Domain Name As it is\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.algodeltafx.com/api/v1/auth/userlogin","urlObject":{"path":["auth","userlogin"],"host":["https://api.algodeltafx.com/api/v1"],"query":[],"variable":[]}},"response":[],"_postman_id":"63f779ab-51c7-4aec-86fb-57c18095fbea"},{"name":"AddFxBroker","id":"3599827b-c5b3-42d5-b928-1d809f405f9b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"{{vault:json-web-token}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"nic_name\": \"Joe Max\",\r\n \"fx_server\": {{fx_server}}, // Broker Server Name For Ex. Exness-MT5Real29\r\n \"fx_login\": {{fx_login}}, // Broker Forex MT5-ID For Ex. ****2122\r\n \"fx_password\": {{fx_password}}, // Broker Account's Password\r\n \"is_host_based\": true, // Boolean Value Either true or false (Based On How Account Being Added)\r\n \"fx_host\": {{fx_host}}, // IP of Fx Account For Ex. 192.168.1.1\r\n \"fx_port\": {{fx_port}} // Default Port 443\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.algodeltafx.com/api/v1/users/broker/addfxbroker","urlObject":{"path":["users","broker","addfxbroker"],"host":["https://api.algodeltafx.com/api/v1"],"query":[],"variable":[]}},"response":[],"_postman_id":"3599827b-c5b3-42d5-b928-1d809f405f9b"},{"name":"ReplaceBroker","id":"33034d2e-063b-4c82-9ae7-f3035518b1d1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"{{vault:json-web-token}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"broker_id\": {{broker_id}}, // Broker ID Which Needs to replace\r\n \"nic_name\": \"Joe Max\",\r\n \"fx_server\": {{fx_server}}, // Broker Server Name For Ex. Exness-MT5Real29\r\n \"fx_login\": {{fx_login}}, // Broker Forex MT5-ID For Ex. ****2122\r\n \"fx_password\": {{fx_password}}, // Broker Account's Password\r\n \"is_host_based\": true, // Boolean Value Either true or false (Based On How Account Being Added)\r\n \"fx_host\": {{fx_host}}, // IP of Fx Account For Ex. 192.168.1.1\r\n \"fx_port\": {{fx_port}} // Default Port 443\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.algodeltafx.com/api/v1/users/broker/replacebroker","urlObject":{"path":["users","broker","replacebroker"],"host":["https://api.algodeltafx.com/api/v1"],"query":[],"variable":[]}},"response":[],"_postman_id":"33034d2e-063b-4c82-9ae7-f3035518b1d1"},{"name":"DeleteBroker","id":"688cd0dc-2562-4ce0-8479-a6a6202e83c4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"{{vault:json-web-token}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"broker_id\": {{broker_id}}\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.algodeltafx.com/api/v1/users/broker/deletebroker","urlObject":{"path":["users","broker","deletebroker"],"host":["https://api.algodeltafx.com/api/v1"],"query":[],"variable":[]}},"response":[],"_postman_id":"688cd0dc-2562-4ce0-8479-a6a6202e83c4"},{"name":"GetBrokers","id":"387aeb02-3a60-4f2d-b4b4-31963d01c2cb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"{{vault:json-web-token}}","type":"text"}],"url":"https://api.algodeltafx.com/api/v1/users/broker/getbrokers","urlObject":{"path":["users","broker","getbrokers"],"host":["https://api.algodeltafx.com/api/v1"],"query":[],"variable":[]}},"response":[],"_postman_id":"387aeb02-3a60-4f2d-b4b4-31963d01c2cb"},{"name":"GetDailyProfit","id":"e07323d3-a81b-45a4-b9a5-9ea707b47417","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"{{vault:json-web-token}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"broker_id\": {{broker_id}},\r\n \"offset\": 0, // Default 0\r\n \"limit\": 10, // Default 10\r\n \"start_date\": \"2025-12-09\",\r\n \"end_date\": \"2025-12-09\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.algodeltafx.com/api/v1/users/broker/getdailyprofit","urlObject":{"path":["users","broker","getdailyprofit"],"host":["https://api.algodeltafx.com/api/v1"],"query":[],"variable":[]}},"response":[],"_postman_id":"e07323d3-a81b-45a4-b9a5-9ea707b47417"},{"name":"GetGroups","id":"2b1c4af1-0832-4596-a3b0-db9a57ee2166","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"{{vault:json-web-token}}","type":"text"}],"url":"https://api.algodeltafx.com/api/v1/users/group/getgroups","urlObject":{"path":["users","group","getgroups"],"host":["https://api.algodeltafx.com/api/v1"],"query":[],"variable":[]}},"response":[],"_postman_id":"2b1c4af1-0832-4596-a3b0-db9a57ee2166"},{"name":"AddGroupBroker","id":"f168da3e-2008-4901-a4e9-9cd6e6468e42","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"{{vault:json-web-token}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"group_id\": {{group_id}},\r\n \"broker_id\": {{broker_id}},\r\n \"is_fix_lot\": false, // Default False\r\n \"is_balance_based\": false, // Default False\r\n \"fix_lot\": 0.01, // Default 0.01\r\n \"multiplier\": 1 // Default 1\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.algodeltafx.com/api/v1/users/group/addgroupbroker","urlObject":{"path":["users","group","addgroupbroker"],"host":["https://api.algodeltafx.com/api/v1"],"query":[],"variable":[]}},"response":[],"_postman_id":"f168da3e-2008-4901-a4e9-9cd6e6468e42"},{"name":"UpdateGroupBroker","id":"5aedc8e3-a17e-4dd7-96b9-c3702c66b94e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"{{vault:json-web-token}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"group_broker_id\": {{group_broker_id}},\r\n \"is_fix_lot\": false, // Based on Set or Changes if Done\r\n \"is_balance_based\": false, // Based on Set or Changes if Done\r\n \"fix_lot\": 0.01, // Default 0.01\r\n \"multiplier\": 1 // Default 1\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.algodeltafx.com/api/v1/users/group/updategroupbroker","urlObject":{"path":["users","group","updategroupbroker"],"host":["https://api.algodeltafx.com/api/v1"],"query":[],"variable":[]}},"response":[],"_postman_id":"5aedc8e3-a17e-4dd7-96b9-c3702c66b94e"},{"name":"UpdateChildTradingFlag","id":"5461fa87-49e7-4c4d-98b1-50c241c63fa9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"{{vault:json-web-token}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"group_broker_id\": {{group_broker_id}},\r\n \"trading_flag\": true\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.algodeltafx.com/api/v1/users/group/updatechildtradingflag","urlObject":{"path":["users","group","updatechildtradingflag"],"host":["https://api.algodeltafx.com/api/v1"],"query":[],"variable":[]}},"response":[],"_postman_id":"5461fa87-49e7-4c4d-98b1-50c241c63fa9"},{"name":"RemoveGroupBroker","id":"29b65567-5553-450c-8569-9d19289cd4b1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"{{vault:json-web-token}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"group_broker_id\": {{group_broker_id}}\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.algodeltafx.com/api/v1/users/group/removegroupbroker","urlObject":{"path":["users","group","removegroupbroker"],"host":["https://api.algodeltafx.com/api/v1"],"query":[],"variable":[]}},"response":[],"_postman_id":"29b65567-5553-450c-8569-9d19289cd4b1"},{"name":"GetGroupBrokers","id":"cd204779-2e00-4450-9fef-20620495cdfe","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"{{vault:json-web-token}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"group_id\": {{group_id}}\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.algodeltafx.com/api/v1/users/group/getgroupbrokers","urlObject":{"path":["users","group","getgroupbrokers"],"host":["https://api.algodeltafx.com/api/v1"],"query":[],"variable":[]}},"response":[],"_postman_id":"cd204779-2e00-4450-9fef-20620495cdfe"}],"id":"d9a77051-616c-40e6-95eb-9bd9d325197c","_postman_id":"d9a77051-616c-40e6-95eb-9bd9d325197c","description":""},{"name":"User API","item":[{"name":"GetProfile","id":"74a6cd8e-0ad6-425a-b21e-b2a7ce3e55e0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{vault:json-web-token}}","type":"text"}],"url":"https://api.algodeltafx.com/api/v2/forexaccount/getprofile","urlObject":{"host":["https://api.algodeltafx.com/api/v2/forexaccount/getprofile"],"query":[],"variable":[]}},"response":[],"_postman_id":"74a6cd8e-0ad6-425a-b21e-b2a7ce3e55e0"},{"name":"Get Symbols","id":"7490d9cc-17e9-4601-8805-299f00ec487b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{vault:json-web-token}}","type":"text"}],"url":"https://api.algodeltafx.com/api/v2/forexaccount/getsymbols","urlObject":{"host":["https://api.algodeltafx.com/api/v2/forexaccount/getsymbols"],"query":[],"variable":[]}},"response":[],"_postman_id":"7490d9cc-17e9-4601-8805-299f00ec487b"},{"name":"GetPendingOrders","id":"d1face92-882f-44d4-a9a1-53bf94b0d46e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{vault:json-web-token}}","type":"text"}],"url":"https://api.algodeltafx.com/api/v2/forexaccount/getpendingorders","urlObject":{"host":["https://api.algodeltafx.com/api/v2/forexaccount/getpendingorders"],"query":[],"variable":[]}},"response":[],"_postman_id":"d1face92-882f-44d4-a9a1-53bf94b0d46e"},{"name":"GetOpenPositions","id":"ea3e74b6-730e-4128-9ca5-96ace2a60328","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{vault:json-web-token}}","type":"text"}],"url":"https://api.algodeltafx.com/api/v2/forexaccount/getopenpositions","urlObject":{"host":["https://api.algodeltafx.com/api/v2/forexaccount/getopenpositions"],"query":[],"variable":[]}},"response":[],"_postman_id":"ea3e74b6-730e-4128-9ca5-96ace2a60328"},{"name":"PlaceOrder","id":"51089333-3599-41a0-8279-1b12f04ae8a2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{vault:json-web-token}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"symbol\": \"EURUSDm\",\r\n \"type\": 0,\r\n \"volume\": 0.23\r\n // \"price\": ,\r\n // \"sl\": 1.13560,\r\n // \"tp\": 1.15890\r\n // \"stop_limit\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.algodeltafx.com/api/v2/forexaccount/placeorder","urlObject":{"host":["https://api.algodeltafx.com/api/v2/forexaccount/placeorder"],"query":[],"variable":[]}},"response":[],"_postman_id":"51089333-3599-41a0-8279-1b12f04ae8a2"},{"name":"ModifyOrderOrPosition","id":"613c5908-cebc-4488-8330-2fb936612e0e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{vault:json-web-token}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"ticket\": 1093918439,\r\n // \"price\": ,\r\n \"sl\": 1.13560,\r\n \"tp\": 1.15890\r\n // \"stop_limit\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.algodeltafx.com/api/v2/forexaccount/modifyorderorposition","urlObject":{"host":["https://api.algodeltafx.com/api/v2/forexaccount/modifyorderorposition"],"query":[],"variable":[]}},"response":[],"_postman_id":"613c5908-cebc-4488-8330-2fb936612e0e"},{"name":"CancelOrder","id":"fca95f43-5027-43a3-9304-39e1516a5670","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{vault:json-web-token}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n // \"ticket\": 1093727748\r\n \"symbol\": \"EURUSD\",\r\n \"side\": \"SELL\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.algodeltafx.com/api/v2/forexaccount/cancelorder","urlObject":{"host":["https://api.algodeltafx.com/api/v2/forexaccount/cancelorder"],"query":[],"variable":[]}},"response":[],"_postman_id":"fca95f43-5027-43a3-9304-39e1516a5670"},{"name":"SquarePosition","id":"c322b747-c772-44dd-a90b-c0eba381aa66","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{vault:json-web-token}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n // \"ticket\": 1093765759,\r\n // \"volume\": 0.25\r\n \"symbol\": \"EURUSD\"\r\n // \"side\": \"SELL\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.algodeltafx.com/api/v2/forexaccount/squareoffposition","urlObject":{"host":["https://api.algodeltafx.com/api/v2/forexaccount/squareoffposition"],"query":[],"variable":[]}},"response":[],"_postman_id":"c322b747-c772-44dd-a90b-c0eba381aa66"}],"id":"7319f8b2-f790-4587-a22d-48e9c338cd2d","_postman_id":"7319f8b2-f790-4587-a22d-48e9c338cd2d","description":""}],"event":[{"listen":"prerequest","script":{"id":"2660824e-2dc1-4ccd-a759-4a7e82ce9b7d","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"096a81a4-82a9-49f9-94c2-b0f78a131a1f","type":"text/javascript","packages":{},"exec":[""]}}],"variable":[{"id":"d19d1783-ae8a-4be3-89d2-6e7bfd447ca6","key":"algodeltafx_api","value":"https://api.algodeltafx.com/api/v2/forexaccount/","type":"string"},{"id":"f3a11dbb-2a59-43fa-b4d7-481b8468b175","key":"auth_token","value":"{{vault:json-web-token}}","type":"string"},{"id":"883c9693-33ee-4bff-b1cc-c566513d5d2e","key":"master_token","value":"{{vault:json-web-token}}","type":"string"},{"id":"86d08cad-7a20-47b0-9f3c-ed2492886e78","key":"algodeltafx_admin_api","value":"https://api.algodeltafx.com/api/v1","type":"string"}]}