REST API reference

Every endpoint of the JAFX Trading API v1, generated from the OpenAPI 3.1 specification. Base URL https://terminal.jafx.com/trading-api/v1. Send your key on every request as Authorization: Bearer <key>; every write also needs an Idempotency-Key header (see Conventions).

Endpoint	What it does	Scope
GET `/status`	Service status (no key needed)	No key needed
GET `/me`	The calling key, its limits and the trading state	Any valid key
GET `/symbols`	Tradable instruments	`market:read`
GET `/symbols/{symbol}`	One instrument	`market:read`
GET `/quotes`	Current quotes	`market:read`
GET `/candles/{symbol}`	OHLC candles (the last one may still be forming)	`market:read`
GET `/accounts`	The key's account (a list of one)	`account:read`
GET `/accounts/{account}`	Account summary	`account:read`
GET `/accounts/{account}/positions`	Open positions	`account:read`
GET `/accounts/{account}/orders`	Pending orders	`account:read`
GET `/accounts/{account}/trades`	Trades closed in a window (by close time), newest first	`account:read`
GET `/accounts/{account}/transactions`	Balance and credit operations	`account:read`
PATCH `/accounts/{account}/positions/{ticket}`	Change stop loss / take profit (null removes one; an omitted one is kept)	`trade` or `trade:propose`
POST `/accounts/{account}/positions/{ticket}/close`	Close a position, wholly or partly	`trade` or `trade:propose`
POST `/accounts/{account}/orders`	Place a market or pending order	`trade` or `trade:propose`
PATCH `/accounts/{account}/orders/{ticket}`	Change a pending order (omitted fields are kept; null removes a stop or the expiry)	`trade` or `trade:propose`
DELETE `/accounts/{account}/orders/{ticket}`	Cancel a pending order	`trade` or `trade:propose`
GET `/accounts/{account}/requests/{request_id}`	Where an order request stands	`account:read`
GET `/accounts/{account}/proposals`	Proposals created by this key (confirm mode)	`trade` or `trade:propose`

Status and key

Service status and the calling key's scopes, limits and trading state.

GET `/status`

Service status (no key needed)

Scope: No key needed

Responses

200 Status — Status
4xx/5xx Problem document with a stable code

Request

curl

curl "https://terminal.jafx.com/trading-api/v1/status" \
  -H "Authorization: Bearer $JAFX_API_KEY"

Response 200

JSON

{
  "status": "ok",
  "api_version": "v1",
  "time": "2026-10-13T09:30:00.000Z",
  "market_data": {
    "connected": true,
    "symbols": 39,
    "last_tick_age_ms": 180
  },
  "broker": {
    "state": "connected"
  },
  "live_trading_enabled": false
}

GET `/me`

The calling key, its limits and the trading state

Scope: Any valid key

Responses

200 Key — Me
4xx/5xx Problem document with a stable code

Request

curl

curl "https://terminal.jafx.com/trading-api/v1/me" \
  -H "Authorization: Bearer $JAFX_API_KEY"

Response 200

JSON

{
  "key_id": "k7mx2v9qr4tz8w1b6nfa",
  "name": "breakout bot",
  "account": 123456,
  "mode": "demo",
  "profile": "client",
  "scopes": [
    "market:read",
    "account:read",
    "trade"
  ],
  "constraints": {
    "demo_only": true,
    "max_volume_per_order": "1.00",
    "max_open_positions": 20,
    "orders_per_minute": 30,
    "modifications_per_minute": 60,
    "daily_loss_limit": {
      "type": "percent",
      "value": "10"
    },
    "symbols": null,
    "ip_allowlist": null,
    "confirm_mode": false,
    "mcp_enabled": true
  },
  "expires_at": "2027-01-11T09:30:00.000Z",
  "trading": {
    "mode": "on",
    "level": "env",
    "reason": null
  },
  "live_trading_enabled": false
}

Market data

Instruments, quotes and candles from the central JAFX quote board.

GET `/symbols`

Tradable instruments

Scope: market:read

Responses

200 Instruments
4xx/5xx Problem document with a stable code

Field	Type	Description
`data`	array of Symbol

Request

curl

curl "https://terminal.jafx.com/trading-api/v1/symbols" \
  -H "Authorization: Bearer $JAFX_API_KEY"

Response 200

JSON

