Skip to content

Investabit/investabit-python-sdk

master
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

swagger-client

The CryptoWeather API allows for access to all of the cryptocurrency data and market forecast services provided. There are two primary categories of routes, public and private, where public routes are accessible to the general public and do not require API authentication, and private routes, which require API authentication. ## General Overview 1. All API methods adhere to RESTful best practices as closely as possible. As such, all API calls will be made via the standard HTTP protocol using the GET/POST/PUT/DELETE request types. 2. Every request returns the status as a JSON response with the following: - success, true if it was successful - code, the http status code (also in the response header) - 200 if response is successful - 400 if bad request - 401 if authorization JWT is wrong or limit exceeded - 404 wrong route - 500 for any internal errors - status, the status of the request, default success - errors, an array of any relevant error details 3. For any requests that are not successful an error message is specified and returned as an array for the errors key in the JSON response. 4. All authentication uses JSON Web Tokens (JWT), which is set as the Authorization entry in the header, see the following for more details. - http://jwt.io - https://scotch.io/tutorials/the-anatomy-of-a-json-web-token ## Code Example The following is a code example in Python, which demonstrates using the Python Requests library for both the public and private API routes. import requests HOST = \"https://api.cryptoweather.ai/v1\" # Your API key (JWT) API_KEY = \"<YOUR API KEY>\" # Example public request, no API key required. requests.get(\"{}/public/symbols\".format(HOST)).json() # Get the current btc price using the public route requests.get(\"{}/public/price-current/{}\".format(HOST, \"btc\")).json() # Example private request, API key required. Get the btc hourly forecasts headers = {\"Authorization\": \"Bearer {}\".format(API_KEY)} requests.get(\"{}/private/forecast/{}/{}\".format(HOST, \"btc\", \"1h\"), headers=headers).json()

This Python package is automatically generated by the Swagger Codegen project:

  • API version:
  • Package version: 1.0.0
  • Build package: io.swagger.codegen.languages.PythonClientCodegen

Requirements.

Python 2.7 and 3.4+

Installation & Usage

pip install

If the python package is hosted on Github, you can install directly from Github

pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)

Then import the package:

import swagger_client 

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import swagger_client

Getting Started

Please follow the installation procedure and then run the following:

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2
configuration = swagger_client.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.PrivateApi(swagger_client.ApiClient(configuration))
symbol = 'btc' # str | The cryptocurrency symbol.
interval = '1h' # str | The forecast interval, 1h or 1d.
period = '7d' # str | The period for computing the accuracy, such as the past 7 days.
cookie = 'csrf=b1820141-1bad-4a9c-93c0-52022817ce89' # str | e.g. csrf=b1820141-1bad-4a9c-93c0-52022817ce89 (optional)
x_csrf = 'b1820141-1bad-4a9c-93c0-52022817ce89' # str | e.g. b1820141-1bad-4a9c-93c0-52022817ce89 (optional)

try:
    # Accuracy
    api_response = api_instance.v1_private_accuracy_symbol_interval_period_get(symbol, interval, period, cookie=cookie, x_csrf=x_csrf)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PrivateApi->v1_private_accuracy_symbol_interval_period_get: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://api.cryptoweather.ai

Class Method HTTP request Description
PrivateApi v1_private_accuracy_symbol_interval_period_get GET /v1/private/accuracy/{symbol}/{interval}/{period} Accuracy
PrivateApi v1_private_forecast_accuracy_symbol_interval_period_get GET /v1/private/forecast-accuracy/{symbol}/{interval}/{period} Forecast Accuracy
PrivateApi v1_private_forecast_symbol_interval_get GET /v1/private/forecast/{symbol}/{interval} Forecast
PrivateApi v1_private_forecast_time_symbol_interval_period_get GET /v1/private/forecast-time/{symbol}/{interval}/{period} Forecast Time
PrivateApi v1_private_trend_symbol_get GET /v1/private/trend/{symbol} Trend
PrivateApi v1_private_trend_tabular_get GET /v1/private/trend-tabular Trend Tabular
PublicApi v1_public_price_change_symbol_get GET /v1/public/price-change/{symbol} Price Change
PublicApi v1_public_price_current_symbol_get GET /v1/public/price-current/{symbol} Price Current
PublicApi v1_public_price_history_symbol_period_interval_get GET /v1/public/price-history/{symbol}/{period}/{interval} Price History
PublicApi v1_public_summary_get GET /v1/public/summary Summary
PublicApi v1_public_symbols_get GET /v1/public/symbols Symbols
PublicApi v1_public_trend_symbol_get GET /v1/public/trend/{symbol} Trend

Documentation For Models

Documentation For Authorization

oauth2

  • Type: OAuth
  • Flow: accessCode
  • Authorization URL:
  • Scopes: N/A

Author

About

Investabit Python SDK.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published