Tulip Exchange Client Library

This project is currently in alpha. The API should be considered unstable and likely to change.

The Tulip Exchange API is a gRPC API for interacting with the Tulip Exchange backend. Use it to place and cancel orders, monitor the orderbook, stream trades and any other interactions. The API is defined in a set of protobuf files that are used to generate language specific stubs. In addition to these stubs, the Tulip Exchange Client Library also contains some helper functions to aid authentication.

Documentation

• Getting started
• Public API Reference documentation
• Private API Reference documentation
• Tulip Exchange API Authentication
• FAQ

Usage with Bazel

• Install Bazel
• Install JDK 8 or higher (required for running the Java examples)
• Install Python 2 (required for running the Python examples)
• Run an example with bazel run examples/<lang>/<example>.

Your language not supported? Submit a feature request or compile the bindings for your language by yourself.

Include in another Bazel project

Include this project as an external dependency in your WORKSPACE

load("@bazel_tools//tools/build_defs/repo:git.bzl", "git_repository")

git_repository(
    name = "nl_tulipsolutions_tecl",
    commit = "<commit ID>",
    remote = "https://github.com/tulipsolutions/tecl.git",
)

Depend on the API parts that you need in your build files, for example:

java_library(
    name = "lib",
    srcs = glob(["*.java"]),
    deps = ["@nl_tulipsolutions_tecl//tulipsolutions/api/priv:order_jvm_grpc"],
)

Usage with other build tools

An alternative to using Bazel is to compile stubs in your language direct from the protobuf definitions. gRPC.io contains a list of officially supported languages. Visit our getting started from source page, select your preferred language and follow the tutorial.