Skip to content

waytrade/ib-api-service

Repository files navigation

Interactive Brokers REST/Websock Server (ib-api-service)

GitHub package.json version Language grade: JavaScript Test and Publish Test Report Core Coverage

A REST/Websocket API Server (with OpenAPI & SwaggerUI) on top of @stoqey/ib IBApiNext.


We use this app as part of our microservice ecosystem and it is OSS so you don't need to write it again. No questions will be answered, no support will be given, no feature-request will be accepted. Use it - or fork it and roll your own :)


How to use

Running the server:

Building a client:

The ib-api-service interface is completely described via OpenAPI. It provides a SwaggerUI at '/' and a openapi.json on /openapi.json or from Packages:

yarn add @waytrade/ib-api-service

After getting the openapi.json, use your favorite openapi-generator to generate code binding for your client application.
Example: to create bindings for Typescript language, using axios framework, run:

openapi-generator-cli generate -i ./node_modules/@waytrade/ib-api-service/openapi.json -g typescript-axios -o ./src/apis/ib-api-service