Endpoints
Create an ad
createAd transaction on the ad chain:
POST /v1/ads/:id/confirm. Fund, withdraw, update, and close follow the
same pattern: request → transaction data → wallet submits → confirm.
Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
Maker liquidity: create, fund, withdraw, update, and close ads
| Endpoint | Purpose |
|---|---|
GET /v1/ads | list ads — filter by status, creatorAddresses, route; cursor-paginated |
GET /v1/ads/:id | one ad with its route, pool, and limits |
POST /v1/ads/create | create an ad → the createAd transaction data for the ad chain |
POST /v1/ads/:id/fund | top up the pool → fundAd transaction data |
POST /v1/ads/:id/withdraw | withdraw from the pool → transaction data |
PATCH /v1/ads/:id/update | change limits / metadata |
POST /v1/ads/:id/close | close the ad and reclaim liquidity |
POST /v1/ads/:id/confirm | confirm a pending ad action landed on-chain |
POST /v1/ads/create
{
"routeId": "123e4567-e89b-12d3-a456-426614174000",
"creatorDstAddress": "0x…", // where you receive on the order chain
"fundAmount": "1000000000000000000",
"minAmount": "100000000000000000", // optional
"maxAmount": "5000000000000000000", // optional
"metadata": { "title": "My Ad" } // optional
}
createAd transaction on the ad chain:
{
"chainId": "1000001",
"chainKind": "STELLAR",
"contractAddress": "…", // the AdManager
"adId": "…",
"adToken": "…",
"initialAmount": "1000000000000000000",
"orderChainId": "11155111",
"adRecipient": "…"
}
POST /v1/ads/:id/confirm. Fund, withdraw, update, and close follow the
same pattern: request → transaction data → wallet submits → confirm.