Skip to main content
POST
Close Position

Authorizations

Authorization
string
header
required

A bearer token signed using your API Key Secret, see Creating API Keys section of our docs for more information. See Scope & Permissions for the permission each endpoint requires.

Body

application/json
client_order_id
string
required

The unique ID provided for the order (used for identification purposes).

Example:

"0000-00000-000000"

product_id
string
required

The trading pair (e.g. 'BIT-28JUL23-CDE').

Example:

"BIT-28JUL23-CDE"

size
string

The amount of contracts that should be closed.

Example:

3

Response

A successful response.

success
boolean
required

Whether the order was created.

Example:

true

success_response
object
error_response
object
order_configuration
object

The configuration of the order (e.g. the order type, size, etc).