Draw a Gumball

Builds the buyer's draw transactions. Have the buyer sign them, then post them to POST /v1/sendDrawGumballTxs/{gumballKey}. mallow has to co-sign them, so don't send them yourself.

When paying with a swapQuote, the response may contain only a swapTx. Send it, wait for confirmation, then call this endpoint again without swapQuote.

Authorization

ApiKeyAuth

x-api-key<token>

In: header

Path Parameters

gumballKey*string

Address of the gumball machine (base58).

Length1 <= length

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

buyer*string

Wallet drawing from the gumball machine (base58). Signs and pays for the transactions.

Length1 <= length

quantity?integer

Number of draws to make (1–10). Defaults to 1.

Range1 <= value <= 10

Default1

guardGroupLabel?string

Label of the guard group whose rules apply to this draw, for machines that run several phases (allowlist, public, and so on). Omit to use the default group.

swapQuote?unknown

Jupiter swap quote, required when the machine prices draws in a token the buyer does not hold. The swap is bundled with the draw when it fits; otherwise the response returns swapTx instead and you make a second call without this field.

walletSupportsTxV1?boolean

Set to true if the buyer's wallet can sign version 1 transactions. Large draws need one, and are refused with 400 without it.

Response Body

`application/json`

curl -X POST "https://example.com/v1/getDrawGumballTxs/string" \  -H "Content-Type: application/json" \  -d '{    "buyer": "string"  }'

{  "result": {    "txs": [      "string"    ],    "swapTx": "string",    "swapTxReason": "size"  }}

Authorization

Path Parameters

Request Body

Response Body

200application/json

400application/json

401application/json

403application/json

429application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`