{
  "data": [
    {
      "symbol": "EURUSD",
      "description": "Euro vs US Dollar",
      "group": "Forex",
      "digits": 5,
      "contract_size": 100000,
      "tick_size": 0.00001,
      "volume_min": "0.01",
      "volume_max": "100",
      "volume_step": "0.01",
      "trade_mode": "full",
      "long_only": false
    },
    {
      "symbol": "GBPUSD",
      "description": "Great Britain Pound vs US Dollar",
      "group": "Forex",
      "digits": 5,
      "contract_size": 100000,
      "tick_size": 0.00001,
      "volume_min": "0.01",
      "volume_max": "100",
      "volume_step": "0.01",
      "trade_mode": "full",
      "long_only": false
    }
  ]
}

GET `/symbols/{symbol}`

One instrument

Scope: market:read

Parameters

Name	In	Type	Description
`symbol` required	path	string

Responses

200 Instrument — Symbol
4xx/5xx Problem document with a stable code

Request

curl

curl "https://terminal.jafx.com/trading-api/v1/symbols/EURUSD" \
  -H "Authorization: Bearer $JAFX_API_KEY"

Response 200

JSON

{
  "symbol": "EURUSD",
  "description": "Euro vs US Dollar",
  "group": "Forex",
  "digits": 5,
  "contract_size": 100000,
  "tick_size": 0.00001,
  "volume_min": "0.01",
  "volume_max": "100",
  "volume_step": "0.01",
  "trade_mode": "full",
  "long_only": false
}

GET `/quotes`

Current quotes

Scope: market:read

Parameters

Name	In	Type	Description
`symbols`	query	string	Comma-separated, at most 50. All instruments when omitted.

Responses

200 Quotes
4xx/5xx Problem document with a stable code

Field	Type	Description
`data`	array of Quote
`missing`	array of string

Request

curl

curl "https://terminal.jafx.com/trading-api/v1/quotes?symbols=EURUSD,XAUUSD" \
  -H "Authorization: Bearer $JAFX_API_KEY"

Response 200

JSON

{
  "data": [
    {
      "symbol": "EURUSD",
      "bid": 1.11554,
      "ask": 1.11555,
      "time": "2026-10-13T09:30:01.242Z",
      "price_basis": "raw"
    },
    {
      "symbol": "XAUUSD",
      "bid": 4170.05,
      "ask": 4170.72,
      "time": "2026-10-13T09:30:01.834Z",
      "price_basis": "raw"
    }
  ],
  "missing": []
}

GET `/candles/{symbol}`

OHLC candles (the last one may still be forming)

Scope: market:read

Parameters

Name	In	Type	Description
`symbol` required	path	string
`timeframe`	query	string	One of `M1`, `M5`, `M15`, `M30`, `H1`, `H4`, `D1`, `W1`. Default `"M1"`.
`from`	query	string (date-time)
`to`	query	string (date-time)
`limit`	query	integer	Default `500`. Must be ≥ 1 and ≤ 2000.

Responses

200 Candles, oldest first
4xx/5xx Problem document with a stable code

Field	Type	Description
`symbol`	string
`timeframe`	string
`price_basis`	string	One of `raw`.
`data`	array of Candle

Request

curl

curl "https://terminal.jafx.com/trading-api/v1/candles/EURUSD?timeframe=M5&limit=3" \
  -H "Authorization: Bearer $JAFX_API_KEY"

Response 200

JSON

{
  "symbol": "EURUSD",
  "timeframe": "M5",
  "price_basis": "raw",
  "data": [
    {
      "time": "2026-10-13T09:20:00.000Z",
      "open": 1.11511,
      "high": 1.11528,
      "low": 1.11507,
      "close": 1.11524,
      "tick_volume": 412,
      "complete": true
    },
    {
      "time": "2026-10-13T09:25:00.000Z",
      "open": 1.11524,
      "high": 1.11561,
      "low": 1.11519,
      "close": 1.11549,
      "tick_volume": 388,
      "complete": true
    },
    {
      "time": "2026-10-13T09:30:00.000Z",
      "open": 1.11549,
      "high": 1.11558,
      "low": 1.11546,
      "close": 1.11554,
      "tick_volume": 41,
      "complete": false
    }
  ]
}

Account

The key's trading account — summary, positions, pending orders, history.

GET `/accounts`

The key's account (a list of one)

Scope: account:read

Responses

200 Accounts
4xx/5xx Problem document with a stable code

Field	Type	Description
`data`	array of Account

Request

curl

curl "https://terminal.jafx.com/trading-api/v1/accounts" \
  -H "Authorization: Bearer $JAFX_API_KEY"

Response 200

JSON

{
  "data": [
    {
      "account": 123456,
      "group": "demo-usd",
      "mode": "demo",
      "currency": "USD",
      "leverage": 100,
      "balance": "10000.00",
      "credit": "0.00",
      "equity": "10003.20",
      "margin": "223.11",
      "free_margin": "9780.09",
      "floating_profit": "3.20",
      "margin_level": 4483.53,
      "as_of": "2026-10-13T09:30:02.114Z"
    }
  ]
}

