pipsocketDOCS
API reference / Account data

Positions

GET/v1/accounts/{account}/positions

The account's open positions, read fresh from its terminal.

Path

accountstringrequired

The account's id, acc_ and 26 characters, as the dashboard shows it.

Response

A list of these
ticketinteger
MT5 · POSITION_TICKET

The position's ticket: use it to close the position or set its stops.

identifierinteger
MT5 · POSITION_IDENTIFIER

The position's id, which stays the same if the broker changes the ticket.

symbolstring
MT5 · POSITION_SYMBOL
typeenum

buy or sell (MT5's POSITION_TYPE).

buysell
volumenumber
MT5 · POSITION_VOLUME
price_opennumber
MT5 · POSITION_PRICE_OPEN
slnumber
MT5 · POSITION_SL
tpnumber
MT5 · POSITION_TP
magicinteger
MT5 · POSITION_MAGIC
commentstring
MT5 · POSITION_COMMENT
time_mscinteger
MT5 · POSITION_TIME_MSC

When it was opened: broker server time, milliseconds since 1970.

Errors

401invalid_api_key

The key is not a workspace's current key (a rolled key stops working within about a minute).

401missing_api_key

No API key: send it as Authorization: Bearer <key>.

404no_such_account

No such account, or one the key's workspace doesn't have: the two look the same.

503account_not_connected

The account's terminal is not connected to the engine (stopped, starting, or restarting). Nothing was sent, except by the kill switch: engaging it still engages it, and may already have deleted pending orders.

503engine_busy

The account's engine host has too many calls in flight (256). Nothing was done; try again.

503engine_unavailable

The account's engine host is not connected to Pipsocket, or disconnected while the call waited. A trade it already had is still settled: look it up.

504engine_timeout

The account's engine did not answer within 30 seconds.

504terminal_timeout

The account's terminal did not answer within 5 seconds.