Skip to main content

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

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

yagiz@iskirik.com

Metadata

Release files for tickcatcher 1.1.7

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for tickcatcher 1.1.7
File Size Uploaded Provenance Actions
tickcatcher-1.1.7.tar.gz 47.0 kB Without provenance Details for tickcatcher-1.1.7.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for tickcatcher 1.1.7
File Interpreter ABI Platform Actions
tickcatcher-1.1.7-py3-none-any.whl Python 3 none any Details for tickcatcher-1.1.7-py3-none-any.whl

Total release size: 144.5 kB

Release files / tickcatcher-1.1.7.tar.gz

Download URL tickcatcher-1.1.7.tar.gz
Size 47.0 kB
Tags Source
SHA-256 checksum
How to use checksums
0f135481d8ac2628df7b1e3a2c84116257086514f38b02f7dbb5eb6b05a3fdb4
BLAKE2b-256 checksum
How to use checksums
08c19fd6c36ec2717b5d9455d58f623a7b0baa6ad8306da46fb2ec45150b67d6
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.14.2

Release files / tickcatcher-1.1.7-py3-none-any.whl

Download URL tickcatcher-1.1.7-py3-none-any.whl
Size 97.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
4dfe7cfb49bea9ec36dc9fbe47f38e04e7215a93763059aeac1975ff8cb6028b
BLAKE2b-256 checksum
How to use checksums
33b3dfd0465d3eee2011cfb64fce91d86eb3e4c6a4b6758e37bdf3250f7335c1
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.14.2

Security for tickcatcher 1.1.7

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page