Struct ig_brokers::api::IG

pub struct IG { /* fields omitted */ }

Implementations

impl IG

pub fn live(
    account_id: String,
    api_key: String,
    username: String,
    password: String
) -> IG

Creates a new API instance with the production configuration.

pub fn demo(
    account_id: String,
    api_key: String,
    username: String,
    password: String
) -> IG

Creates a new API instnace with the demo configuration.

pub fn new(
    account_id: String,
    api_key: String,
    username: String,
    password: String,
    config: Config
) -> IG

Creates a new API instance with a config.

pub fn get_accounts(&self) -> Result<Accounts, Error>

GET /accounts Returns a list of accounts belonging to the logged-in client.

pub fn get_preferences(&self) -> Result<Preferences, Error>

GET /accounts/preferences Returns account preferences.

pub fn update_preferences(
    &self,
    preferences: &Preferences
) -> Result<OkResponse, Error>

PUT /accounts/preferences Updates account preferences.

pub fn get_activity_history(
    &self,
    query: &ActivityHistoryQuery
) -> Result<ActivityHistory, Error>

GET /history/activity Returns the account activity history.

pub fn get_transaction_history(
    &self,
    query: &TransactionHistoryQuery
) -> Result<TransactionHistory, Error>

GET /history/transactions Returns the transaction history. By default returns the minute prices within the last 10 minutes.

pub fn get_client_sentiments(
    &self,
    query: &SentimentQuery
) -> Result<Sentiments, Error>

GET /clientsentiment Returns the client sentiment for the given instrument’s market.

pub fn get_client_sentiment(
    &self,
    market_id: &String
) -> Result<Sentiment, Error>

GET /clientsentiment/{marketId} Returns the client sentiment for the given instrument’s market.

pub fn get_related_client_sentiment(
    &self,
    market_id: &String
) -> Result<Sentiments, Error>

GET /clientsentiment/related/{marketId} Returns a list of related (what others have traded) client sentiment for the given instrument’s market.

pub fn get_deal_confirmation(
    &self,
    deal_reference: &String
) -> Result<DealConfirmation, Error>

GET /confirms/{dealReference} Returns a deal confirmation for the given deal reference.

pub fn get_positions(&self) -> Result<Positions, Error>

GET /positions Returns all open positions for the active account.

pub fn get_position(&self, deal_id: &String) -> Result<Position, Error>

GET /positions/{dealId} Returns an open position for the active account by deal identifier.

pub fn close_position(&self, req: &ClosePosition) -> Result<DealRef, Error>

DELETE /positions/otc Closes one or more OTC positions.

pub fn create_position(&self, req: &CreatePosition) -> Result<DealRef, Error>

POST /positions/otc Creates an OTC position.

pub fn update_position(
    &self,
    deal_id: &String,
    req: &UpdatePosition
) -> Result<DealRef, Error>

PUT /positions/otc/{dealId} Updates an OTC position.

pub fn get_sprint_market_positions(
    &self
) -> Result<SprintMarketPositions, Error>

GET /positions/sprintmarkets A list of sprint market positions.

pub fn create_sprint_market_position(
    &self,
    req: &CreateSprintMarketPosition
) -> Result<DealRef, Error>

POST /positions/sprintmarkets Creates a sprint market position.

pub fn get_working_orders(&self) -> Result<WorkingOrders, Error>

GET /workingorders Returns all open working orders for the active account.

pub fn create_working_order(
    &self,
    req: &CreateWorkingOrder
) -> Result<DealRef, Error>

POST /workingorders/otc Creates an OTC working order.

pub fn delete_working_order(&self, deal_id: &String) -> Result<DealRef, Error>

DELETE /workingorders/otc/{dealId} Deletes an OTC working order.

pub fn update_working_order(
    &self,
    deal_id: &String,
    req: &UpdateWorkingOrder
) -> Result<DealRef, Error>

PUT /workingorders/otc/{dealId} Updates an OTC working order.

pub fn get_applications(&self) -> Result<Vec<Application>, Error>

GET /operations/application Returns a list of client owned applications.

pub fn update_application(
    &self,
    req: &UpdateApplication
) -> Result<Application, Error>

PUT /operations/application Alters the details of a given user application.

pub fn get_session(&self) -> Result<Session, Error>

GET /session Returns the user’s session details and optionally tokens.

pub fn get_market_categories(&self) -> Result<MarketCategory, Error>

GET /marketnavigation Returns all top-level nodes (market categories) in the market navigation hierarchy.

pub fn get_market_category(
    &self,
    node_id: &String
) -> Result<MarketCategory, Error>

GET /marketnavigation/{nodeId} Returns all sub-nodes of the given node in the market navigation hierarchy.

pub fn get_markets(&self, query: &MarketsQuery) -> Result<Markets, Error>

GET /markets Returns the details of the given markets.

pub fn get_market(&self, epic: &String) -> Result<Market, Error>

GET /markets/{epic} Returns the details of the given market.

pub fn search_markets(
    &self,
    search_term: &String
) -> Result<MarketSearch, Error>

GET /markets?searchTerm={searchTerm} Returns all markets matching the search term.

pub fn get_prices(
    &self,
    epic: &String,
    query: &PricesQuery
) -> Result<Prices, Error>

GET /prices/{epic} Returns historical prices for a particular instrument. By default returns the minute prices within the last 10 minutes.

pub fn get_watchlists(&self) -> Result<Watchlists, Error>

GET /watchlists Returns all watchlists belonging to the active account

pub fn create_watchlist(
    &self,
    req: &CreateWatchlist
) -> Result<CreateWatchlistResult, Error>

POST /watchlists Creates a watchlist.

pub fn delete_watchlist(
    &self,
    watchlist_id: &String
) -> Result<OkResponse, Error>

DELETE /watchlists/{watchlistId} Deletes a watchlist.

pub fn get_watchlist(
    &self,
    watchlist_id: &String
) -> Result<MarketSearch, Error>

GET /watchlists/{watchlistId} Returns a watchlist.

pub fn add_market_to_watchlist(
    &self,
    watchlist_id: &String,
    req: &AddToWatchlist
) -> Result<OkResponse, Error>

PUT /watchlists/{watchlistId} Add a market to watchlist.

pub fn remove_market_from_watchlist(
    &self,
    watchlist_id: &String,
    epic: &String
) -> Result<OkResponse, Error>

DELETE /watchlists/{watchlistId}/{epic} Remove a market from a watchlist.