For the complete documentation index, see llms.txt. This page is also available as Markdown.
🛠️HODLMM API Documentation
Legacy HODLMM v1 endpoints. For engine v2 (retail + MM), see HODLMM API Documentation (v2).
API Usage and Documents
The Bitflow HODLMM API is available on Kong at https://bff.bitflowapis.finance.
Public access (no API key):
Quotes: /api/quotes/* (v1) and /api/quotes/v2/* (engine)
App / BFF: /api/app/* (v1) and /api/app/v2/* (engine)
Default limit: 100 requests per second per IP
OpenAPI:
https://bff.bitflowapis.finance/api/quotes/docs
https://bff.bitflowapis.finance/api/app/docs
constBFF_API_URL='https://bff.bitflowapis.finance/api';fetch(url,{method:'GET',// or 'POST'headers:{'Content-Type':'application/json',// Optional: 'X-API-Key': '<bitflow-assigned-api-key>' — only needed for a raised limit},})
No API key is required for the default 100 req/s tier. Need a higher limit? Ask in Intercom and we will issue an X-API-Key with a raised quota.
Stacks node / Stacks API is not included. For Stacks RPC and Hiro API access, use Hiro Platform and the Hiro API docs.
On-chain fallback
The Bitflow HODLMM API uses on-chain data as a fallback when database data becomes stale.
You can disable this behavior by setting:
X-Allow-Fallback: false
When disabled, the API will not query on-chain data and may return database stale data.
Strict vs Simple Mode
Strict mode is ideal for those looking to execute precise liquidity operations. These transactions can be broadcast in Deny mode and use exact bin IDs. If on-chain state changes in a way that affects your quoted bins/amounts, the transaction will revert (for example: if you’re trying to add to the active bin and it shifts by 1 before execution).
Simple mode is ideal for those looking to add liquidity with more flexibility and fewer failed transactions. These transactions can be broadcast in Allow mode and use offsets from the active bin ID rather than absolute bin IDs. Transactions are more likely to confirm even when on-chain state changes, since the liquidity operation is applied relative to the current active bin at the time of execution.
Adding Liquidity
1
Getting Pool Bins
Before adding liquidity, you need to get the pool's bins. You can do this via the following endpoint:
/quotes/v1/bins/{pool_id}: Returns all bins for a pool