GET `/accounts/{account}`

Account summary

Scope: account:read

Parameters

Name	In	Type	Description
`account` required	path	integer

Responses

200 Account — Account
4xx/5xx Problem document with a stable code

Request

curl

curl "https://terminal.jafx.com/trading-api/v1/accounts/123456" \
  -H "Authorization: Bearer $JAFX_API_KEY"

Response 200

JSON

{
  "account": 123456,
  "group": "demo-usd",
  "mode": "demo",
  "currency": "USD",
  "leverage": 100,
  "balance": "10000.00",
  "credit": "0.00",
  "equity": "10003.20",
  "margin": "223.11",
  "free_margin": "9780.09",
  "floating_profit": "3.20",
  "margin_level": 4483.53,
  "as_of": "2026-10-13T09:30:02.114Z"
}

GET `/accounts/{account}/positions`

Open positions

Scope: account:read

Parameters

Name	In	Type	Description
`account` required	path	integer
`client_tag`	query	string	Pattern `^[A-Za-z0-9._:-]{1,32}$`.

Responses

200 Positions
4xx/5xx Problem document with a stable code

Field	Type	Description
`data`	array of Position

Request

curl

curl "https://terminal.jafx.com/trading-api/v1/accounts/123456/positions?client_tag=breakout-v2" \
  -H "Authorization: Bearer $JAFX_API_KEY"

Response 200

JSON

{
  "data": [
    {
      "ticket": 5001,
      "symbol": "EURUSD",
      "side": "buy",
      "volume": "0.02",
      "open_price": 1.11555,
      "open_time": "2026-10-13T09:29:47.512Z",
      "stop_loss": 1.11,
      "take_profit": null,
      "swap": "0.00",
      "commission": "0.00",
      "taxes": "0.00",
      "profit": "-0.02",
      "comment": "",
      "origin": "api",
      "client_tag": "breakout-v2",
      "from_ticket": null
    }
  ]
}

GET `/accounts/{account}/orders`

Pending orders

Scope: account:read

Parameters

Name	In	Type	Description
`account` required	path	integer
`client_tag`	query	string	Pattern `^[A-Za-z0-9._:-]{1,32}$`.

Responses

200 Pending orders
4xx/5xx Problem document with a stable code

Field	Type	Description
`data`	array of PendingOrder

Request

curl

curl "https://terminal.jafx.com/trading-api/v1/accounts/123456/orders" \
  -H "Authorization: Bearer $JAFX_API_KEY"

Response 200

JSON

{
  "data": [
    {
      "ticket": 5003,
      "symbol": "EURUSD",
      "type": "buy_limit",
      "volume": "0.10",
      "price": 1.108,
      "stop_loss": 1.104,
      "take_profit": 1.118,
      "expires_at": "2026-10-20T00:00:00.000Z",
      "placed_at": "2026-10-13T09:31:12.003Z",
      "comment": "",
      "origin": "api",
      "client_tag": "breakout-v2"
    }
  ]
}

GET `/accounts/{account}/trades`

Trades closed in a window (by close time), newest first

Scope: account:read

Parameters

Name	In	Type	Description
`account` required	path	integer
`from`	query	string (date-time)	Default: 7 days before `to`.
`to`	query	string (date-time)	Default: now. The window may span 90 days.
`client_tag`	query	string	Pattern `^[A-Za-z0-9._:-]{1,32}$`.
`cursor`	query	string
`limit`	query	integer	Default `100`. Must be ≥ 1 and ≤ 1000.

Responses

200 Closed trades
4xx/5xx Problem document with a stable code

Field	Type	Description
`data`	array of ClosedTrade
`next_cursor`	string \| null
`from`	string (date-time)
`to`	string (date-time)

Request

curl

curl "https://terminal.jafx.com/trading-api/v1/accounts/123456/trades?from=2026-10-06T00:00:00Z&client_tag=breakout-v2" \
  -H "Authorization: Bearer $JAFX_API_KEY"

Response 200

JSON

