Overview

API introduction

A JSON HTTP API for the book. Public reads need no auth.

Base URL: https://dapp.filobook.run. Requests and responses are JSON. All paths start with /v1.

Prices are decimal strings in USDG with up to 6 decimals and trailing zeros trimmed, for example "0.004" or "0.03". The maximum is 1,000,000 USDG. Send them as strings and compare them with a decimal library rather than floats. Timestamps are ISO 8601 UTC strings everywhere.

Public endpoints

EndpointReturns
GET /v1/bookOpen orders, newest first. Reference
GET /v1/orders/:idOne order with its quotes and fill. Reference
GET /v1/fillsRecent fills. Reference
GET /v1/fills/:idOne fill receipt. Reference
GET /v1/ledgerHash-chained ledger entries. Reference
GET /v1/ledger/verifyServer-side chain check. Reference
GET /v1/pricesPrice history from filled orders. Reference
GET /v1/providersRegistered providers. Reference

Authenticated endpoints

EndpointWho
POST /v1/ordersAny signed-in wallet. Reference
POST /v1/orders/:id/cancelOrder owner, while open. Reference
POST /v1/orders/:id/fillOrder owner. Reference
GET /v1/me/ordersYour orders. Reference
POST /v1/providersRegister as a provider. Reference
GET /v1/providers/meYour provider profile. Reference
PATCH /v1/providers/meUpdate your provider profile. Reference
POST /v1/orders/:id/quotesRegistered provider. Reference
GET /v1/me/quotesYour quotes. Reference
GET /v1/me/fillsFills where you were the agent or the provider. Reference

Pagination

List endpoints take an optional limit (default 50; maximum 200 for the book and /v1/me/*, 500 for fills, 1000 for the ledger). Results are newest first. The ledger also takes after=<height> to walk the chain oldest first. There are no other cursors in v1.

Stability

This is v1 of the API. Breaking changes will be announced in the changelog. See Authentication, Errors, Rate limits and Objects before you build.

Was this page helpful?