Usage & Getting Started

Installation

To use jockmkt-sdk, first install it using pip:

$ pip install jockmkt-sdk

Getting started:

import the package and generate a Client object instance

class jockmkt_sdk.client.Client(secret, api_key, request_params=None, verbose=False)

The user should initialize an instance of this class: e.g. Client(secret, api_key) and then they should call whichever method they wish. The class will automatically obtain an auth token. Functionality included to auto update expired auth tokens or retreive new one if necessary.

Variables

• secret – The user’s secret key: xxx

• api_key – the user’s api key: jm_api_xxx

from jockmkt_sdk.client import Client

secret_key = "<secret_key: xxx>"
api_key = "<api_key: jm_api_xxx>"

# Initialize an instance of the client class:
client = Client(secret_key, api_key)

# Call any method and it will automatically retrieve your auth token.
client.get_events()

You are creating an instance of the Client class and generating an auth-token, which you will use for all future api calls.

Each call is a method within the Client class.

For example:

client.get_events()

client.get_entities()

client.get_orders()