Skip to main content

Module responses

Module responses 

Source
Expand description

Response models from API calls

Structsยง

AccountActivityResponse
Account activity
AccountPreferencesResponse
Response containing account preferences
AccountsResponse
Response containing user accounts
ApplicationDetailsResponse
Response containing application details (a single application)
ApplicationInfo
Information about an API application
CategoriesResponse
Response containing all categories of instruments enabled for the IG account
CategoryInstrumentsResponse
Response containing instruments for a specific category
ClientSentimentResponse
Response containing client sentiment for multiple markets
ClosePositionResponse
Response to closing a position
CostBreakdown
Breakdown of a specific cost category
CostsAndCharges
Breakdown of costs and charges
CostsHistoryResponse
Response containing historical costs
CreateOrderResponse
Response to order creation
CreateWatchlistResponse
Response when creating a new watchlist
CreateWorkingOrderResponse
Response to working order creation
DBEntryResponse
Database entry response for market instruments
DurableMediumResponse
Response containing a durable medium document
HistoricalCost
Historical cost entry
HistoricalPricesResponse
Model for historical prices
IndicativeCostsResponse
Response containing indicative costs and charges
MarketNavigationResponse
Response model for market navigation
MarketSearchResponse
Model for market search results
MarketSentiment
Client sentiment data for a single market
MultipleMarketDetailsResponse
Response containing multiple market details
OrderConfirmationResponse
Details of a confirmed order
PositionsResponse
Open positions
SinglePositionResponse
Response containing a single position
StatusResponse
Generic status response for operations
TransactionHistoryResponse
Transaction history
UpdatePositionResponse
Response to updating a position
Watchlist
A watchlist containing instruments
WatchlistMarketsResponse
Response containing markets in a watchlist
WatchlistsResponse
Response containing all watchlists for the active account
WorkingOrdersResponse
Working orders