POST
/
v1
/
entities
/
{entity_id}
/
futures
/
sweeps
Schedule Entity Futures Sweep
curl --request POST \
  --url https://api.prime.coinbase.com/v1/entities/{entity_id}/futures/sweeps \
  --header 'Content-Type: application/json' \
  --data '{
  "amount": "1000.00",
  "currency": "USD"
}'
{
  "success": true,
  "request_id": "00000000-0000-0000-0000-000000000000"
}

Path Parameters

​
entity_id
string
required

Entity ID

Body

application/json
​
currency
string
required

Currency. Required

Example:

"USD"

​
amount
string

Amount. Default to sweep all if not provided

Example:

"1000.00"

Response

200 - application/json

A successful response.

​
success
boolean

Success

Example:

true

​
request_id
string

Request ID

Example:

"00000000-0000-0000-0000-000000000000"