sgmarkets-api-xsf-rollbox

Release 0.2.0

sgmarket api xsf ROLLBOX helper

Homepage PyPI

Keywords
sgmarkets, api, xsf, rollbox
License
MIT
Install
pip install sgmarkets-api-xsf-rollbox==0.2.0

Documentation

SG Markets XSF API - ROLLBOX - Futures RollBox V1

1- Introduction

This repo is meant to make it easy for clients (and employees) to SG XSF Futures Rollbox V1 API.

This repo contains:

2 - Install

From terminal:

# download and install package from pypi.org
pip install sgmarkets_api_xsf_rollbox

# launch notebook
jupyter notebook

Create a notebook or run the demo notebook and modify it to your own use case.

3 - User guide

Read the demo notebook.

The key steps are the following.

3.1 - Read the info

The package contains the corresponding API swagger url and contact info:

import sgmarkets_api_xsf_rollbox as ROLLBOX
# info about ROLLBOX
ROLLBOX.info()

3.2 - Define you credentials

See the user guide in the sgmarkets-api-auth repo

3.3 - Pick an endpoint

Select it from the list of those available in the package.

import sgmarkets_api_xsf_rollbox as ROLLBOX
# Examples
ep = ROLLBOX.endpoint.v1_underlyings
ep = ROLLBOX.endpoint.v1_relative_roll

3.4 - Create the associated request

Each end point comes with a Request object.

# For all endpoints
rq = ep.request()

And fill the object with the necessary data.
This part is specific to the endpoint selected.
See the demo notebook for examples.

Then explore your Request object to make sure it is properly set.

# For all endpoints
# display the structure of the object
rq.info()

3.5 - Call the API

You can call the API directly from the Request object.

# For all endpoints
# a is an Api object (see 3.2)
res = rq.call_api(a)

The returned object is a Response object associated to this endpoint.
You can explore it starting with

# For all endpoints
# display the structure of the object
res.info()

3.6 - Save and show the results

As .csv file.

# For all endpoints
# save to disk
res.save()

The Response objects are different for each endpoint.
See the demo notebook for examples.

3.7 - Build a Dashboard

As .html file.
The resulting html file can be viewed independently from the Jupyter notebook context.

# endpoint ROLLBOX.endpoint.v1_analysis
res.build_dashboard()

See the demo notebook for an example.

Stats

Dependencies
0
Dependent packages
0
Dependent repositories
0
Total releases
7
Latest release
First release
Stars
0
Forks
0
Contributors
0
SourceRank
7

Development practices

Source repo 2FA enabled
TEXT!
Package manager 2FA enabled
TEXT!
Is security responsive
TEXT!
Dependencies are managed
TEXT!
Issue-free release available
TEXT!
Succession plan available
TEXT!
Package manager 2FA enabled
TEXT!

The Tidelift Subscription provides access to a continuously curated stream of human-researched and maintainer-verified data on open source packages and their licenses, releases, vulnerabilities, and development practices.

Learn more →

Releases

0.2.0
0.1.2
0.1.1
0.1.0
0.0.3
0.0.2
0.0.1

Something wrong with this page? Make a suggestion

Export .ABOUT file for this package

Last synced: 2021-02-21 17:35:11 UTC

Login to resync this project