/markets

GET (version: 2)

Returns the details of the given markets.
Request
Parameter Type Name Description
Request (Mandatory) epics (String) The epics of the market to be retrieved, separated by a comma. Max number of epics is limited to 50.
[Constraint: Pattern(regexp="^(?>(?:[A-Za-z0-9._]){6,30},?){0,200}$")]
Request (Optional) (Default=ALL) filter (MarketDetailsFilterType) MarketDetailsFilterType
Filter for the market details
ALL Display all market details. Market details includes all instrument data, dealing rules and market snapshot values for all epics specified.
SNAPSHOT_ONLY Display the market snapshot and minimal instrument data fields. This mode is faster because it only sets the epic and instrument type in the instrument data and the market data snapshot values with all the other fields being unset for each epic specified.
Response
marketDetails (Array[Object])
dealingRules (Object)
Dealing rules
controlledRiskSpacing (Object)
Dealing rule
unit (Constant)
describes the dimension for a dealing rule value
PERCENTAGE
POINTS
value (Number) Value
marketOrderPreference (Constant)
Client's market order trading preference
AVAILABLE_DEFAULT_OFF Market orders are allowed for the account type and instrument, and the user has enabled market orders in their preferences but decided the default state is off.
AVAILABLE_DEFAULT_ON Market orders are allowed for the account type and instrument, and the user has enabled market orders in their preferences and has decided the default state is on.
NOT_AVAILABLE Market orders are not allowed for the current site and/or instrument
maxStopOrLimitDistance (Object)
Dealing rule
unit (Constant)
describes the dimension for a dealing rule value
PERCENTAGE
POINTS
value (Number) Value
minControlledRiskStopDistance (Object)
Dealing rule
unit (Constant)
describes the dimension for a dealing rule value
PERCENTAGE
POINTS
value (Number) Value
minDealSize (Object)
Dealing rule
unit (Constant)
describes the dimension for a dealing rule value
PERCENTAGE
POINTS
value (Number) Value
minNormalStopOrLimitDistance (Object)
Dealing rule
unit (Constant)
describes the dimension for a dealing rule value
PERCENTAGE
POINTS
value (Number) Value
minStepDistance (Object)
Dealing rule
unit (Constant)
describes the dimension for a dealing rule value
PERCENTAGE
POINTS
value (Number) Value
trailingStopsPreference (Constant)
Trailing stops trading preference for the specified market
AVAILABLE Trailing stops are allowed for the current market
NOT_AVAILABLE Trailing stops are not allowed for the current market
instrument (Object)
Instrument details
chartCode (String) Chart code
contractSize (String) Contract size
controlledRiskAllowed (Boolean) True if controlled risk trades are allowed
country (String) Country
currencies (Array[Object])
Currency
baseExchangeRate (Number) Base exchange rate
code (String) Code, to be used when placing orders
exchangeRate (Number) Exchange rate.
isDefault (Boolean) True if this is the default currency
symbol (String) Symbol, for display purposes
epic (String) Instrument identifier
expiry (String) Expiry
expiryDetails (Object)
Market expiry details
lastDealingDate (String) Last dealing date
settlementInfo (String) Settlement information
forceOpenAllowed (Boolean) True if force open is allowed
limitedRiskPremium (Object)
The limited risk premium.
unit (Constant)
describes the dimension for a dealing rule value
PERCENTAGE
POINTS
value (Number) Value
lotSize (Number) Lot size
marginDepositBands (Array[Object])
Deposit band
currency (String) the currency for this currency band factor calculation
margin (Number) Margin Percentage
max (Number) Band maximum
min (Number) Band minimum
marginFactor (Number) margin requirement factor
marginFactorUnit (Constant)
describes the dimension for a dealing rule value
PERCENTAGE
POINTS
marketId (String) Market identifier
name (String) Name
newsCode (String) Reuters news code
onePipMeans (String) Meaning of one pip
openingHours (Object)
Market open and close times
marketTimes (Array[Object])
Time range
closeTime (String) Close time
openTime (String) Open time
rolloverDetails (Object)
Market rollover details
lastRolloverTime (String) Last rollover date
rolloverInfo (String) Rollover info
slippageFactor (Object)
Slippage factor details for a given market
unit (String) Unit
value (Number) Value
specialInfo (Array[String]) List of special information notices
sprintMarketsMaximumExpiryTime (Number) For sprint markets only, the maximum value to be specified as the expiry of a sprint markets trade
sprintMarketsMinimumExpiryTime (Number) For sprint markets only, the minimum value to be specified as the expiry of a sprint markets trade
stopsLimitsAllowed (Boolean) True if stops and limits are allowed
streamingPricesAvailable (Boolean) True if streaming prices are available, i.e. the market is open and the client has appropriate permissions
type (Constant)
Instrument type
BINARY
BUNGEE_CAPPED
BUNGEE_COMMODITIES
BUNGEE_CURRENCIES
BUNGEE_INDICES
COMMODITIES
CURRENCIES
INDICES
KNOCKOUTS_COMMODITIES
KNOCKOUTS_CURRENCIES
KNOCKOUTS_INDICES
KNOCKOUTS_SHARES
OPT_COMMODITIES
OPT_CURRENCIES
OPT_INDICES
OPT_RATES
OPT_SHARES
RATES
SECTORS
SHARES
SPRINT_MARKET
TEST_MARKET
UNKNOWN
unit (Constant)
Unit used to qualify the size of a trade
AMOUNT
CONTRACTS
SHARES
valueOfOnePip (String) Value of one pip
snapshot (Object)
Market snapshot data
bid (Number) Bid price
binaryOdds (Number) Binary odds
controlledRiskExtraSpread (Number) the number of points to add on each side of the market as an additional spread when placing a guaranteed stop trade.
decimalPlacesFactor (Number) Number of decimal positions for market levels
delayTime (Number) Price delay
high (Number) Highest price on the day
low (Number) Lowest price on the day
marketStatus (Constant)
Describes the current status of a given market
CLOSED Closed
EDITS_ONLY Open for edits
OFFLINE Offline
ON_AUCTION In auction mode
ON_AUCTION_NO_EDITS In no-edits mode
SUSPENDED Suspended
TRADEABLE Open for trades
netChange (Number) Net price change on the day
offer (Number) Offer price
percentageChange (Number) Percentage price change on the day
scalingFactor (Number) Multiplying factor to determine actual pip value for the levels used by the instrument
updateTime (String) Time of last price update
Exceptions
HTTP code Description
400
error.public-api.failure.encryption.required A login has been attempted to the login V1 service by a client from the IG Singapore company. They need to use the v2 version as they need to send their passwords encrypyted.
400
error.public-api.too-many-epics the client is providing too many epics to the service. Reduce the number of epics provided.
400
error.request.invalid.date-range Invalid date range
400
error.security.api-key-missing The api key was not provided
400
invalid.input A generic input data error has occurred
401
error.public-api.failure.kyc.required The account is not allowed to log into public API. Please use the web platform.
401
error.public-api.failure.missing.credentials The user has not provided all required security credentials.
401
error.public-api.failure.pending.agreements.required The account is not allowed to log into public API. Please use the web platform.
401
error.public-api.failure.preferred.account.disabled The user's preferred account is disabled.
401
error.public-api.failure.preferred.account.not.set The user has not set a preferred account.
401
error.security.account-token-invalid The service requires an account token and the one provided was not valid
401
error.security.account-token-missing The service requires an account token and it was not provided
401
error.security.client-token-invalid The service requires a client token and the one provided was not valid
401
error.security.client-token-missing The service requires a client token and it was not provided
401
error.security.oauth-token-invalid Invalid OAuth access token
403
endpoint.unavailable.for.api-key The provided api key was not accepted
403
error.public-api.exceeded-account-allowance The account traffic allowance has been exceeded
403
error.public-api.exceeded-account-historical-data-allowance The account historical data traffic allowance has been exceeded
403
error.public-api.exceeded-account-trading-allowance The account trading traffic allowance has been exceeded
403
error.public-api.exceeded-api-key-allowance The api key traffic allowance has been exceeded
403
error.public-api.failure.stockbroking-not-supported Stockbroking not supported for Public API users.
403
error.security.api-key-disabled The provided api key was not accepted because it is not currently enabled
403
error.security.api-key-invalid The provided api key was not accepted
403
error.security.api-key-restricted The provided api key was not valid for the requesting account
403
error.security.api-key-revoked The provided api key was not accepted because it has been revoked
404
error.public-api.epic-not-found Epic not found
404
invalid.url
500
system.error

