Skip to main content
POST
/
api
/
dispenser
/
claim
Dispenser
curl --request POST \
  --url https://api.compose.market/api/dispenser/claim \
  --header 'Content-Type: application/json' \
  --data '
{
  "address": "<string>",
  "chainId": 123
}
'
{
  "success": true,
  "alreadyClaimed": true,
  "claimAmount": 123
}

Documentation Index

Fetch the complete documentation index at: https://docs.compose.market/llms.txt

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

Dispenser routes support the public funding flow used by development and onboarding clients.

Routes

MethodPathDescription
POST/api/dispenser/claimClaim USDC for one address and chain.
GET/api/dispenser/statusReturn status for all configured dispensers.
GET/api/dispenser/status/{chainId}Return status for one chain.
GET/api/dispenser/check/{address}Check whether an address has claimed.

Claim body

address
string
required
EVM address. Invalid formats return 400.
chainId
number
required
Chain ID to claim on.

Response

success
boolean
Whether the claim succeeded.
alreadyClaimed
boolean
Present when the address already claimed.
claimAmount
number
The all-chain status route returns 1000000, equal to $1.00 USDC.