tickcatcher 1.0.0

Tickcatcher API

tickcatcher

The Tickcatcher API provides access to cryptocurrency market data including candlesticks, symbols, and indicators. All requests require authentication using your RapidAPI key.

This Python package is automatically generated by the OpenAPI Generator project:

• API version: 1.0.0
• Package version: 1.0.0
• Generator version: 7.17.0
• Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python 3.9+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/yagiziskirik/tickcatcher-sdk.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/yagiziskirik/tickcatcher-sdk.git)

Then import the package:

import tickcatcher

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 tickcatcher

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import tickcatcher
from tickcatcher.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://tickcatcher.p.rapidapi.com
# See configuration.py for a list of all supported configuration parameters.
configuration = tickcatcher.Configuration(
    host = "https://tickcatcher.p.rapidapi.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: rapidapiKey
configuration.api_key['rapidapiKey'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['rapidapiKey'] = 'Bearer'


# Enter a context with an instance of the API client
with tickcatcher.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = tickcatcher.CalendarApi(api_client)
    start_date = 1762194992000 # int | Javascript style epoch time with milliseconds (i.e. 1762194992000). (optional)
    end_date = 1762194992000 # int | Javascript style epoch time with milliseconds (i.e. 1762194992000). (optional)

    try:
        # Get economic calendar within a selected period
        api_response = api_instance.calendar(start_date=start_date, end_date=end_date)
        print("The response of CalendarApi->calendar:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling CalendarApi->calendar: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://tickcatcher.p.rapidapi.com

Class	Method	HTTP request	Description
CalendarApi	calendar	GET /api/calendar	Get economic calendar within a selected period
CandlesApi	basic_candles	GET /api/bcandles	Get candlestick data
CandlesApi	enterprise_candles	GET /api/ecandles	Get candlestick data
CandlesApi	mega_candles	GET /api/mcandles	Get candlestick data
CandlesApi	pro_candles	GET /api/pcandles	Get candlestick data
CandlesApi	ultra_candles	GET /api/ucandles	Get candlestick data
GeneralApi	info	GET /api/info	Get your package information as well as your limitations
GeneralApi	metadata	GET /api/metadata	Get metadata of selected timeframe/symbol pair
GeneralApi	search	GET /api/search	Search through the list of symbols to use correct one in the query

Documentation For Models

• CalendarEvent
• Candle
• Info
• Metadata
• SearchResult

Documentation For Authorization

Authentication schemes defined for the API:

rapidapiKey

• Type: API key
• API key parameter name: X-RapidAPI-Key
• Location: HTTP header

Author