spartaquant 1.0.6

SpartaQuant Python API

SpartaQuant

This API provides many services you can use as a SpartaQuant developer

SpartaQuant uses API token to allow access to the API outside the application in your favorite IDE

Installation

Install the package via pip with code below:

pip install spartaquant

To Upgrade:

pip install --upgrade spartaquant

Authentication

1. First, you must create an account at https://spartaquant.pro/login
2. Retrieve your API token in the profile section
3. Click on Copy access key (to clipboard the access key)
4. Import the spartaquant module

import spartaquant as sq
sq = sq.spartaquant()

5. Enter the access key in the prompt box
6. You are logged !

Examples

Some examples to start with the SpartaQuant API:

1. Retrieve the list of available SpartaQuant objects

import spartaquant as sq
sq = sq.spartaquant()
sq.getDataDB()

2. Retrieve the list of available SpartaQuant functions

import spartaquant as sq
sq = sq.spartaquant()
sq.getFunctionDB()

3. Get a specific object by apiId (find apiId with sq.getDataDB())

import spartaquant as sq
sq = sq.spartaquant()
sq.getData(apiId)

4. Run a SpartaQuant function by apiId (find apiId with sq.runFunction())

import spartaquant as sq
sq = sq.spartaquant()
sq.runFunction(apiId, *args)

5. Store data into SpartaQuant

import spartaquant as sq
sq = sq.spartaquant()
sq.putData(dataObj, name=None, apiId=None, dateDispo=None)

6. Retrieve the list of available XLS SpartaQuant files

import spartaquant as sq
sq = sq.spartaquant()
sq.getXlsDB()

7. Create an XLS file in SpartaQuant

import spartaquant as sq
sq = sq.spartaquant()
sq.createXls(nameFile, extension='xlsx')

8. Update and XLS file in SpartaQuant

import spartaquant as sq
sq = sq.spartaquant()
sq.putXlsData(xlsId, data_df, sheetName, cellStart='A1')

Check out the documentation of the API at https://spartaquant.pro/publicAPI for more information