summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorDan Rostovtsev <dan@rostovtsev.org>2026-04-06 15:48:14 -0400
committerDan Rostovtsev <dan@rostovtsev.org>2026-04-06 15:48:14 -0400
commit0716a22d1fab76a18606ec031d33914ccbc56633 (patch)
treed63cc7ee4fd73bac935a776d09dc0ec78c8335e2 /README
parent2c6cf786c151118232533a6cfbc769ce1514aa9e (diff)
First working IBKR API implementation.HEADmain
* doc/ibkr.org: Docs for using the IBKR API. * manifest.scm: Guix Manifest of all project dependencies. * scripts/run-gateway.bash: A script for building and deploying the IBKR Client Gateway. * src/ibkr/api.scm: Support for specific endpoints, and generic tools for using the IBKR API. * src/ibkr/types.scm: Basic types for the IBKR endpoints. Orders, positions, securities, etc. * test/*.json: IBKR response and request examples for testing. * test/api.scm: Response handling and endpoint construction. * test/types.scm: Tests JSON parsing of IBKR requests and responses.
Diffstat (limited to 'README')
-rw-r--r--README9
1 files changed, 6 insertions, 3 deletions
diff --git a/README b/README
index 0a0ebd7..3babd0e 100644
--- a/README
+++ b/README
@@ -1,4 +1,7 @@
-Interactive Brokers Client Portal Gateway
-(ibkr-cpgw)
+Interactive Brokers API
+(ibkr)
+
+This module provides a REST-API service for trading with interactive
+brokers. It also provides a tool for configuring and installing the
+IBKR gateway.
-A tool for configuring and installing the IBKR gateway.