Skip to main content

TradingClient

Struct TradingClient 

Source
pub struct TradingClient {
    pub api_key: String,
    pub base_url: Url,
    /* private fields */
}
Expand description

The client for the Lemon API.

Fields§

§api_key: String

The API key.

§base_url: Url

The base url for the API

Implementations§

Source§

impl TradingClient

Source

pub fn get_order( &self, id: Option<String>, ) -> Result<GenericResponse<OrderResults>, Error>

Get orders

Source

pub fn post_order( &self, _body: OrderPlacing, ) -> Result<GenericResponse<OrderResults>, Error>

Post and create a new order.

Source

pub fn activate_order( &self, pin: i64, order_id: &str, ) -> Result<Response, Error>

Activate an order by id

Source

pub fn delete_order(&self, order_id: &str) -> Result<Response, Error>

Delete an order by id

Source§

impl TradingClient

Source

pub fn get_account_withdrawls( &self, _limit: Option<i32>, _page: Option<i32>, ) -> Result<Response, Error>

Get account withdrawls

Source

pub fn post_withdrawal( &self, withdrawal: WithdrawalRequest, ) -> Result<Response, Error>

Submit a new withdrawal TODO: Add docs for params

Source§

impl TradingClient

Source

pub fn get_account_information( &self, ) -> Result<AccountInformation<AccountResults>, Error>

Get account information

Source§

impl TradingClient

Source

pub fn get_positions_performance( &self, ) -> Result<PaginationResponse<PositionPerformance>, Error>

Get an overview of your position performances Using this endpoint, you can retrieve when positions were opened and closed, potential profits/losses, or related fees for position orders.

Source§

impl TradingClient

Source

pub fn get_statements( &self, limit: Option<i64>, page: Option<u32>, ) -> Result<PaginationResponse<Statement>, Error>

Get all change events happening to your positions.

Source§

impl TradingClient

Source

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

Get all positions

Source§

impl TradingClient

Source

pub fn new(api_key: String, _endpoint: &str) -> Self

Create a new TradingClient

Source

pub fn paper_client(api_key: &str) -> Self

Create a new client for paper trading with the given API key.

Source

pub fn live_client(api_key: String) -> Self

Create a new client for live trading with the given API key.

Trait Implementations§

Source§

impl Debug for TradingClient

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more