Documentation Index
Fetch the complete documentation index at: https://docs.houdiniswap.com/llms.txt
Use this file to discover all available pages before exploring further.
Partner Stats
The stats endpoints return metrics scoped to your partner account — not platform-wide totals. Use them to build dashboards, monitor performance, or integrate your volume data into internal reporting.All stats endpoints require full API key authentication (
Authorization: <partnerId>:<apiSecret>). The public partner-id header does not grant access.GET /v2/stats/volume
Returns cumulative volume metrics for your partner account.Endpoint
Parameters
None.Example Request
Example Response
Response Fields
| Field | Type | Description |
|---|---|---|
count | number | Total completed transactions (all time) |
totalTransactedUSD | number | Total transacted value in USD (all time) |
totalOrders | number | Alias for count |
thisMonthVolumeUsd | number | Transacted value in USD for the current calendar month |
lastMonthVolumeUsd | number | Transacted value in USD for the previous calendar month |
thisMonthOrders | number | Completed transactions in the current calendar month |
GET /v2/stats/weeklyVolume
Returns a per-week breakdown of your partner volume, ordered chronologically.Endpoint
Parameters
None.Example Request
Example Response
Response Fields
| Field | Type | Description |
|---|---|---|
week | number | ISO week number (1–53) |
year | number | Year |
count | number | Total transactions for the week |
anonymous | number | Number of private (anonymous) transactions |
volume | number | Total transaction volume in USD |
commission | number | Commission earned in USD for the week |
GET /v2/stats/chart
Returns time-series data for a given metric over a custom date range. Useful for building volume charts in dashboards or analytics tools.Endpoint
Parameters
| Field | Type | Required | Description |
|---|---|---|---|
metric | string | Yes | Metric to chart. Currently supported: volume |
from | string | Yes | Start of range (ISO 8601, e.g. 2026-01-01T00:00:00Z) |
to | string | Yes | End of range (ISO 8601, e.g. 2026-04-22T23:59:59Z) |
granularity | string | No | Bucket size: day (default) or month |
Example Request
Example Response
Response Fields
| Field | Type | Description |
|---|---|---|
date | string | Bucket date. Format: YYYY-MM-DD for day, YYYY-MM for month |
volumeUsd | number | Total transacted value in USD for the bucket |
count | number | Number of completed transactions in the bucket |
Days or months with no activity are omitted from the response. Your charting code should fill in zero values for missing dates.