/positions/sprintmarkets

GET (version: 2)

Returns all open sprint market positions for the active account.
Response
A list of sprint market positions
sprintMarketPositions (Array[Object])
Sprint market position
createdDate (String) Date the position was opened
currency (String) Currency of the payout
[Constraint: Pattern(regexp="[A-Z]{3}")]
dealId (String) Deal identifier
description (String) Description
direction (Constant)
Deal direction
BUY Buy
SELL Sell
epic (String) Instrument epic identifier
expiryTime (String) Expiry time
instrumentName (String) Instrument name
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
payoutAmount (Number) Payout amount
size (Number) Size
strikeLevel (Number) Strike price
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.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.position.notfound The requested position was not found
404
invalid.url
500
error.positions.generic An unexpected error has been encountered on the server side, cannot proceed. Please contact the support
500
system.error

GET (version: 1)

Returns all open sprint market positions for the active account.
Response
A list of sprint market positions
sprintMarketPositions (Array[Object])
Sprint market position
createdDate (String) Local date the position was opened
currency (String) Currency of the payout
[Constraint: Pattern(regexp="[A-Z]{3}")]
dealId (String) Deal identifier
description (String) Description
direction (Constant)
Deal direction
BUY Buy
SELL Sell
epic (String) Instrument epic identifier
expiryTime (String) Local expiry time
instrumentName (String) Instrument name
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
payoutAmount (Number) Payout amount
size (Number) Size
strikeLevel (Number) Strike price
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.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.position.notfound The requested position was not found
404
invalid.url
500
error.positions.generic An unexpected error has been encountered on the server side, cannot proceed. Please contact the support
500
system.error

POST (version: 1)

Creates a sprint market position.
Request
Parameter Type Name Description
Body request (Object)
Create sprint market position request. A request will be executed as a market order based on the current trade odds and strike level. An indicative payout amount (payout = premium / odds) can be evaluated by obtaining the binary odds ratio from the market details endpoint prior to placing an order.
dealReference (String) A user-defined reference identifying the submission of the order
[Constraint: Pattern(regexp="[A-Za-z0-9_\\-]{1,30}")]
direction (Constant)
Deal direction
BUY Buy
SELL Sell
epic (String) Instrument epic identifier
[Constraint: NotNull]
[Constraint: Pattern(regexp="[A-Za-z0-9._]{6,30}")]
expiryPeriod (Constant)
Sprint market expiry period
FIVE_MINUTES 5 minutes
ONE_MINUTE 1 minute
SIXTY_MINUTES 60 minutes
TWENTY_MINUTES 20 minutes
TWO_MINUTES 2 minutes
size (Number) Deal size
[Constraint: NotNull][Constraint: Check precision is not more than 12 decimal places]
Response
Create position response
dealReference (String) Deal reference of the transaction
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.request.invalid.date-range Invalid date range
400
error.security.api-key-missing The api key was not provided
400
error.sprintmarket.create-position.expiry.outside-valid-range The expiry period of the sprint market request is outside the configured minimum and maximum values
400
error.sprintmarket.create-position.failure An unspecified error was encountered while creating a sprint market position
400
error.sprintmarket.create-position.market-closed The expiry time of the sprint market deal falls outside market trading hours
400
error.sprintmarket.create-position.order-size.invalid Invalid order size
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
invalid.url
500
system.error

Uncaught exception thrown in shutdown function.

PDOException: SQLSTATE[25006]: Read only sql transaction: 7 ERROR: cannot execute DELETE in a read-only transaction: DELETE FROM {semaphore} WHERE (value = :db_condition_placeholder_0) ; Array ( [:db_condition_placeholder_0] => 1005230586610b4f5052c109.38886768 ) in lock_release_all() (line 269 of /var/ig/webcontent/drupal/includes/lock.inc).