XRPL.to
POST /boost/purchase
POST

/v1/boost/purchase

Create boost payment request. `termHours` is 12 (default) or any multiple of 12 up to 8760, a year; the bid is per 12 hours and ranks the board, the total is the bid once per 12 hours (the quote prints each). At most 8 of the 10 slots can be on long runs: past that a longer run answers 409. A token that holds a slot adds the time to what is left: `packId: "extend"` keeps its bid, a lower bid is refused. `ad` is the Top spot's ad line: one sentence (max 70 chars) and a button word (max 14), linking only to the token's own website

AuthNone — works without a key

Payload

POSThttps://api.xrpl.to/v1/boost/purchase
Body
Body fieldsas documented
{
  md5,
  packId,
  payerAddress,
  bidUsd?,
  termHours?,
  ad?: { text, cta?, url? }
}
curl -X POST 'https://api.xrpl.to/v1/boost/purchase'
No public sample for this one — copy the code and fill in your own values.

Response

No public sample for this endpoint — run the code on the right with your own values to see the response.

What it does

Create boost payment request. `termHours` is 12 (default) or any multiple of 12 up to 8760, a year; the bid is per 12 hours and ranks the board, the total is the bid once per 12 hours (the quote prints each). At most 8 of the 10 slots can be on long runs: past that a longer run answers 409. A token that holds a slot adds the time to what is left: `packId: "extend"` keeps its bid, a lower bid is refused. `ad` is the Top spot's ad line: one sentence (max 70 chars) and a button word (max 14), linking only to the token's own website

How the slot auction works is in the Boost guide. Read the guide →
OpenAPI
PrevGET/boost/quote/{md5}NextGET/boost/verify/{invoiceId}