pyTOP’s API Document

Contents:

This part of the documentation covers all the interfaces of pyTOP. For parts where Requests depends on external libraries, we document the most important right here and provide links to the canonical documentation.

Basic API

All of pyTOP’s functionality can be accessed by these 3 methods. They all return an instance of the TOP object.

class pyTOP.api.TOP(API_KEY=None, APP_SECRET=None, ENVIRONMENT=None)

Basic API class. All the API models are inherited from this class

create(data, fields=[], models={})

Create model attributes

execute(request, session=None, method='post')

pyTOP.API – TOPRequest instance

class pyTOP.api.TOPRequest(method_name)

pyTOP Request Object

class pyTOP.api.TOPDate

pyTOP Date Object

create(date_str)

Convert string to datetime.datetime

Exceptions

exception pyTOP.errors.TOPException(code, msg=None)

There was an ambiguous exception that occurred while handling your TOP request.

Indices and tables