Skip to main content
POST
/
v1
/
pm
/
markets
/
{marketId}
/
burn
Burn shares
curl --request POST \
  --url https://relay.bayse.markets/v1/pm/markets/{marketId}/burn \
  --header 'Content-Type: application/json' \
  --data '
{
  "quantity": 123,
  "currency": "<string>"
}
'
{
  "operationId": "e5f6a7b8-c9d0-1234-efab-567890123456",
  "marketId": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
  "quantity": 10,
  "outcome1Price": 0.65,
  "outcome2Price": 0.35,
  "proceeds": 10.00
}

Documentation Index

Fetch the complete documentation index at: https://docs.bayse.markets/llms.txt

Use this file to discover all available pages before exploring further.

Burning is the reverse of minting. You surrender an equal number of YES and NO shares (a complementary pair) and receive funds back. Like minting, burning does not affect market prices since it removes both sides equally. This is useful for exiting a position when you hold both outcomes, or for converting shares back to cash. You must hold sufficient shares of both YES and NO to burn.

​
Authentication

Write authentication required — X-Public-Key, X-Timestamp, and X-Signature headers. See the Authentication guide.

​
Path parameters

​
marketId
string
required
UUID of the market.

​
Request body

​
quantity
number
required
Amount to redeem from the burn operation in the selected currency. For example, quantity: 100, currency: "NGN" means “burn enough complete-set inventory to receive 100 NGN”. Must be greater than 0.
​
currency
string
USD (default) or NGN.
Request quantity is a wallet amount in the provided currency. The response quantity is the normalized share quantity burned.

​
Example request

PUBLIC_KEY="pk_live_abcdef123456"
SECRET_KEY="sk_live_secret789xyz"
TIMESTAMP=$(date +%s)
METHOD="POST"
URL_PATH="/v1/pm/markets/b2c3d4e5-f6a7-8901-bcde-f12345678901/burn"
BODY='{"quantity":10,"currency":"USD"}'

BODY_HASH=$(printf '%s' "$BODY" | openssl dgst -sha256 -hex 2>/dev/null | sed 's/.*= //')
PAYLOAD="${TIMESTAMP}.${METHOD}.${URL_PATH}.${BODY_HASH}"
SIGNATURE=$(printf '%s' "$PAYLOAD" | openssl dgst -sha256 -hmac "$SECRET_KEY" -binary | base64)

curl -X POST "https://relay.bayse.markets${URL_PATH}" \
  -H "X-Public-Key: ${PUBLIC_KEY}" \
  -H "X-Timestamp: ${TIMESTAMP}" \
  -H "X-Signature: ${SIGNATURE}" \
  -H "Content-Type: application/json" \
  -d "$BODY"

​
Response

​
operationId
string
UUID of the burn operation.
​
marketId
string
UUID of the market.
​
quantity
number
Normalized share quantity burned.
​
outcome1Price
number
Current price of outcome 1 (YES). Returned for convenience — burning does not change market prices.
​
outcome2Price
number
Current price of outcome 2 (NO). Returned for convenience — burning does not change market prices.
​
proceeds
number
Funds returned from the burn operation.
{
  "operationId": "e5f6a7b8-c9d0-1234-efab-567890123456",
  "marketId": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
  "quantity": 10,
  "outcome1Price": 0.65,
  "outcome2Price": 0.35,
  "proceeds": 10.00
}