security

Get the metrics defined for a set of securities

Get the metrics defined for a set of securities, however this only currently supports getting exactly one by name - more to come. That is, this allows you to query the metric definitions of a security by name rather than by id.

get/security/{type}/metrics

Request

Base URL
https://api.merqube.com
Auth
none declared
TypeScript
https://skmtc.dev/merqube/apis/merqube-api/docs/security/:type/metrics/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

typestring required

the type of security (futures_root, intraday_index etc)

Query parameters

namestring

Example:MQUSTB20

Taken as an Exact name to find a resource by

prefer_read_replicaboolean

Opt into replica/cache-tolerant reads. Defaults to false, which keeps DB reads on the writer and bypasses SecAPI full-query caches for stronger read-after-write consistency.

Response

200 response

descriptionstring required

a description of what this metric represents

namestring required

metric name

object_schemaobject

optional - this supports complex objects, ie you can specify the metric is of this schema. THis allows you to upload a json schema itself of this metric. THis is for downstream users of this metric.

Changes

No recorded changes to this operation across all 1 revision of this API.