Benchmarks
A benchmark is a portfolio, such as one or more ETFs, that you compare a model with. A model can have one benchmark, which its benchmarkId names.
Benchmarks have no effect on trade proposals.
To give a model a benchmark, call Create a model or Update a model.
List benchmarks
Returns your firm's benchmarks, in ascending order of `id`. The list does not include each benchmark's securities: call **Get a benchmark** for those.
Create a benchmark
Creates a benchmark with the name, description and securities in the request body. To compare a model with the benchmark, send its `id` as the model's `benchmarkId`.
Get a benchmark
Returns the benchmark with the given ID, with its securities. If your firm has no benchmark with that ID, the response is `404`.
Update a benchmark
Replaces the benchmark with the given ID with the one in the request body. Send every field: securities that you leave out of `primarySecurities` are removed from the benchmark. Other fields in the body, such as `id`, are ignored. If your firm has no benchmark with that ID, the response is `404`.
Delete a benchmark
Deletes the benchmark with the given ID. Models that use the benchmark are left with no benchmark: their `benchmarkId` becomes `null`. Returns `deleted: true`. If your firm has no benchmark with that ID, the response is `404`.