GET (version: 1)

Returns the details of the given markets.
Request
Parameter Type Name Description
Request (Mandatory) epics (String) The epics of the market to be retrieved, separated by a comma. Max number of epics is limited to 50.
[Constraint: Pattern(regexp="^(?>(?:[A-Za-z0-9._]){6,30},?){0,200}$")]
Response
marketDetails (Array[Object])
dealingRules (Object)
Dealing rules
controlledRiskSpacing (Object)
Dealing rule
unit (Constant)
describes the dimension for a dealing rule value
PERCENTAGE
POINTS
value (Number) Value
marketOrderPreference (Constant)
Client's market order trading preference
AVAILABLE_DEFAULT_OFF Market orders are allowed for the account type and instrument, and the user has enabled market orders in their preferences but decided the default state is off.
AVAILABLE_DEFAULT_ON Market orders are allowed for the account type and instrument, and the user has enabled market orders in their preferences and has decided the default state is on.
NOT_AVAILABLE Market orders are not allowed for the current site and/or instrument
maxStopOrLimitDistance (Object)
Dealing rule
unit (Constant)
describes the dimension for a dealing rule value
PERCENTAGE
POINTS
value (Number) Value
minControlledRiskStopDistance (Object)
Dealing rule
unit (Constant)
describes the dimension for a dealing rule value
PERCENTAGE
POINTS
value (Number) Value
minDealSize (Object)
Dealing rule
unit (Constant)
describes the dimension for a dealing rule value
PERCENTAGE
POINTS
value (Number) Value
minNormalStopOrLimitDistance (Object)
Dealing rule
unit (Constant)
describes the dimension for a dealing rule value
PERCENTAGE
POINTS
value (Number) Value
minStepDistance (Object)
Dealing rule
unit (Constant)
describes the dimension for a dealing rule value
PERCENTAGE
POINTS
value (Number) Value
trailingStopsPreference (Constant)
Trailing stops trading preference for the specified market
AVAILABLE Trailing stops are allowed for the current market
NOT_AVAILABLE Trailing stops are not allowed for the current market
instrument (Object)
Instrument details
chartCode (String) Chart code
contractSize (String) Contract size
controlledRiskAllowed (Boolean) True if controlled risk trades are allowed
country (String) Country
currencies (Array[Object])
Currency
baseExchangeRate (Number) Base exchange rate
code (String) Code, to be used when placing orders
exchangeRate (Number) Exchange rate.
isDefault (Boolean) True if this is the default currency
symbol (String) Symbol, for display purposes
epic (String) Instrument identifier
expiry (String) Expiry
expiryDetails (Object)
Market expiry details
lastDealingDate (String) Last dealing date
settlementInfo (String) Settlement information
forceOpenAllowed (Boolean) True if force open is allowed
limitedRiskPremium (Object)
The limited risk premium.
unit (Constant)
describes the dimension for a dealing rule value
PERCENTAGE
POINTS
value (Number) Value
lotSize (Number) Lot size
marginDepositBands (Array[Object])
Deposit band
currency (String) the currency for this currency band factor calculation
margin (Number) Margin Percentage
max (Number) Band maximum
min (Number) Band minimum
marginFactor (Number) margin requirement factor
marginFactorUnit (Constant)
describes the dimension for a dealing rule value
PERCENTAGE
POINTS
marketId (String) Market identifier
name (String) Name
newsCode (String) Reuters news code
onePipMeans (String) Meaning of one pip
openingHours (Object)
Market open and close times
marketTimes (Array[Object])
Time range
closeTime (String) Close time
openTime (String) Open time
rolloverDetails (Object)
Market rollover details
lastRolloverTime (String) Last rollover date
rolloverInfo (String) Rollover info
slippageFactor (Object)
Slippage factor details for a given market
unit (String) Unit
value (Number) Value
specialInfo (Array[String]) List of special information notices
sprintMarketsMaximumExpiryTime (Number) For sprint markets only, the maximum value to be specified as the expiry of a sprint markets trade
sprintMarketsMinimumExpiryTime (Number) For sprint markets only, the minimum value to be specified as the expiry of a sprint markets trade
stopsLimitsAllowed (Boolean) True if stops and limits are allowed
streamingPricesAvailable (Boolean) True if streaming prices are available, i.e. the market is open and the client has appropriate permissions
type (Constant)
Instrument type
BINARY
BUNGEE_CAPPED
BUNGEE_COMMODITIES
BUNGEE_CURRENCIES
BUNGEE_INDICES
COMMODITIES
CURRENCIES
INDICES
KNOCKOUTS_COMMODITIES
KNOCKOUTS_CURRENCIES
KNOCKOUTS_INDICES
KNOCKOUTS_SHARES
OPT_COMMODITIES
OPT_CURRENCIES
OPT_INDICES
OPT_RATES
OPT_SHARES
RATES
SECTORS
SHARES
SPRINT_MARKET
TEST_MARKET
UNKNOWN
unit (Constant)
Unit used to qualify the size of a trade
AMOUNT
CONTRACTS
SHARES
valueOfOnePip (String) Value of one pip
snapshot (Object)
Market snapshot data
bid (Number) Bid price
binaryOdds (Number) Binary odds
controlledRiskExtraSpread (Number) the number of points to add on each side of the market as an additional spread when placing a guaranteed stop trade.
decimalPlacesFactor (Number) Number of decimal positions for market levels
delayTime (Number) Price delay
high (Number) Highest price on the day
low (Number) Lowest price on the day
marketStatus (Constant)
Describes the current status of a given market
CLOSED Closed
EDITS_ONLY Open for edits
OFFLINE Offline
ON_AUCTION In auction mode
ON_AUCTION_NO_EDITS In no-edits mode
SUSPENDED Suspended
TRADEABLE Open for trades
netChange (Number) Net price change on the day
offer (Number) Offer price
percentageChange (Number) Percentage price change on the day
scalingFactor (Number) Multiplying factor to determine actual pip value for the levels used by the instrument
updateTime (String) Time of last price update
Exceptions
HTTP code Description
400
error.public-api.failure.encryption.required A login has been attempted to the login V1 service by a client from the IG Singapore company. They need to use the v2 version as they need to send their passwords encrypyted.
400
error.public-api.too-many-epics the client is providing too many epics to the service. Reduce the number of epics provided.
400
error.request.invalid.date-range Invalid date range
400
error.security.api-key-missing The api key was not provided
400
invalid.input A generic input data error has occurred
401
error.public-api.failure.kyc.required The account is not allowed to log into public API. Please use the web platform.
401
error.public-api.failure.missing.credentials The user has not provided all required security credentials.
401
error.public-api.failure.pending.agreements.required The account is not allowed to log into public API. Please use the web platform.
401
error.public-api.failure.preferred.account.disabled The user's preferred account is disabled.
401
error.public-api.failure.preferred.account.not.set The user has not set a preferred account.
401
error.security.account-token-invalid The service requires an account token and the one provided was not valid
401
error.security.account-token-missing The service requires an account token and it was not provided
401
error.security.client-token-invalid The service requires a client token and the one provided was not valid
401
error.security.client-token-missing The service requires a client token and it was not provided
401
error.security.oauth-token-invalid Invalid OAuth access token
403
endpoint.unavailable.for.api-key The provided api key was not accepted
403
error.public-api.exceeded-account-allowance The account traffic allowance has been exceeded
403
error.public-api.exceeded-account-historical-data-allowance The account historical data traffic allowance has been exceeded
403
error.public-api.exceeded-account-trading-allowance The account trading traffic allowance has been exceeded
403
error.public-api.exceeded-api-key-allowance The api key traffic allowance has been exceeded
403
error.public-api.failure.stockbroking-not-supported Stockbroking not supported for Public API users.
403
error.security.api-key-disabled The provided api key was not accepted because it is not currently enabled
403
error.security.api-key-invalid The provided api key was not accepted
403
error.security.api-key-restricted The provided api key was not valid for the requesting account
403
error.security.api-key-revoked The provided api key was not accepted because it has been revoked
404
error.public-api.epic-not-found Epic not found
404
invalid.url
500
system.error