Create a brokerage.

POST

/api/brokerages

const url = 'https://api.tradr.cloud/api/brokerages';
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: '{"name":"example","notes":"example"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://api.tradr.cloud/api/brokerages \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "notes": "example" }'

Authed. Names are unique per user. The new brokerage starts with a zeroed fee schedule; set the rates with a follow-up PUT.

Request Body^required

application/json

object

name

required

string

>= 1 characters <= 100 characters

notes

string

nullable <= 10000 characters

Example^generated

{
  "name": "example",
  "notes": "example"
}

Responses

201

The created brokerage.

400

Validation error.

409

A brokerage with this name already exists.

Create a brokerage.

Request Bodyrequired

Examplegenerated

Responses

201

400

409

Request Body^required

Example^generated