/history/activity

GET (version: 3)

Returns the account activity history.
Request
Parameter Type Name Description
Request (Optional) from (DateTime) Start date
Request (Optional) to (DateTime) End date (Default = current time. A date without time component refers to the end of that day.)
Request (Optional) (Default=false) detailed (boolean) Indicates whether to retrieve additional details about the activity
Request (Optional) dealId (String) Deal ID
Request (Optional) filter (String) FIQL filter (supported operators: ==|!=|,|;)
Request (Optional) (Default=50) pageSize (int) Page size (min: 10, max: 500)
Response
activities (Array[Object])
channel (Constant)
The channel which triggered the activity.
DEALER Dealer
MOBILE Mobile
PUBLIC_FIX_API Public FIX API
PUBLIC_WEB_API Public Web API
SYSTEM System
WEB Web
date (String) The date of the activity item
dealId (String) Deal identifier
description (String) Activity description
details (Object)
Activity details
actions (Array[Object])
Deal affected by an activity
actionType (Constant)
Action type
LIMIT_ORDER_AMENDED Limit order amended
LIMIT_ORDER_DELETED Limit order deleted
LIMIT_ORDER_FILLED Limit order filled
LIMIT_ORDER_OPENED Limit order opened
LIMIT_ORDER_ROLLED Limit order rolled
POSITION_CLOSED Position closed
POSITION_DELETED Position deleted
POSITION_OPENED Position opened
POSITION_PARTIALLY_CLOSED Position partially closed
POSITION_ROLLED Position rolled
STOP_LIMIT_AMENDED Stop or limit amended
STOP_ORDER_AMENDED Stop order amended
STOP_ORDER_DELETED Stop order deleted
STOP_ORDER_FILLED Stop order filled
STOP_ORDER_OPENED Stop order opened
STOP_ORDER_ROLLED Stop order rolled
UNKNOWN Unknown
WORKING_ORDER_DELETED Working order deleted
affectedDealId (String) Affected deal id
currency (String) Currency
dealReference (String) Deal reference
direction (Constant)
Deal direction
BUY Buy
SELL Sell
goodTillDate (String) Good till date
guaranteedStop (Boolean) Guaranteed stop
level (Number) Level
limitDistance (Number) Limit distance
limitLevel (Number) Limit level
marketName (String) Market name
size (Number) Size
stopDistance (Number) Stop distance
stopLevel (Number) Stop level
trailingStep (Number) Trailing step size
trailingStopDistance (Number) Trailing stop distance
epic (String) Instrument epic identifier
period (String) The period of the activity item, e.g. "DFB" or "02-SEP-11". This will be the expiry time/date for sprint markets, e.g. "2015-10-13T12:42:05"
status (Constant)
Action status
ACCEPTED Accepted
REJECTED Rejected
UNKNOWN Unknown
type (Constant)
Activity type
EDIT_STOP_AND_LIMIT Amend stop or limit activity
POSITION Position activity
SYSTEM System generated activity
WORKING_ORDER Working order activity
metadata (Object)
Paging metadata
paging (Object)
Paging metadata
next (String) Next page
size (Number) Page size
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.request.invalid.page-size Invalid page size
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

GET (version: 2)

Returns the account activity history.
Request
Parameter Type Name Description
Request (Optional) from (DateTime) Start date
Request (Optional) to (DateTime) End date (date without time refers to the end of that day)
Request (Optional) (Default=600) maxSpanSeconds (long) Limits the timespan in seconds through to current time (not applicable if a date range has been specified)
Request (Optional) (Default=20) pageSize (int) Page size (disable paging = 0)
Request (Optional) (Default=1) pageNumber (int) Page number
Response
activities (Array[Object])
actionStatus (String) The action status of the activity item. The value of the action status can be any one of these. "ACCEPT" - Manual accept or auto accept. "REJECT" - Manual reject or declined. "MANUAL" - Gone manual and in pending. Cannot determine if accepted or rejected. "NOT_SET" - Default value which should have been overwritten by more specific status. Possibly caused by an error in processing by order server.
activity (String) The high-level activity description, e.g. "Order"
activityHistoryId (String) Activity history identifier
channel (String) The channel the activity occurred on, e.g. "WEB" or "Mobile"
currency (String) The currency, e.g. a pound symbol.
date (String) The date of the activity item
dealId (String) Deal identifier
epic (String) Instrument epic identifier
level (String) The market level that the activity item occurred at, e.g. "5253.5"
limit (String) The limit level of the activity item if any, e.g. "5233.5" or "-"
marketName (String) The market name of the activity item, e.g. "FTSE 100" This will be much longer for a sprint market, e.g. "FTSE 100 to be below 6598.4 at 12:42:05 on 13/08/13"
period (String) The period of the activity item, e.g. "DFB" or "02-SEP-11". This will be the expiry time/date for sprint markets, e.g. "2015-10-13T12:42:05"
result (String) The description of the result of the activity, e.g. "Guaranteed Position opened: KYG46BAQ"
size (String) The size of the activity item, e.g. "+1" OR "-3.85". There will be no direction symbol if the activity is for a sprint market
stop (String) The stop level of the activity item, if any, e.g. "5233.5" or "-"
stopType (String) The type of stop if applicable to the activity item, either "G" for guaranteed stop, or "N" for non-guaranteed stop, or T(50) for a trailing stop of step size 50
metadata (Object)
Paging metadata
pageData (Object)
Paging metadata
pageNumber (Number) Page number
pageSize (Number) Page size
totalPages (Number) Total number of pages
size (Number) Size
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.request.invalid.page-size Invalid page size
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