{
  "data": [
    {
      "ticket": 5002,
      "symbol": "EURUSD",
      "side": "buy",
      "type": "market",
      "volume": "0.01",
      "open_price": 1.11555,
      "open_time": "2026-10-13T09:29:47.512Z",
      "close_price": 1.11602,
      "close_time": "2026-10-13T10:02:15.880Z",
      "stop_loss": 1.1105,
      "take_profit": null,
      "swap": "0.00",
      "commission": "0.00",
      "taxes": "0.00",
      "profit": "0.47",
      "state": "closed",
      "comment": "",
      "origin": "api",
      "client_tag": "breakout-v2"
    },
    {
      "ticket": 5001,
      "symbol": "EURUSD",
      "side": "buy",
      "type": "market",
      "volume": "0.01",
      "open_price": 1.11555,
      "open_time": "2026-10-13T09:29:47.512Z",
      "close_price": 1.11564,
      "close_time": "2026-10-13T09:33:40.101Z",
      "stop_loss": 1.1105,
      "take_profit": null,
      "swap": "0.00",
      "commission": "0.00",
      "taxes": "0.00",
      "profit": "0.09",
      "state": "closed_partial",
      "comment": "",
      "origin": "api",
      "client_tag": "breakout-v2"
    }
  ],
  "next_cursor": null,
  "from": "2026-10-06T00:00:00.000Z",
  "to": "2026-10-13T10:05:00.000Z"
}

GET `/accounts/{account}/transactions`

Balance and credit operations

Scope: account:read

Parameters

Name	In	Type	Description
`account` required	path	integer
`from`	query	string (date-time)
`to`	query	string (date-time)
`cursor`	query	string
`limit`	query	integer	Default `100`. Must be ≥ 1 and ≤ 1000.

Responses

200 Transactions
4xx/5xx Problem document with a stable code

Field	Type	Description
`data`	array of Transaction
`next_cursor`	string \| null

Request

curl

curl "https://terminal.jafx.com/trading-api/v1/accounts/123456/transactions" \
  -H "Authorization: Bearer $JAFX_API_KEY"

Response 200

JSON

{
  "data": [
    {
      "ticket": 4001,
      "type": "balance",
      "amount": "10000.00",
      "time": "2026-10-01T08:00:00.000Z",
      "comment": "Demo deposit"
    }
  ],
  "next_cursor": null
}

Trading

Orders, changes and closes. Every write needs an Idempotency-Key header.

PATCH `/accounts/{account}/positions/{ticket}`

Change stop loss / take profit (null removes one; an omitted one is kept)

Scope: trade or trade:proposeIdempotency-Key: required

Parameters

Name	In	Type	Description
`account` required	path	integer
`ticket` required	path	integer	Must be ≥ 1.
`wait`	query	number	Seconds to wait for a held broker decision before answering 202. Default `5`. Must be ≥ 0 and ≤ 10.

Request body

Field	Type	Description
`stop_loss`	number \| null	Must be > 0.
`take_profit`	number \| null	Must be > 0.

Responses

200 Order result — OrderResult
202 Order result — OrderResult
4xx/5xx Problem document with a stable code

Request

curl

curl -X PATCH "https://terminal.jafx.com/trading-api/v1/accounts/123456/positions/5001" \
  -H "Authorization: Bearer $JAFX_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"stop_loss":1.1105}'

Response 200

JSON

{
  "request_id": "01JQ8ZC4M7Q2X9T5RN3VW8KH1A",
  "kind": "modify_position",
  "status": "placed",
  "ticket": 5001,
  "broker_status": "dc-answered",
  "failure": null,
  "client_tag": null,
  "position": {
    "ticket": 5001,
    "symbol": "EURUSD",
    "side": "buy",
    "volume": "0.02",
    "open_price": 1.11555,
    "open_time": "2026-10-13T09:29:47.512Z",
    "stop_loss": 1.1105,
    "take_profit": null,
    "swap": "0.00",
    "commission": "0.00",
    "taxes": "0.00",
    "profit": "0.18",
    "comment": "",
    "origin": "api",
    "client_tag": "breakout-v2",
    "from_ticket": null
  }
}

POST `/accounts/{account}/positions/{ticket}/close`

Close a position, wholly or partly

Scope: trade or trade:proposeIdempotency-Key: required

Parameters

Name	In	Type	Description
`account` required	path	integer
`ticket` required	path	integer	Must be ≥ 1.
`wait`	query	number	Seconds to wait for a held broker decision before answering 202. Default `5`. Must be ≥ 0 and ≤ 10.

Request body (optional)

Field	Type	Description
`volume`	decimal string

Responses

200 Order result — OrderResult
202 Order result — OrderResult
4xx/5xx Problem document with a stable code

Request

curl

curl -X POST "https://terminal.jafx.com/trading-api/v1/accounts/123456/positions/5001/close" \
  -H "Authorization: Bearer $JAFX_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"volume":"0.01"}'

Response 200

JSON

