/confirms/{dealReference}

GET (version: 1)

Returns a deal confirmation for the given deal reference.
Request
Parameter Type Name Description
Path dealReference (String) deal reference
Response
Deal confirmation
affectedDeals (Array[Object])
Affected deal
dealId (String) Deal identifier
status (Constant)
AMENDED Amended
DELETED Deleted
FULLY_CLOSED Fully closed
OPENED Opened
PARTIALLY_CLOSED Partially closed
date (String) Transaction date
dealId (String) Deal identifier
dealReference (String) Deal reference
dealStatus (Constant)
Deal status
ACCEPTED Accepted
REJECTED Rejected
direction (Constant)
Deal direction
BUY Buy
SELL Sell
epic (String) Instrument epic identifier
expiry (String) Instrument expiry
guaranteedStop (Boolean) True if guaranteed stop
level (Number) Level
limitDistance (Number) Limit distance
limitLevel (Number) Limit level
profit (Number) Profit
profitCurrency (String) Profit currency
reason (Constant)
Describes the error (or success) condition for the specified trading operation
ACCOUNT_NOT_ENABLED_TO_TRADING The account is not enabled to trade
ATTACHED_ORDER_LEVEL_ERROR The level of the attached stop or limit is not valid
ATTACHED_ORDER_TRAILING_STOP_ERROR The trailing stop value is invalid
CANNOT_CHANGE_STOP_TYPE Cannot change the stop type.
CANNOT_REMOVE_STOP Cannot remove the stop.
CLOSING_ONLY_TRADES_ACCEPTED_ON_THIS_MARKET We are not taking opening deals on a Controlled Risk basis on this market
CONFLICTING_ORDER Resubmitted request does not match the original order.
CONTACT_SUPPORT_INSTRUMENT_ERROR Instrument has an error - check the order's currency is the instrument's currency (see the market's details); otherwise please contact support.
CR_SPACING Sorry we are unable to process this order. The stop or limit level you have requested is not a valid trading level in the underlying market.
DUPLICATE_ORDER_ERROR The order has been rejected as it is a duplicate of a previously issued order
EXCHANGE_MANUAL_OVERRIDE Exchange check failed. Please call in for assistance.
EXPIRY_LESS_THAN_SPRINT_MARKET_MIN_EXPIRY Order expiry is less than the sprint market's minimum expiry. Check the sprint market's market details for the allowable expiries.
FINANCE_REPEAT_DEALING The total size of deals placed on this market in a short period has exceeded our limits. Please wait before attempting to open further positions on this market.
FORCE_OPEN_ON_SAME_MARKET_DIFFERENT_CURRENCY Ability to force open in different currencies on same market not allowed
GENERAL_ERROR an error has occurred but no detailed information is available. Check transaction history or contact support for further information
GOOD_TILL_DATE_IN_THE_PAST The working order has been set to expire on a past date
INSTRUMENT_NOT_FOUND The requested market was not found
INSUFFICIENT_FUNDS The account has not enough funds available for the requested trade
LEVEL_TOLERANCE_ERROR The market level has moved and has been rejected
LIMIT_ORDER_WRONG_SIDE_OF_MARKET The deal has been rejected because the limit level is inconsistent with current market price given the direction.
MANUAL_ORDER_TIMEOUT The manual order timeout limit has been reached
MARGIN_ERROR Order declined during margin checks Check available funds.
MARKET_CLOSED The market is currently closed
MARKET_CLOSED_WITH_EDITS The market is currently closed with edits
MARKET_CLOSING The epic is due to expire shortly, client should deal in the next available contract.
MARKET_NOT_BORROWABLE The market does not allow opening shorting positions
MARKET_OFFLINE The market is currently offline
MARKET_ORDERS_NOT_ALLOWED_ON_INSTRUMENT The epic does not support 'Market' order type
MARKET_PHONE_ONLY The market can only be traded over the phone
MARKET_ROLLED The market has been rolled to the next period
MARKET_UNAVAILABLE_TO_CLIENT The requested market is not allowed to this account
MAX_AUTO_SIZE_EXCEEDED The order size exceeds the instrument's maximum configured value for auto-hedging the exposure of a deal
MINIMUM_ORDER_SIZE_ERROR The order size is too small
MOVE_AWAY_ONLY_LIMIT The limit level you have requested is closer to the market level than the existing stop. When the market is closed you can only move the limit order further away from the current market level.
MOVE_AWAY_ONLY_STOP The stop level you have requested is closer to the market level than the existing stop level. When the market is closed you can only move the stop level further away from the current market level
MOVE_AWAY_ONLY_TRIGGER_LEVEL The order level you have requested is moving closer to the market level than the exisiting order level. When the market is closed you can only move the order further away from the current market level.
OPPOSING_DIRECTION_ORDERS_NOT_ALLOWED Opening CR position in opposite direction to existing CR position not allowed.
OPPOSING_POSITIONS_NOT_ALLOWED The deal has been rejected to avoid having long and short open positions on the same market or having long and short open positions and working orders on the same epic
ORDER_DECLINED Order declined; please contact Support
ORDER_LOCKED The order is locked and cannot be edited by the user
ORDER_NOT_FOUND The order has not been found
OVER_NORMAL_MARKET_SIZE The total position size at this stop level is greater than the size allowed on this market. Please reduce the size of the order.
PARTIALY_CLOSED_POSITION_NOT_DELETED Position cannot be deleted as it has been partially closed.
POSITION_ALREADY_EXISTS_IN_OPPOSITE_DIRECTION The deal has been rejected because of an existing position. Either set the 'force open' to be true or cancel opposing position
POSITION_NOT_AVAILABLE_TO_CANCEL Position cannot be cancelled. Check transaction history or contact support for further information.
POSITION_NOT_AVAILABLE_TO_CLOSE Cannot close this position. Either the position no longer exists, or the size available to close is less than the size specified.
POSITION_NOT_FOUND The position has not been found
REJECT_CFD_ORDER_ON_SPREADBET_ACCOUNT Invalid attempt to submit a CFD trade on a spreadbet account
REJECT_SPREADBET_ORDER_ON_CFD_ACCOUNT Invalid attempt to submit a spreadbet trade on a CFD account
SIZE_INCREMENT Order size is not an increment of the value specified for the market.
SPRINT_MARKET_EXPIRY_AFTER_MARKET_CLOSE The expiry of the position would have fallen after the closing time of the market
STOP_OR_LIMIT_NOT_ALLOWED The market does not allow stop or limit attached orders
STOP_REQUIRED_ERROR The order requires a stop
STRIKE_LEVEL_TOLERANCE The submitted strike level is invalid
SUCCESS The operation completed successfully
TRAILING_STOP_NOT_ALLOWED The market or the account do not allow for trailing stops
UNKNOWN The operation resulted in an unknown result condition. Check transaction history or contact support for further information
WRONG_SIDE_OF_MARKET The requested operation has been attempted on the wrong direction
size (Number) Size
status (Constant)
Position status
AMENDED Amended
CLOSED Closed
DELETED Deleted
OPEN Open
PARTIALLY_CLOSED Partially Closed
stopDistance (Number) Stop distance
stopLevel (Number) Stop level
trailingStop (Boolean) True if trailing stop
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.confirms.deal-not-found Deal confirmation not found
404
invalid.url
500
system.error