/working-orders/otc

POST (version: 2)

Creates an OTC working order.
Request
Parameter Type Name Description
Body request (Object)
Create working order request
[Constraint: If guaranteedStop equals true, then set only one of stopDistance]
[Constraint: If timeInForce equals GOOD_TILL_DATE, then set goodTillDate]
[Constraint: Set only one of {limitLevel,limitDistance}]
[Constraint: Set only one of {stopLevel,stopDistance}]
currencyCode (String) Currency. Restricted to available instrument currencies
[Constraint: NotNull]
[Constraint: Pattern(regexp="[A-Z]{3}")]
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
[Constraint: NotNull]
expiry (String) Expiry
[Constraint: NotNull]
[Constraint: Pattern(regexp="(\\d{2}-)?[A-Z]{3}-\\d{2}|-|DFB")]
forceOpen (Boolean) Force open
goodTillDate (String) Good till date - This accepts two possible formats either yyyy/mm/dd hh:mm:ss in UTC Time or Unix Timestamp in milliseconds
[Constraint: Pattern(regexp="(\\d{4}/\\d{2}/\\d{2} \\d{2}:\\d{2}:\\d{2}|\\d*)")]
guaranteedStop (Boolean) Guaranteed stop
[Constraint: NotNull]
level (Number) Deal level
[Constraint: NotNull]
limitDistance (Number) Limit distance
limitLevel (Number) Limit level
size (Number) Order size
[Constraint: NotNull][Constraint: Check precision is not more than 12 decimal places]
stopDistance (Number) Stop distance
stopLevel (Number) Stop level
timeInForce (Constant)
Time in force
GOOD_TILL_CANCELLED Good until cancelled
GOOD_TILL_DATE Good until specified date
type (Constant)
Working order type
LIMIT Limit working order
STOP Stop working order
Response
Create working order 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
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

POST (version: 1)

Creates an OTC working order.
Request
Parameter Type Name Description
Body request (Object)
Create working order request
[Constraint: If guaranteedStop equals true, then set only one of stopLevel,stopDistance]
[Constraint: If timeInForce equals GOOD_TILL_DATE, then set goodTillDate]
[Constraint: Set only one of {limitLevel,limitDistance}]
[Constraint: Set only one of {stopLevel,stopDistance}]
currencyCode (String) Currency. Restricted to available instrument currencies
[Constraint: NotNull]
[Constraint: Pattern(regexp="[A-Z]{3}")]
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
[Constraint: NotNull]
expiry (String) Expiry
[Constraint: NotNull]
[Constraint: Pattern(regexp="(\\d{2}-)?[A-Z]{3}-\\d{2}|-|DFB")]
goodTillDate (String) Good till date - format is yyyy/mm/dd hh:mm:ss in UTC Time
[Constraint: Pattern(regexp="(\\d{4}/\\d{2}/\\d{2} \\d{2}:\\d{2}:\\d{2}|\\d*)")]
guaranteedStop (Boolean) Guaranteed stop
[Constraint: NotNull]
level (Number) Deal level
[Constraint: NotNull]
limitDistance (Number) Limit distance
limitLevel (Number) Limit level
size (Number) Order size
[Constraint: NotNull][Constraint: Check precision is not more than 12 decimal places]
stopDistance (Number) Stop distance
stopLevel (Number) Stop level
timeInForce (Constant)
Time in force
GOOD_TILL_CANCELLED Good until cancelled
GOOD_TILL_DATE Good until specified date
type (Constant)
Working order type
LIMIT Limit working order
STOP Stop working order
Response
Create working order 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
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