{
  "request_id": "01JQ8ZD9R2K6W4T8NB1XQ5VH3M",
  "kind": "close",
  "status": "filled",
  "ticket": 5002,
  "broker_status": "dc-answered",
  "failure": null,
  "client_tag": null,
  "position": {
    "ticket": 5002,
    "symbol": "EURUSD",
    "side": "buy",
    "volume": "0.01",
    "open_price": 1.11555,
    "open_time": "2026-10-13T09:29:47.512Z",
    "stop_loss": 1.1105,
    "take_profit": null,
    "swap": "0.00",
    "commission": "0.00",
    "taxes": "0.00",
    "profit": "0.09",
    "comment": "",
    "origin": "api",
    "client_tag": "breakout-v2",
    "from_ticket": 5001
  }
}

POST `/accounts/{account}/orders`

Place a market or pending order

201 executed or placed · 202 pending (broker still deciding), awaiting_confirmation (confirm-mode key) or outcome_unknown (poll the request; never resend under a new key) · 4xx problem.

Scope: trade or trade:proposeIdempotency-Key: required

Parameters

Name	In	Type	Description
`account` required	path	integer
`wait`	query	number	Seconds to wait for a held broker decision before answering 202. Default `5`. Must be ≥ 0 and ≤ 10.

Request body

Field	Type	Description
`symbol` required	string
`side` required	string	One of `buy`, `sell`.
`type`	string	One of `market`, `limit`, `stop`. Default `"market"`.
`volume` required	decimal string
`price`	number	Required for limit and stop. Must be > 0.
`stop_loss`	number	Must be > 0.
`take_profit`	number	Must be > 0.
`expires_at`	string (date-time)	Limit and stop only.
`comment`	string	Up to 200 characters.
`client_tag`	string	Stored with the trade (e.g. an MT magic number as "magic:42"). Pattern `^[A-Za-z0-9._:-]{1,32}$`.

Responses

201 Order result — OrderResult
202 Order result — OrderResult
422 Error — Problem
4xx/5xx Problem document with a stable code

Request

curl

curl -X POST "https://terminal.jafx.com/trading-api/v1/accounts/123456/orders" \
  -H "Authorization: Bearer $JAFX_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"symbol":"EURUSD","side":"buy","type":"market","volume":"0.02","stop_loss":1.11,"client_tag":"breakout-v2"}'

Response 201

JSON

{
  "request_id": "01JQ8Z6M3S4X7T2N9CKV5W0HRB",
  "kind": "market",
  "status": "filled",
  "ticket": 5001,
  "broker_status": "dc-answered",
  "failure": null,
  "client_tag": "breakout-v2",
  "position": {
    "ticket": 5001,
    "symbol": "EURUSD",
    "side": "buy",
    "volume": "0.02",
    "open_price": 1.11555,
    "open_time": "2026-10-13T09:29:47.512Z",
    "stop_loss": 1.11,
    "take_profit": null,
    "swap": "0.00",
    "commission": "0.00",
    "taxes": "0.00",
    "profit": "-0.02",
    "comment": "",
    "origin": "api",
    "client_tag": "breakout-v2",
    "from_ticket": null
  }
}

PATCH `/accounts/{account}/orders/{ticket}`

Change a pending order (omitted fields are kept; null removes a stop or the expiry)

Scope: trade or trade:proposeIdempotency-Key: required

Parameters

Name	In	Type	Description
`account` required	path	integer
`ticket` required	path	integer	Must be ≥ 1.
`wait`	query	number	Seconds to wait for a held broker decision before answering 202. Default `5`. Must be ≥ 0 and ≤ 10.

Request body

Field	Type	Description
`price`	number	Must be > 0.
`stop_loss`	number \| null	Must be > 0.
`take_profit`	number \| null	Must be > 0.
`expires_at`	string (date-time) \| null

Responses

200 Order result — OrderResult
202 Order result — OrderResult
4xx/5xx Problem document with a stable code

Request

curl

curl -X PATCH "https://terminal.jafx.com/trading-api/v1/accounts/123456/orders/5001" \
  -H "Authorization: Bearer $JAFX_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"price":1.1075,"take_profit":null}'

Response 200

JSON

{
  "request_id": "01JQ8ZF2T6N8V1X4KR7QW3MB9C",
  "kind": "modify_order",
  "status": "placed",
  "ticket": 5003,
  "broker_status": "dc-answered",
  "failure": null,
  "client_tag": null,
  "order": {
    "ticket": 5003,
    "symbol": "EURUSD",
    "type": "buy_limit",
    "volume": "0.10",
    "price": 1.1075,
    "stop_loss": 1.104,
    "take_profit": null,
    "expires_at": "2026-10-20T00:00:00.000Z",
    "placed_at": "2026-10-13T09:31:12.003Z",
    "comment": "",
    "origin": "api",
    "client_tag": "breakout-v2"
  }
}

