Module: Tradier::API::Accounts

Includes:

Utils

Included in:

Client

Defined in:

lib/tradier/api/accounts.rb

Instance Method Summary

• #balances(account_number = nil, options = {}) ⇒ Object (also: #balance)
• #events(account_number = nil, options = {}) ⇒ Object (also: #history)
• #gainloss(account_number = nil, options = {}) ⇒ Object
• #orders(account_number = nil, options = {}) ⇒ Object
• #positions(account_number = nil, options = {}) ⇒ Object (also: #position)
• #profile ⇒ Tradier::Profile (also: #user_profile)

  The user's profile.

Instance Method Details

#balances ⇒ Array<Tradier::Balance> #balances(account_number) ⇒ Tradier::Balance Also known as: balance

Overloads:

• #balances ⇒ Array<Tradier::Balance>

  Request a user's balances.

  Returns:

  • (Array<Tradier::Balance>) —

    An array of balances.

• #balances(account_number) ⇒ Tradier::Balance

  Request an individual account's balance.

  Parameters:

  • account_number (String) —

    An account number.

  Returns:

  • (Tradier::Balance) —

    The account balance object when a single account is requested.

Raises:

• (Tradier::Error::Unauthorized) —

  Error raised when supplied user credentials are not valid.

See Also:

• https://developer.tradier.com/documentation/user/get-balances
• https://developer.tradier.com/documentation/accounts/get-account-balance

Rate Limited?:

• Yes

Authentication:

• Requires user context

# File 'lib/tradier/api/accounts.rb', line 30

def balances(account_number=nil, options={})
  if account_number
    object_from_response(Tradier::Balance, :get, "/accounts/#{account_number}/balances", options)
  else
    object_from_response(Tradier::API::Utils::Balance, :get, "/user/balances", options).body
  end
end

#events ⇒ Array<Tradier::Account> #events(account_number) ⇒ Array<Tradier::Event> #events(account_number, options) ⇒ Object Also known as: history

Overloads:

• #events ⇒ Array<Tradier::Account>

  Request a user's events.

  Returns:

  • (Array<Tradier::Account>) —

    An array of accounts with history.

• #events(account_number) ⇒ Array<Tradier::Event>

  Request a specific account's events.

  Parameters:

  • account_number (String) —

    An account number (optional).

  Returns:

  • (Array<Tradier::Event>) —

    An array of [Tradier::Event] objects for a given account.

• #events(account_number, options) ⇒ Object

  Options Hash (options):

  • :limit (Integer) —

    Indicate the number of events to return for pagination.

  • ;offset (Integer) —

    Indicate the offset of results to return for pagination.

Raises:

• (Tradier::Error::Unauthorized) —

  Error raised when supplied user credentials are not valid.

See Also:

• https://developer.tradier.com/documentation/user/get-history
• https://developer.tradier.com/documentation/accounts/get-account-history

Rate Limited?:

• Yes

Authentication:

• Requires user context

# File 'lib/tradier/api/accounts.rb', line 115

def events(account_number=nil, options={})
  if account_number
    object_from_response(Tradier::API::Utils::Event, :get, "/accounts/#{account_number}/history", options).body
  else
    object_from_response(Tradier::API::Utils::Account, :get, '/user/history', options).body
  end
end

#gainloss ⇒ Array<Tradier::Account> #gainloss(account_number) ⇒ Array<Tradier::Position>

Overloads:

• #gainloss ⇒ Array<Tradier::Account>

  Request a user's cost basis.

  Returns:

  • (Array<Tradier::Account>) —

    An array of accounts with cost-basis.

• #gainloss(account_number) ⇒ Array<Tradier::Position>

  Request a specific account's cost basis.

  Parameters:

  • account_number (String) —

    An account number (optional).

  Returns:

  • (Array<Tradier::Position>) —

    An array of [Tradier::Position] objects for a given account.

Raises:

• (Tradier::Error::Unauthorized) —

  Error raised when supplied user credentials are not valid.

See Also:

• https://developer.tradier.com/documentation/user/get-gainloss
• https://developer.tradier.com/documentation/accounts/get-account-gainloss

Rate Limited?:

• Yes

Authentication:

• Requires user context

# File 'lib/tradier/api/accounts.rb', line 92

def gainloss(account_number=nil, options={})
  if account_number
    object_from_response(Tradier::API::Utils::Gainloss, :get, "/accounts/#{account_number}/gainloss", options).body
  else
    object_from_response(Tradier::API::Utils::Account, :get, '/user/gainloss', options).body
  end
end

#orders ⇒ Array<Tradier::Account> #orders(account_number) ⇒ Array<Tradier::Order>

Overloads:

• #orders ⇒ Array<Tradier::Account>

  Request a user's orders.

  Returns:

  • (Array<Tradier::Account>) —

    An array of accounts with orders.

• #orders(account_number) ⇒ Array<Tradier::Order>

  Request a specific account's orders.

  Parameters:

  • account_number (String) —

    An account number (optional).

  Returns:

  • (Array<Tradier::Order>) —

    An array of [Tradier::Order] objects for a given account.

Raises:

• (Tradier::Error::Unauthorized) —

  Error raised when supplied user credentials are not valid.

See Also:

• https://developer.tradier.com/documentation/user/get-orders
• https://developer.tradier.com/documentation/accounts/get-account-orders

Rate Limited?:

• Yes

Authentication:

• Requires user context

# File 'lib/tradier/api/accounts.rb', line 72

def orders(account_number=nil, options={})
  if account_number
    object_from_response(Tradier::API::Utils::Order, :get, "/accounts/#{account_number}/orders", options).body
  else
    object_from_response(Tradier::API::Utils::Account, :get, '/user/orders', options).body
  end
end

#positions ⇒ Array<Tradier::Account> #positions(account_number) ⇒ Array<Tradier::Position> Also known as: position

Overloads:

• #positions ⇒ Array<Tradier::Account>

  Request a user's positions.

  Returns:

  • (Array<Tradier::Account>) —

    An array of accounts with positions.

• #positions(account_number) ⇒ Array<Tradier::Position>

  Request an individual account's positions.

  Parameters:

  • account_number (String) —

    An account number.

  Returns:

  • (Array<Tradier::Position>) —

    An array of [Tradier::Position] objects for a given account.

Raises:

• (Tradier::Error::Unauthorized) —

  Error raised when supplied user credentials are not valid.

See Also:

• https://developer.tradier.com/documentation/user/get-positions
• https://developer.tradier.com/documentation/accounts/get-account-positions

Rate Limited?:

• Yes

Authentication:

• Requires user context

# File 'lib/tradier/api/accounts.rb', line 51

def positions(account_number=nil, options={})
  if account_number
    object_from_response(Tradier::API::Utils::Position, :get, "/accounts/#{account_number}/positions", options).body
  else
    object_from_response(Tradier::API::Utils::Account, :get, '/user/positions', options).body
  end
end

#profile ⇒ Tradier::Profile Also known as: user_profile

Returns The user's profile.

Returns:

• (Tradier::Profile) —

  The user's profile.

Raises:

• (Tradier::Error::Unauthorized) —

  Error raised when supplied user credentials are not valid.

See Also:

• https://developer.tradier.com/documentation/user/get-profile

Rate Limited?:

• Yes

Authentication:

• Requires user context

# File 'lib/tradier/api/accounts.rb', line 13

def profile
  object_from_response(Tradier::Profile, :get, '/user/profile', {})
end