Cordice for developers
Cordice speaks ordinary HTTP with JSON bodies, and a WebSocket for everything that happens in real time. There is nothing to sign up for beyond an account: a bot token and an address are enough to start.
Every instance publishes its own addresses, so read them from the discovery document rather than hard-coding them — that is what lets the same client talk to a self-hosted instance without a patch. Endpoints explains how.
Where to start
| If you want to | Read |
|---|---|
| Call the API from anything | Endpoints, then Authentication |
| Write a bot | Bots |
| Use the client library | Libraries |
| Receive events as they happen | Establishing a connection |
| Look up one endpoint | API reference |
| Work on Cordice itself | Contributing |
About the reference
The API reference is generated from the server's own schema rather than written by hand, so it cannot describe an endpoint that does not exist or miss one that does. The pages around it explain behaviour the schema cannot: what a rate limit means, what to do when a token expires, which order things have to happen in.