AllyInvest.py
A blackbox Ally Invest/TradeKing API interface for application developers.
Public Member Functions | Public Attributes | List of all members
URLs.URLs Class Reference

Public Member Functions

def __init__ (self, response_format="json")
 
def base_url (self)
 
def accounts_url (self)
 
def accounts_balances_url (self)
 
def account_url (self)
 
def account_balances_url (self)
 
def account_history_url (self)
 
def account_holdings_url (self)
 
def clock_url (self)
 
def quote_url (self)
 
def news_search_url (self)
 
def news_article_url (self)
 
def toplists_url (self)
 
def member_profile_url (self)
 
def status_url (self)
 
def version_url (self)
 
def get_watchlists_url (self)
 
def post_watchlist_url (self)
 

Public Attributes

 format
 
 base_url
 
 accounts
 
 accounts_balances
 
 account
 
 account_balances
 
 account_history
 
 account_holdings
 
 clock
 
 quote
 
 news_search
 
 news_article
 
 toplists
 
 member_profile
 
 status
 
 version
 
 watchlists
 

Detailed Description

The URLs class will handle all of the URLs. The purpose of this class is
    to essentially store and serve all of the URL strings useful to the
    Ally Invest API.

    There is no processing of the URLs or the URL parameters done in this class
    all of that logic is handled in the AllyAPI class.

Constructor & Destructor Documentation

◆ __init__()

def URLs.URLs.__init__ (   self,
  response_format = "json" 
)
The URLs class constructor which defines all of the URLs used by the API.

    When adding new API functionality the URL needs to be added here.
    Examples abound of the format used by this implementation of the API.

    @param self - the object pointer
    @param response_format - format of the response. Valid values are 'xml' and 'json'.
Specifying 'xml' will return an ElementTree containing the response XML while
'json' will return the response in the JSON format.

Member Function Documentation

◆ account_balances_url()

def URLs.URLs.account_balances_url (   self)
Combines the request endpoint and account balances API URLs
    @param self - the object pointer

◆ account_history_url()

def URLs.URLs.account_history_url (   self)
Combines the request endpoint and account history API URLs
    @param self - the object pointer

◆ account_holdings_url()

def URLs.URLs.account_holdings_url (   self)
Combines the request endpoint and account holding API URLs
    @param self - the object pointer

◆ account_url()

def URLs.URLs.account_url (   self)
Combines the request endpoint and account API URLs
    @param self - the object pointer

◆ accounts_balances_url()

def URLs.URLs.accounts_balances_url (   self)
Combines the request endpoint and accounts balances API URLs
    @param self - the object pointer

◆ accounts_url()

def URLs.URLs.accounts_url (   self)
Combines the request endpoint and accounts API URLs
    @param self - the object pointer

◆ base_url()

def URLs.URLs.base_url (   self)
Returns the API request endpoint.
    @param self - the object pointer

◆ clock_url()

def URLs.URLs.clock_url (   self)
Combines the request endpoint and market clock API URLs
    @param self - the object pointer

◆ get_watchlists_url()

def URLs.URLs.get_watchlists_url (   self)
Combines the request endpoint and watchlist get URLs. Note this is the
same URL as the POST call (URLs.post_watchlist_url()).

◆ member_profile_url()

def URLs.URLs.member_profile_url (   self)
Combines the request endpoint and member profile API URLs
    @param self - the object pointer

◆ news_article_url()

def URLs.URLs.news_article_url (   self)
Combines the request endpoint and news article API URLs
    @param self - the object pointer

◆ news_search_url()

def URLs.URLs.news_search_url (   self)
Combines the request endpoint and news search API URLs
    @param self - the object pointer

◆ post_watchlist_url()

def URLs.URLs.post_watchlist_url (   self)
Combines the request endpoint and watchlist post URLs

◆ quote_url()

def URLs.URLs.quote_url (   self)
Combines the request endpoint and quote API URLs
    @param self - the object pointer

◆ status_url()

def URLs.URLs.status_url (   self)
Combines the request endpoint and server status API URLs
    @param self - the object pointer

◆ toplists_url()

def URLs.URLs.toplists_url (   self)
Combines the request endpoint and toplists API URLs
    @param self - the object pointer

◆ version_url()

def URLs.URLs.version_url (   self)
Combines the request endpoint and API version API URLs
    @param self - the object pointer

The documentation for this class was generated from the following file: