Creates Multiple Cancel Instructions

POST

/gw/api/v1/instructions/cancel:bulk

POST

/gw/api/v1/instructions/cancel:bulk

$ curl -X POST https://api.ibkr.com/gw/api/v1/instructions/cancel:bulk \
>      -H "Content-Type: application/json" \
>      -d '{
>   "instructionType": "CANCEL_INSTRUCTION",
>   "instructions": [
>     "string",
>     "string",
>     "string"
>   ]
> }'

1 {
2   "status": 202,
3   "instructionSetId": 3855,
4   "instructionResults": [
5     {
6       "status": 202,
7       "instructionSetId": 3855,
8       "instructionResult": {
9         "clientInstructionId": 12001861,
10         "instructionType": "CANCEL_INSTRUCTION",
11         "instructionStatus": "PROCESSED",
12         "instructionId": 43094281
13       }
14     },
15     {
16       "status": 202,
17       "instructionSetId": 3855,
18       "instructionResult": {
19         "clientInstructionId": 12001862,
20         "instructionType": "CANCEL_INSTRUCTION",
21         "instructionStatus": "PROCESSED",
22         "instructionId": 43094282
23       }
24     },
25     {
26       "status": 202,
27       "instructionSetId": 3855,
28       "instructionResult": {
29         "clientInstructionId": 12001863,
30         "instructionType": "CANCEL_INSTRUCTION",
31         "instructionStatus": "PROCESSED",
32         "instructionId": 43094283
33       }
34     }
35   ]
36 }

Scope: instructions.write
Security Policy: Signed JWT

Path parameters

client-idstringRequired

The client's clientId

Request

Create Bulk Cancel Instructions request body

instructionTypeenumRequired

Allowed values:

instructionslist of anyRequired

Response

Accepts all instructions in Bulk request to create them asynchronously

statuslong

instructionSetIddouble

instructionResultslist of objects

Errors

400

Bad Request Error

500

Internal Server Error