Home B2Core IB API Processes

Processes

On this page:

THE PROCESS OBJECT

A detailed description of the JSON object

GET[base]/processes

Get a process list

GET[base]/processes/{processesId}

Get process details

POST[base]/processes

Run a new process

The Process object

This object provides the following data about a process:

processId string

The process identifier.

pid integer

The process identifier on the server.

name integer

The process name. Possible values:

  • accounts

  • groups

  • symbols

  • trades

  • pay

  • fund

  • refund

  • diagnostics

  • cache

arguments string

The process-specific command line parameters.

messages integer

The number of messages in the process log.

memory integer

The amount of CPU random access memory used by a process, in bytes.

time integer

The amount of time spent on process execution, in milliseconds.

code integer

The process exit code. Possible values:

  • 0 — the process completed successfully.

  • 1 — the process wasn’t completed due to errors.

  • 2 — the process was gracefully stopped due to service maintenance.

version string

The IB app version.

createTime string

The date and time when the object has been created.

updateTime string

The date and time when the object has been last updated.

THE PROCESS OBJECT 
{
    "processId": "6006dda272f002519c3eb505",
    "pid": 3279,
    "name": "trades",
    "arguments": "2021-01-01T00:00:00+00:00 2021-01-31T23:59:59+00:00",
    "messages": 1,
    "memory": 60,
    "time": 3368967,
    "code": 0,
    "version": "2.18.0",
    "createTime": "2021-01-01T00:00:00+00:00",
    "updateTime": "2021-01-01T00:00:00+00:00"
  }

Get a process list

Use this method to obtain a list of processes.

To obtain detailed information about a specified process, use a separate method to get process details.

Request

Header parameters:

  • Authorization: Bearer <token>

Query parameters:

This method supports pagination, sorting, and filtering. For details on applying the parameters, refer to the Query parameters section. Possible parameters for filtering and sorting are listed below. For values description, refer to the Process object.

Possible values for the filter parameter:

  • arguments

Possible values for the sort_by parameter:

  • arguments

  • createTime (default)

  • code

  • memory

  • pid

  • processId

  • name

  • time

  • updateTime

  • version

GET[base]/processes

curl --location -g --request GET 'https://your.base-url.here/processes?limit=10&offset=0&sort_by=createTime&sort_order=desc&filter[arguments]=2021-01-01T00:00:00+00:00 2021-01-31T23:59:59+00:00&filter[createDate]=2021-01-01&filter[code]=0&filter[level]=info&filter[memory]=60&filter[pid]=3279&filter[name]=trades&filter[time]=3368967' \
--header 'Authorization: Bearer <token>'

Response

Body:

In case of success, the response body contains a Process object providing information about all processes that correspond to the query parameters specified in the request.

Get process details

Use this method to obtain detailed information about a specified process.

To obtain a list of available processes, use a separate method to get a list of processes.

Request

Header parameters:

  • Authorization: Bearer <token>

Path parameters:

processId required

The process identifier.

GET[base]/processes/{processId}

curl --location --request GET 'https://your.base-url.here/processes/60ba407d15951453e60e49f8' \
--header 'Authorization: Bearer <token>'

Response

Body:

In case of success, the response body contains a Process object providing information about the specified process.

Run a new process

Use this method to run a process.

Request

Header parameters:

  • Authorization: Bearer <token>

  • Content-Type: application/json

Body:

name string required

The process name. Possible values:

  • accounts

  • groups

  • symbols

  • trades

  • pay

  • fund

  • refund

  • diagnostics

  • cache

The content of the fields indicated in the request can vary depending on the process.

POST[base]/processes

curl --location --request POST 'https://your.base-url.here/processes' \
--header 'Authorization: Bearer <token>' \
--data-raw '{
  "name": "trades",
  "verbosity": "v",
  "startTime": "2021-01-01T00:00:00+00:00",
  "endTime": "2021-01-31T23:59:59+00:00",
  "platformId": "6006dda272f002519c3eb505",
  "tradingAccountNumber": "12345"
}'

Response

Body:

In case of success, the response body contains a Process object providing information about the newly created process.