DELETE `/accounts/{account}/orders/{ticket}`

Cancel a pending order

Scope: trade or trade:proposeIdempotency-Key: required

Parameters

Name	In	Type	Description
`account` required	path	integer
`ticket` required	path	integer	Must be ≥ 1.
`wait`	query	number	Seconds to wait for a held broker decision before answering 202. Default `5`. Must be ≥ 0 and ≤ 10.

Responses

200 Order result — OrderResult
4xx/5xx Problem document with a stable code

Request

curl

curl -X DELETE "https://terminal.jafx.com/trading-api/v1/accounts/123456/orders/5001" \
  -H "Authorization: Bearer $JAFX_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)"

Response 200

JSON

{
  "request_id": "01JQ8ZG7W3R5M9T2XN6KQ1VB4D",
  "kind": "cancel",
  "status": "placed",
  "ticket": 5003,
  "broker_status": "dc-answered",
  "failure": null,
  "client_tag": null
}

GET `/accounts/{account}/requests/{request_id}`

Where an order request stands

Scope: account:read

Parameters

Name	In	Type	Description
`account` required	path	integer
`request_id` required	path	string

Responses

200 Request status — RequestStatus
4xx/5xx Problem document with a stable code

Request

curl

curl "https://terminal.jafx.com/trading-api/v1/accounts/123456/requests/01JQ8Z6M3S4X7T2N9CKV5W0HRB" \
  -H "Authorization: Bearer $JAFX_API_KEY"

Response 200

JSON

{
  "request_id": "01JQ8Z6M3S4X7T2N9CKV5W0HRB",
  "kind": "market",
  "status": "filled",
  "ticket": 5001,
  "failure": null,
  "client_tag": "breakout-v2",
  "created_at": "2026-10-13T09:29:47.301Z",
  "decided_at": "2026-10-13T09:29:47.512Z"
}

GET `/accounts/{account}/proposals`

Proposals created by this key (confirm mode)

Scope: trade or trade:propose

Parameters

Name	In	Type	Description
`account` required	path	integer

Responses

200 Proposals
4xx/5xx Problem document with a stable code

Request

curl

curl "https://terminal.jafx.com/trading-api/v1/accounts/123456/proposals" \
  -H "Authorization: Bearer $JAFX_API_KEY"

Response 200

JSON

{
  "data": [
    {
      "proposal_id": "01JQ8ZB0Y4D2PQ7RS1VW3XHN6E",
      "status": "pending",
      "summary": "BUY 0.01 EURUSD market",
      "created_at": "2026-10-13T09:40:00.000Z",
      "expires_at": "2026-10-13T09:50:00.000Z",
      "decided_at": null,
      "result": null
    }
  ]
}

Schemas

Objects returned and accepted by the endpoints above. Money and volume are decimal strings; prices are numbers.

Status

Field	Type	Description
`status`	string	One of `ok`, `degraded`.
`api_version`	string
`time`	string (date-time)
`market_data`	object
`broker`	object	How account data and trading reach the broker, per server. `state` is the worst of them.
`broker.state`	BrokerState
`broker.servers`	object
`broker.servers.live`	ServerStatus
`broker.servers.demo`	ServerStatus
`broker.note`	string	Orders go through each account's own session: an account's keys trade for 24 hours after its owner signs in to JAFX Terminal, or around the clock when the owner switches that on in Developers.
`live_trading_enabled`	boolean

ServerStatus

Field	Type	Description
`state`	BrokerState
`sign_in_needed_for`	array of string	What needs the account owner's sign-in in the last 24 hours on this server: always trading; account data too where nothing else serves it (`account_data`). Items: `trading`, `account_data`.

BrokerState

ready: up; each account's session opens when its keys are used. connected: up, with a standing connection. disabled: not available on that server right now (503 broker_unavailable).

string

Session

The account's trading session that its keys trade through. It lasts 24 hours from the owner's last sign-in to JAFX Terminal (or Renew on its Developers page), whether or not the terminal stays open. With around-the-clock trading on, JAFX signs it in again by itself before it ends, or at the next request after it ended.

