Edit a brokerage or its fee schedule.

PUT

/api/brokerages/{id}

curl --request PUT \
  --url https://api.tradr.cloud/api/brokerages/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Content-Type: application/json' \
  --data '{ "feeSchedule": { "optionsMaxPerFill": "example", "optionsMinPerFill": "example", "optionsPerContractCommission": "example", "optionsPerContractExchangeFee": "example", "stockMaxPerFill": "example", "stockMinPerFill": "example", "stockPerShareCommission": "example" }, "name": "example", "notes": "example" }'

• Hosted (tradr.cloud)
• Local development (API PORT default)

Authed. Every field is optional; feeSchedule is merged, so you can send a single rate. Fee values are non-negative decimal strings. System brokerages are read-only.

Parameters

Path Parameters

id

required

string format: uuid

Request Body^required

Media typeapplication/json

object

feeSchedule

Any subset of the fee fields. Each is a non-negative decimal string.

object

optionsMaxPerFill

string

optionsMinPerFill

string

optionsPerContractCommission

string

optionsPerContractExchangeFee

string

stockMaxPerFill

string

stockMinPerFill

string

stockPerShareCommission

string

name

string

>= 1 characters <= 100 characters

notes

string

nullable <= 10000 characters

Example^generated

{
  "feeSchedule": {
    "optionsMaxPerFill": "example",
    "optionsMinPerFill": "example",
    "optionsPerContractCommission": "example",
    "optionsPerContractExchangeFee": "example",
    "stockMaxPerFill": "example",
    "stockMinPerFill": "example",
    "stockPerShareCommission": "example"
  },
  "name": "example",
  "notes": "example"
}

Responses

200

The updated brokerage.

400

Validation error.

403

System brokerages cannot be modified.

404

No such brokerage for this user.

409

A brokerage with this name already exists.