Sign in

v1

latestOpenAPI 3.0.32026-07-2613529376.3 KB
Mining Pool

Set Payout Destination

Updates the payout destination for a specific mining account belonging to the authenticated user. Can be set to main balance or an external BTC address.

<Warning> Rate limit: 1000 requests/10 sec. </Warning>
post/api/v4/mining/payout-destination/edit

Request body

accountNamestring required

Mining pool account name

destination'main_balance' | 'external_address' required

Payout destination type

addressstring

External BTC address. Required when destination is external_address. Supports all standard Bitcoin address formats.

Example request

{
  "accountName": "my_miner_01",
  "destination": "external_address",
  "address": "bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh"
}

Response

Successful response

payoutDestination'main_balance' | 'external_address'
externalAddressstring nullable