Field	Type	Description
`active`	boolean
`renews_automatically`	boolean	The owner switched on Keep my bots trading around the clock in Developers: JAFX signs this session in again by itself, so the keys keep trading past expires_at.
`signed_in_at`	string (date-time) \| null
`expires_at`	string (date-time) \| null	Until when this sign-in lasts (present while active). With renews_automatically, the next one follows by itself.
`ended_at`	string (date-time) \| null
`ended_reason`	string \| null	`stopped`: the owner pressed Stop API trading. `expired`: 24 hours passed. `ended_by_broker`, `resume_refused`: the session ended at the broker (a sign-out of it, a password change). `no_active_key`: the account's last key went. `password_refused`: around-the-clock trading stopped because the trading account refused the saved password (for example after a password change); the owner switches it on again in Developers. One of `stopped`, `expired`, `ended_by_broker`, `resume_refused`, `no_active_key`, `not_master`, `unreadable`, `password_refused`, `null`.
`note`	string

Me

Field	Type	Description
`key_id`	string
`name`	string
`account`	integer
`server`	string	The server the account is on: Live Server or Demo Server. Account numbers are per server. One of `live`, `demo`.
`mode`	string	One of `demo`, `live`.
`profile`	string	One of `client`, `strategy`.
`scopes`	array of string	Items: `market:read`, `account:read`, `trade`, `trade:propose`.
`constraints`	Constraints
`expires_at`	string (date-time)
`trading`	object
`trading.mode`	string	One of `on`, `close_only`, `off`.
`trading.level`	string
`trading.reason`	string \| null
`session`	Session
`live_trading_enabled`	boolean

Constraints

Field	Type	Description
`demo_only`	boolean
`max_volume_per_order`	decimal string
`max_open_positions`	integer
`orders_per_minute`	integer
`modifications_per_minute`	integer
`daily_loss_limit`	null \| object
`symbols`	array of string \| null
`ip_allowlist`	array of string \| null	The key's IP lock: up to 20 IP addresses or CIDR ranges it may be used from (any other answers 403 ip_not_allowed); null when the owner left it open to any IP address.
`confirm_mode`	boolean
`mcp_enabled`	boolean

Symbol

Field	Type	Description
`symbol`	string
`description`	string
`group`	string
`digits`	integer
`contract_size`	number
`tick_size`	number
`volume_min`	decimal string
`volume_max`	decimal string
`volume_step`	decimal string
`trade_mode`	string	One of `full`, `disabled`.
`long_only`	boolean

Quote

Field	Type	Description
`symbol`	string
`bid`	number
`ask`	number
`time`	string (date-time)
`price_basis`	string	One of `raw`, `group`.

Candle

Field	Type	Description
`time`	string (date-time)	Bar open time.
`open`	number
`high`	number
`low`	number
`close`	number
`tick_volume`	integer
`complete`	boolean

Account

Field	Type	Description
`account`	integer
`group`	string
`mode`	string	One of `demo`, `live`.
`currency`	string
`leverage`	integer
`balance`	decimal string
`credit`	decimal string
`equity`	decimal string
`margin`	decimal string
`free_margin`	decimal string
`floating_profit`	decimal string
`margin_level`	number \| null
`as_of`	string (date-time)

Position

Field	Type	Description
`ticket`	integer
`symbol`	string
`side`	string	One of `buy`, `sell`.
`volume`	decimal string
`open_price`	number
`open_time`	string (date-time)
`stop_loss`	number \| null
`take_profit`	number \| null
`swap`	decimal string
`commission`	decimal string
`taxes`	decimal string
`profit`	decimal string
`comment`	string
`origin`	string	One of `api`, `web`, `mobile`, `dealer`, `expert`, `signal`, `client`, `other`.
`client_tag`	string \| null
`from_ticket`	integer \| null	Original ticket of a partial-close remainder.

PendingOrder

Field	Type	Description
`ticket`	integer
`symbol`	string
`type`	string	One of `buy_limit`, `sell_limit`, `buy_stop`, `sell_stop`.
`volume`	decimal string
`price`	number
`stop_loss`	number \| null
`take_profit`	number \| null
`expires_at`	string (date-time) \| null
`placed_at`	string (date-time)
`comment`	string
`origin`	string
`client_tag`	string \| null

ClosedTrade

Field	Type	Description
`ticket`	integer
`symbol`	string
`side`	string	One of `buy`, `sell`.
`volume`	decimal string
`open_price`	number
`open_time`	string (date-time)
`stop_loss`	number \| null
`take_profit`	number \| null
`swap`	decimal string
`commission`	decimal string
`taxes`	decimal string
`profit`	decimal string
`comment`	string
`origin`	string	One of `api`, `web`, `mobile`, `dealer`, `expert`, `signal`, `client`, `other`.
`client_tag`	string \| null
`from_ticket`	integer \| null	Original ticket of a partial-close remainder.
`type`	string	One of `market`, `buy_limit`, `sell_limit`, `buy_stop`, `sell_stop`.
`close_price`	number \| null
`close_time`	string (date-time)
`state`	string	One of `closed`, `closed_partial`, `closed_by`, `cancelled`, `expired`.

