...

SDK Setup

Step-by-step installation instructions for all supported platforms.

We treat our SDKs as first-class citizens. They are automatically generated from our OpenAPI specification, ensuring 100% feature parity with the REST API.

Note

[!IMPORTANT] Open Source: Full source code and build instructions for all SDKs are available on our GitHub Repository.

Our Node.js SDK is fully typed and supports both CommonJS and ES Modules.

Prerequisites: Node.js v14 or higher.

# npm
npm install tickcatcher
 
# yarn
yarn add tickcatcher
 
# pnpm
pnpm add tickcatcher

Types are included directly in the package. You do not need to install @types/tickcatcher.


Our Python SDK fully supports type hinting and modern async/await patterns (via the async client).

Prerequisites: Python 3.7 or higher.

pip install tickcatcher

The Go client is designed for performance, using standard library net/http for maximum compatibility.

go get github.com/tickcatcher/tickcatcher-go

To update to the latest version later:

go get -u github.com/tickcatcher/tickcatcher-go

Targeting .NET Standard 2.0, compatible with .NET Core 2.0+, .NET Framework 4.6.1+, and Mono.

Using .NET CLI:

dotnet add package TickCatcher

Using Package Manager Console:

Install-Package TickCatcher

We publish to Maven Central. Compatible with Kotlin 1.4+ and Java 8+.

Gradle (Kotlin DSL):

implementation("com.tickcatcher:client:1.0.0")

Maven:

<dependency>
  <groupId>com.tickcatcher</groupId>
  <artifactId>client</artifactId>
  <version>1.0.0</version>
</dependency>

Compatible with Swift 5+ and supports iOS, macOS, tvOS, and watchOS.

Add the package dependency in Package.swift:

dependencies: [
    .package(url: "https://github.com/tickcatcher/tickcatcher-swift.git", from: "1.0.0")
]

Native Rust library with async support via Tokio.

cargo add tickcatcher

If you need to modify the SDKs or if a specific version is not yet available on your package manager, you can build them directly from the source.

  1. Clone the repository:
    git clone https://github.com/yagiziskirik/tickcatcher-sdk.git
    cd tickcatcher-sdk
  2. Navigate to your desired language directory (e.g., cd python).
  3. Follow the README.md instructions in that folder to build and link the package locally.
Note

[!NOTE] Some experimental SDKs (e.g., Rust, Swift) may not be auto-published to registries like Crates.io immediately. Using the GitHub source is the recommended way to get the absolute latest changes.