/apply

https://api.ibkr.com/ws/ptc/csv/apply

  • Service is used to manage restrictions, rules, and associations for Pre-Trade Compliance using the API.

  • HTTP Request Type: POST

Name

Value

Description

CSID

Client Service ID

Unique identifier issued by Interactive Brokers.

 

user

String

IBKR user ID of the individual intiating the request.

The user ID must have access rights to 'Pre Trade Compliance'.

reqID

Non-negative integer value.

Unique identifier associated with the request. reqID will need to be unique for each reqID. If reqID was previously processed, error will be thrown.

payload

Encrypted and signed CSV file containing all of the restrictions.

Encrypted and signed CSV file, encoded in base64.

JSON Request

Copy 
{
  "CSID":"<client-service-id>","user":"<userID>","reqId":<requestID>,
  "payload":"<encrypted and signed CSV file, encoded in base64>"
}

Sample

Copy 
curl -k -H "Content-Type:application/json" -X POST https://[domain]/ptc/csv/apply -d '{"CSID":"testerCSID", "user":"myuser1", "reqId":1, 
"payload":" ye0cQWpTeUymc/Xq5a0DMFCUk/EStTuLSHvxMOLoowBBl8BwueD2iyntVf+6iXGOz+/WAM/+Y/KheszZOWfasdfawe235afuD2Li2LT3RzRuxzlpi7CXgIQvqOVzWsSoB6m"}'

Name

Value

Description

success

Boolean

Indicate whether the request has been processed or not. In case request has been processed.

true: Indicates the file was successfully submitted to Interactive Brokers.

false: Indicates the file was not processed.

reqId

Non-Negative integer value

reqId that was processed.

message

String

If success=false, the message will have some information about the error.

JSON Response

Copy 
{
  "success": "<true|false>",
  "reqId":"<String>",
    "message":"<string>"
  }
}

Sample

Copy 
{"success":true,"reqId":20211635375984312,"message":"OK"}