Cancel an order
curl --request DELETE \
--url https://api.paperdrill.dev/v1/orders/{orderId} \
--header 'x-api-key: <api-key>'const options = {method: 'DELETE', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.paperdrill.dev/v1/orders/{orderId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.paperdrill.dev/v1/orders/{orderId}"
headers = {"x-api-key": "<api-key>"}
response = requests.delete(url, headers=headers)
print(response.text){
"id": "order_123",
"symbol": "SOL_USD",
"status": "CANCELLED",
"side": "BUY",
"qty": "2.00",
"filledQty": "0.50",
"releasedFunds": "188.25"
}{
"error": {
"code": "VALIDATION_ERROR",
"message": "Request validation failed",
"details": [
{
"field": "qty",
"message": "invalid decimal format"
}
]
},
"requestId": "f4c0baf4-b8d2-4c9a-a17b-c8656c4a7b0e"
}{
"error": {
"code": "VALIDATION_ERROR",
"message": "Request validation failed",
"details": [
{
"field": "qty",
"message": "invalid decimal format"
}
]
},
"requestId": "f4c0baf4-b8d2-4c9a-a17b-c8656c4a7b0e"
}{
"error": {
"code": "VALIDATION_ERROR",
"message": "Request validation failed",
"details": [
{
"field": "qty",
"message": "invalid decimal format"
}
]
},
"requestId": "f4c0baf4-b8d2-4c9a-a17b-c8656c4a7b0e"
}Orders
Cancel an order
Cancels the unfilled portion of an open order. The account’s email must be verified.
Requires the ORDER_CANCEL scope.
DELETE
/
orders
/
{orderId}
Cancel an order
curl --request DELETE \
--url https://api.paperdrill.dev/v1/orders/{orderId} \
--header 'x-api-key: <api-key>'const options = {method: 'DELETE', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.paperdrill.dev/v1/orders/{orderId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.paperdrill.dev/v1/orders/{orderId}"
headers = {"x-api-key": "<api-key>"}
response = requests.delete(url, headers=headers)
print(response.text){
"id": "order_123",
"symbol": "SOL_USD",
"status": "CANCELLED",
"side": "BUY",
"qty": "2.00",
"filledQty": "0.50",
"releasedFunds": "188.25"
}{
"error": {
"code": "VALIDATION_ERROR",
"message": "Request validation failed",
"details": [
{
"field": "qty",
"message": "invalid decimal format"
}
]
},
"requestId": "f4c0baf4-b8d2-4c9a-a17b-c8656c4a7b0e"
}{
"error": {
"code": "VALIDATION_ERROR",
"message": "Request validation failed",
"details": [
{
"field": "qty",
"message": "invalid decimal format"
}
]
},
"requestId": "f4c0baf4-b8d2-4c9a-a17b-c8656c4a7b0e"
}{
"error": {
"code": "VALIDATION_ERROR",
"message": "Request validation failed",
"details": [
{
"field": "qty",
"message": "invalid decimal format"
}
]
},
"requestId": "f4c0baf4-b8d2-4c9a-a17b-c8656c4a7b0e"
}Authorizations
A scoped API key created in the PaperDrill dashboard.
Path Parameters
Order identifier.
Response
Order cancelled successfully.
- Option 1
- Option 2
Allowed value:
"CANCELLED"Available options:
BUY, SELL A non-negative decimal encoded as a string.
Pattern:
^\d+(\.\d+)?$Example:
"125.50"
A non-negative decimal encoded as a string.
Pattern:
^\d+(\.\d+)?$Example:
"125.50"
A non-negative decimal encoded as a string.
Pattern:
^\d+(\.\d+)?$Example:
"125.50"