Transaction

Field	Type	Description
`ticket`	integer
`type`	string	One of `balance`, `credit`.
`amount`	decimal string
`time`	string (date-time)
`comment`	string

OrderRequest

Field	Type	Description
`symbol` required	string
`side` required	string	One of `buy`, `sell`.
`type`	string	One of `market`, `limit`, `stop`. Default `"market"`.
`volume` required	decimal string
`price`	number	Required for limit and stop. Must be > 0.
`stop_loss`	number	Must be > 0.
`take_profit`	number	Must be > 0.
`expires_at`	string (date-time)	Limit and stop only.
`comment`	string	Up to 200 characters.
`client_tag`	string	Stored with the trade (e.g. an MT magic number as "magic:42"). Pattern `^[A-Za-z0-9._:-]{1,32}$`.

OrderResult

Field	Type	Description
`request_id`	string
`kind`	string	One of `market`, `pending`, `modify_position`, `modify_order`, `cancel`, `close`.
`status`	string	One of `filled`, `placed`, `pending`, `rejected`, `outcome_unknown`, `awaiting_confirmation`.
`ticket`	integer \| null
`broker_status`	string \| null
`failure`	string \| null
`client_tag`	string \| null
`position`	Position
`order`	PendingOrder
`proposal_id`	string
`expires_at`	string (date-time)
`note`	string

RequestStatus

Field	Type	Description
`request_id`	string
`kind`	string
`status`	string	One of `received`, `sent`, `filled`, `placed`, `pending`, `rejected`, `outcome_unknown`, `refused`, `refused_by_broker`, `not_sent`, `proposed`.
`ticket`	integer \| null
`failure`	string \| null
`client_tag`	string \| null
`created_at`	string (date-time)
`decided_at`	string (date-time) \| null

Problem

Field	Type	Description
`type` required	string (uri)
`title` required	string
`status` required	integer
`code` required	string	Stable error code (see the developer guide's error table).
`detail`	string
`request_id`	string
`details`	any

REST API reference

#Status and key

#GET /status

Responses

#GET /me

Responses

#Market data

#GET /symbols

Responses

#GET /symbols/{symbol}

Parameters

Responses

#GET /quotes

Parameters

Responses

#GET /candles/{symbol}

Parameters

Responses

#Account

#GET /accounts

Responses

#GET /accounts/{account}

Parameters

Responses

#GET /accounts/{account}/positions

Parameters

Responses

#GET /accounts/{account}/orders

Parameters

Responses

#GET /accounts/{account}/trades

Parameters

Responses

#GET /accounts/{account}/transactions

Parameters

Responses

#Trading

#PATCH /accounts/{account}/positions/{ticket}

Parameters

Request body

Responses

#POST /accounts/{account}/positions/{ticket}/close

Parameters

Request body (optional)

Responses

#POST /accounts/{account}/orders

Parameters

Request body

Responses

#PATCH /accounts/{account}/orders/{ticket}

Parameters

Request body

Responses

#DELETE /accounts/{account}/orders/{ticket}

Parameters

Responses

#GET /accounts/{account}/requests/{request_id}

Parameters

Responses

#GET /accounts/{account}/proposals

Parameters

Responses

#Schemas

#Status

#ServerStatus

#BrokerState

#Session

#Me

#Constraints

#Symbol

#Quote

#Candle

#Account

#Position

#PendingOrder

#ClosedTrade

#Transaction

#OrderRequest

#OrderResult

#RequestStatus

Status and key

GET `/status`

GET `/me`

Market data

GET `/symbols`

GET `/symbols/{symbol}`

GET `/quotes`

GET `/candles/{symbol}`

Account

GET `/accounts`

GET `/accounts/{account}`

GET `/accounts/{account}/positions`

GET `/accounts/{account}/orders`

GET `/accounts/{account}/trades`

GET `/accounts/{account}/transactions`

Trading

PATCH `/accounts/{account}/positions/{ticket}`

POST `/accounts/{account}/positions/{ticket}/close`

POST `/accounts/{account}/orders`

PATCH `/accounts/{account}/orders/{ticket}`

DELETE `/accounts/{account}/orders/{ticket}`

GET `/accounts/{account}/requests/{request_id}`

GET `/accounts/{account}/proposals`

Schemas

Status

ServerStatus

BrokerState

Session

Me

Constraints

Symbol

Quote

Candle

Account

Position

PendingOrder

ClosedTrade

Transaction

OrderRequest

OrderResult

RequestStatus

Problem