Sway Charts API Documentation
  • REST API Specification
    • Getting Started
      • Introduction
      • Errors
      • API Versioning
      • Conditional Requests & Updates
      • Entity Versioning
      • Data Types and Formats
      • Rate Limits & Throttling
    • Authentication & Authorization
      • HMAC Authentication
      • POST Create Session Token
      • POST Ping
      • POST Logout
    • Trading
      • POST Place Order
      • PUT Modify Order
      • DELETE Cancel Order
    • Reference Data
      • GET List Instruments
      • List Instrument Details
    • Users and Accounts
      • GET Get Users
      • GET List Account Portfolio
      • GET List Open Positions
      • GET List Open Orders
      • GET List Cash Transfers
      • GET POST List Orders
      • GET List Account Metrics
      • GET List Account Events
    • Market Data
      • POST Request Market Data
    • Conversion Rates
      • POST Get Conversion Rates
    • Cash Transaction
      • Single Order Request
      • Order Group Request
      • Order Response
      • Instrument
      • Instrument Details
      • Trading Session
      • Limit Value
      • Margin Rate
      • Margin Tier
      • User Details
      • Account Details
      • Account Portfolio
      • Balance
      • Position
      • Order
      • Order Leg
      • Execution
      • Cash Transfer
      • Historic Order List
      • Account Metrics
      • Position Metrics
      • Currency Metrics
      • Account Event
      • Market Data Request
      • Market Data Event Type
      • Market Data List
      • Quote
      • Candle
      • Conversion Rate
    • Revision History
Powered by GitBook
On this page
  1. REST API Specification
  2. Reference Data

GET List Instruments

GET https://api.swaycharts.io/dxsca-web/instruments/{symbol}
GET https://api.swaycharts.io/dxsca-web/instruments/type/{type}
GET https://api.swaycharts.io/dxsca-web/instruments/query

Retrieve general information about the instruments currently traded in the system

The API supports searching for instruments by the following criteria:

  • Symbol (with wildcard supported)

  • Type (FX, CFD etc.)

The API is accessible to any API user but the user may be prohibited permission to some instruments or types of instruments. The instruments not permitted for the user won't be returned and an attempt to look at details for such an instrument will result in an empty list of instruments.

By default, the instruments are sorted by their symbol, but this can be changed with the help of order-by-asc and order-by-desc query parameters.

// Request

Empty request

Authorization header should be included in case of basic authentication
// Path Parameters

symbol - is the unique instrument symbol in the system (e.g. EUR/USD). The value should be URL-encoded.
type - type of the instrument in the systems (e.g. CFD). The value should be URL-encoded
// Query Parameters

The following parameters are supported for all the resources:

limit (optional) - maximum number of instruments to be displayed on query results page. Maximum possible value is server-configured; if a larger value is specified, the maximum value is used.
start-from (optional) - indicates the starting index of instrument in a response to return. Default value is 0. To use paging set the limit and start-from parameters. Ex. for the limit=10&start-from=100 query the results page will contain instruments from 101st to 110th.
sort-by-asc and sort-by-desc (optional) - defines a sorting mode for the result. Only one of the two parameters is permitted. sort-by-asc specifies sorting in ascending direction, sort-by-desc specifies sorting in descending direction. Multiple comma-separated criteria are supported. Possible values are TYPE and SYMBOL.
The following query arguments are supported for the /instruments/query resource:

symbols - symbol (or its part, URL encoded) to filter instruments. If specified, only those instruments which symbol contains the value will be returned. If not specified, all available instruments will be returned. The * (asterisk) wildcard indicates any number of any characters.
types - filter for the types of instruments. If not specified, instruments with all accessible types are returned. Wildcards are not supported. Several types can be indicated in a comma-separated list.
Examples:

/query?symbols=EUR/USD – an instrument with the EUR/USD symbol
/query?symbols=EUR/* - all instruments with EUR as the first currency
/query?symbols=EUR/USD,AAPL,GOOG – three instruments with symbols of EUR/USD, AAPL, GOOG.
/query?types=FOREX – only Forex instruments
/query?types=INDEX,STOCK – instruments of INDEX and STOCK types
// Response

A list of instruments that match the request

The ETag header is not sent in response.
// Errors

Common errors

API is not permitted for the user

Status code: 404 Not Found
Error code: 2
Description: Entity not found at server
Request URI is malformed (cannot be matched with query criteria)

Status code: 400 Bad Request
Error code: 31
Description: Malformed query URI
Request URI is malformed (request parameters are incorrect; limit or start-from are negative)

Status code: 400 Bad Request
Error code: 32
Description: Incorrect request parameters (<request parameter that was incorrect>)
PreviousReference DataNextList Instrument Details

Last updated 1 year ago