REST Trading API Reference

Account

GET

Returns a list of accounts belonging to the logged-in client.

GET	1	Returns account preferences.
PUT	1	Updates account preferences.

/history/activity

GET	3	Returns the account activity history.
GET	2	Returns the account activity history.

/history/activity/{fromDate}/{toDate}

GET

Returns the account activity history for the given date range.

/history/activity/{lastPeriod}

GET

Returns the account activity history for the last specified period.

/history/transactions

GET

Returns the transaction history. By default returns the minute prices within the last 10 minutes.

/history/transactions/{transactionType}/{fromDate}/{toDate}

GET

Returns the transaction history for the specified transaction type and given date range.

/history/transactions/{transactionType}/{lastPeriod}

GET

Returns the transaction history for the specified transaction type and period.

Dealing

/confirms/{dealReference}

GET

Returns a deal confirmation for the given deal reference.

/positions

GET	2	Returns all open positions for the active account.
GET	1	Returns all open positions for the active account.

/positions/{dealId}

GET	2	Returns an open position for the active account by deal identifier.
GET	1	Returns an open position for the active account by deal identifier.

/positions/otc

DELETE	1	Closes one or more OTC positions
POST	2	Creates an OTC position.
POST	1	Creates an OTC position.

/positions/otc/{dealId}

PUT	2	Updates an OTC position.
PUT	1	Updates an OTC position.

/positions/sprintmarkets

GET	2	Returns all open sprint market positions for the active account.
GET	1	Returns all open sprint market positions for the active account.
POST	1	Creates a sprint market position.

/workingorders

GET	2	Returns all open working orders for the active account.
GET	1	Returns all open working orders for the active account.

/workingorders/otc

POST	2	Creates an OTC working order.
POST	1	Creates an OTC working order.

/workingorders/otc/{dealId}

DELETE	2	Deletes an OTC working order.
DELETE	1	Deletes an OTC working order.
PUT	2	Updates an OTC working order.
PUT	1	Updates an OTC working order.

Markets

/marketnavigation

GET

Returns all top-level nodes (market categories) in the market navigation hierarchy.

/marketnavigation/{nodeId}

GET

Returns all sub-nodes of the given node in the market navigation hierarchy.

/markets

GET	2	Returns the details of the given markets.
GET	1	Returns the details of the given markets.

/markets/{epic}

GET	3	Returns the details of the given market.
GET	2	Returns the details of the given market.
GET	1	Returns the details of the given market

/markets?searchTerm={searchTerm}

GET

Returns all markets matching the search term.

/prices/{epic}

GET

Returns historical prices for a particular instrument. By default returns the minute prices within the last 10 minutes.

/prices/{epic}/{resolution}/{numPoints}

GET	2	Returns a list of historical prices for the given epic, resolution and number of data points
GET	1	Returns a list of historical prices for the given epic, resolution and number of data points

/prices/{epic}/{resolution}/{startDate}/{endDate}

GET

Returns a list of historical prices for the given epic, resolution and date range.

/prices/{epic}/{resolution}?startdate={startdate}&enddate={enddate}

GET

Returns a list of historical prices for the given epic, resolution and date range.

Watchlists

/watchlists

GET	1	Returns all watchlists belonging to the active account.
POST	1	Creates a watchlist.

/watchlists/{watchlistId}

DELETE	1	Deletes a watchlist.
GET	1	Returns a watchlist.
PUT	1	Add a market to a watchlist.

/watchlists/{watchlistId}/{epic}

DELETE

Remove a market from a watchlist.

Client Sentiment

/clientsentiment

GET

Returns the client sentiment for the given instrument's market

/clientsentiment/{marketId}

GET

Returns the client sentiment for the given instrument's market

/clientsentiment/related/{marketId}

GET

Returns a list of related (what others have traded) client sentiment for the given instrument's market

Login

/session

DELETE	1	Log out of the current session
GET	1	Returns the user's session details and optionally tokens.
POST	3	Creates a trading session, obtaining session tokens for subsequent API access. Please note that region-specific login restrictions may apply.
POST	2	Creates a trading session, obtaining session tokens for subsequent API access. Please note that region-specific login restrictions may apply.
POST	1	Creates a trading session, obtaining session tokens for subsequent API access. Please note that region-specific login restrictions may apply.
PUT	1	Switches active accounts, optionally setting the default account

/session/encryptionKey

GET

Creates a trading session, obtaining session tokens for subsequent API access

/session/refresh-token

POST

Refreshes a trading session, obtaining new session tokens for subsequent API access.

General

/operations/application

GET	1	Returns a list of client-owned applications
PUT	1	Alters the details of a given user application

/operations/application/disable

PUT

Disables the current application key from processing further requests. Disabled keys may be reenabled via the My Account section on our web dealing platform.

Visitor, you are here