List positions

GET

api

accounts

{login}

positions

List open positions

curl --request GET \
  --url https://api-trading.vexprofx.com/api/v1/accounts/{login}/positions \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api-trading.vexprofx.com/api/v1/accounts/{login}/positions"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api-trading.vexprofx.com/api/v1/accounts/{login}/positions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "retcode": "<string>",
  "answer": [
    {
      "Position": "<string>",
      "Symbol": "<string>",
      "Action": "<string>",
      "TimeCreate": "<string>",
      "PriceOpen": "<string>",
      "PriceCurrent": "<string>",
      "PriceSL": "<string>",
      "PriceTP": "<string>",
      "Volume": "<string>",
      "Profit": "<string>",
      "Storage": "<string>"
    }
  ]
}

{
  "detail": "Invalid request"
}

What this operation does

Use offset from 0 and total from 1 to 1000 (100 by default). Traverse all pages and keep the Position ticket for closing orders.

Response fields

A successful response contains only retcode and an answer array. Each position allows only these fields: Position, Symbol, Action, TimeCreate, PriceOpen, PriceCurrent, PriceSL, PriceTP, Volume, Profit, Storage. Additional MT5 fields are excluded. Received values and types are preserved; missing fields are omitted. With no positions, answer is []. TimeCreate and TimeUpdate are Unix timestamps in seconds; their Msc variants use milliseconds. Errors retain their usual format.

{
  "retcode": "0 Done",
  "answer": [
    {
      "Position": "82313217",
      "Symbol": "XAUUSD",
      "Action": "1",
      "TimeCreate": "1790252238",
      "PriceOpen": "4269.64",
      "PriceCurrent": "4151.76",
      "PriceSL": "0.00",
      "PriceTP": "0.00",
      "Volume": "10000",
      "Profit": "11788.00",
      "Storage": "-260.88"
    }
  ]
}

Complete workflow

See the step-by-step guide and errors and their handling. Playground values are examples. Replace the account, symbol, volume, and price with valid data for your integration.

Authorizations

Authorization

string

header

required

Send the provider-issued token in the Authorization header using Bearer authentication.

Path Parameters

Query Parameters

offset

integer

default:0

Required range: x >= 0

total

integer

default:100

Required range: 1 <= x <= 1000

Response

Successful Response

retcode

string

required

answer

PositionData · object[]

required

Show child attributes

List open positions

curl --request GET \
  --url https://api-trading.vexprofx.com/api/v1/accounts/{login}/positions \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api-trading.vexprofx.com/api/v1/accounts/{login}/positions"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api-trading.vexprofx.com/api/v1/accounts/{login}/positions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "retcode": "<string>",
  "answer": [
    {
      "Position": "<string>",
      "Symbol": "<string>",
      "Action": "<string>",
      "TimeCreate": "<string>",
      "PriceOpen": "<string>",
      "PriceCurrent": "<string>",
      "PriceSL": "<string>",
      "PriceTP": "<string>",
      "Volume": "<string>",
      "Profit": "<string>",
      "Storage": "<string>"
    }
  ]
}

{
  "detail": "Invalid request"
}

Availability

Accounts

Market and account state

Trading

What this operation does

Response fields

Complete workflow

Authorizations

Path Parameters

Query Parameters

Response

​What this operation does

​Response fields

​Complete workflow

Authorizations

Path Parameters

Query Parameters

Response

What this operation does

Response fields

Complete workflow