tickcatcher 1.1.7

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 or TickCatcher Direct Key.

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

• API version: 1.1.7
• Package version: 1.1.7
• 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://api.tickcatcher.com
# See configuration.py for a list of all supported configuration parameters.
configuration = tickcatcher.Configuration(
    host = "https://api.tickcatcher.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: directToken
configuration.api_key['directToken'] = os.environ["API_KEY"]

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

# 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://api.tickcatcher.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
IndicatorsApi	adx	POST /api/indicators/adx	Calculate Average Directional Index (ADX)
IndicatorsApi	atr	POST /api/indicators/atr	Calculate Average True Range (ATR)
IndicatorsApi	bbands	POST /api/indicators/bbands	Calculate Bollinger Bands
IndicatorsApi	cci	POST /api/indicators/cci	Calculate Commodity Channel Index (CCI)
IndicatorsApi	ema	POST /api/indicators/ema	Calculate Exponential Moving Average (EMA)
IndicatorsApi	heikenashi	POST /api/indicators/heikenashi	Calculate Heiken Ashi
IndicatorsApi	ichimoku	POST /api/indicators/ichimoku	Calculate Ichimoku Cloud
IndicatorsApi	keltner	POST /api/indicators/keltner	Calculate Keltner Channels
IndicatorsApi	macd	POST /api/indicators/macd	Calculate MACD
IndicatorsApi	pivot	POST /api/indicators/pivot	Calculate Pivot Points
IndicatorsApi	psar	POST /api/indicators/psar	Calculate Parabolic SAR
IndicatorsApi	rsi	POST /api/indicators/rsi	Calculate Relative Strength Index (RSI)
IndicatorsApi	sma	POST /api/indicators/sma	Calculate Simple Moving Average (SMA)
IndicatorsApi	stoch	POST /api/indicators/stoch	Calculate Stochastic Oscillator
IndicatorsApi	supertrend	POST /api/indicators/supertrend	Calculate SuperTrend
IndicatorsApi	volumema	POST /api/indicators/volumema	Calculate Volume MA
IndicatorsApi	vwap	POST /api/indicators/vwap	Calculate VWAP
IndicatorsApi	williamsr	POST /api/indicators/williamsr	Calculate Williams %R
IndicatorsApi	zigzag	POST /api/indicators/zigzag	Calculate ZigZag Indicator

Documentation For Models

• Adx200ResponseInner
• AdxRequest
• AtrRequest
• Bbands200ResponseInner
• BbandsRequest
• BbandsRequestParams
• CalendarEvent
• Candle
• CciRequest
• EmaRequest
• EmaRequestParams
• HeikenashiRequest
• Ichimoku200ResponseInner
• IchimokuRequest
• IchimokuRequestParams
• Info
• KeltnerRequest
• KeltnerRequestParams
• Macd200ResponseInner
• MacdRequest
• MacdRequestParams
• Metadata
• Pivot200ResponseInner
• PivotRequest
• PsarRequest
• PsarRequestParams
• RsiRequest
• SearchResult
• SmaRequest
• SmaRequestParams
• Stoch200ResponseInner
• StochRequest
• StochRequestParams
• Supertrend200ResponseInner
• SupertrendRequest
• SupertrendRequestParams
• VolumemaRequest
• VwapRequest
• WilliamsrRequest
• ZigzagRequest
• ZigzagRequestParams

Documentation For Authorization

Authentication schemes defined for the API:

rapidapiKey

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

directToken

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

Author

[e-mail]