Listado de instrumentos por schema agrupado por ISIN con consultas OData.
Instrumentos consolidados devuelve el listado de instrumentos asociados a un schema, agrupado por ISIN, en formato paginado y aceptando consultas OData para filtrar, ordenar y paginar los resultados. Comparte la misma forma de respuesta que el endpoint de instrumentos y se diferencia por el segmento Data/consolidated-by-odata en la URL.
URL
Devuelve los instrumentos del schema consultado agrupados por ISIN, permitiendo filtrar, ordenar y paginar los resultados mediante operadores OData.
GET https://apids.primary.com.ar/prd-ro/v3/api/schemas/{schemaName}/Data/consolidated-by-odataHeaders
Headers necesarios para invocar el servicio.
| Header | Valor | Estado | Descripción |
|---|---|---|---|
| Ocp-Apim-Subscription-Key | <API_KEY> | Requerido | API Key habilitada para consumir Primary Reference. |
| Content-Type | application/json | Requerido | Header recomendado para las requests de ejemplo. |
Parámetros
Parámetros esperados por la URL para ejecutar la consulta.
| Nombre | Ubicación | Tipo | Estado | Descripción |
|---|---|---|---|---|
| schemaName | path | string | Requerido | Identificador del schema a consultar. Validar el último schema disponible. |
| $filter | query | string | Opcional | Expresión OData para filtrar instrumentos (por ejemplo, type eq 'CS'). |
| $orderby | query | string | Opcional | Expresión OData para ordenar los resultados, por ejemplo name asc. |
| $skip | query | number | Opcional | Cantidad de registros a omitir desde el inicio del listado. |
| $top | query | number | Opcional | Cantidad máxima de registros a devolver. |
Probar endpoint
La API Key se usa sólo para esta prueba y no se persiste en cookies.
Identificador del schema cuyos instrumentos desea consultar. Requerido.
Expresión OData para filtrar los instrumentos devueltos. Opcional.
Expresión OData para ordenar los resultados. Opcional.
Cantidad de registros a omitir. Opcional.
Cantidad máxima de registros a devolver. Opcional.
Request preview
GET https://apids.primary.com.ar/prd-ro/v3/api/schemas/{schemaName}/Data/consolidated-by-odataOcp-Apim-Subscription-Key: ********Campos de respuesta
Campos de primer nivel
| Campo | Tipo | Descripción |
|---|---|---|
data | array<object> | Listado consolidado de instrumentos asociados al schema consultado. |
totalCount | number | Cantidad total de registros que satisfacen el filtro aplicado. |
Estructura de data[]
| Campo | Tipo | Descripción |
|---|---|---|
name | string | Identificador del instrumento dentro del schema. |
type | string | Tipo de instrumento, por ejemplo CS, CD, OPT. |
active | boolean | Indica si el instrumento se encuentra activo. |
fields | object | Conjunto dinámico de atributos del instrumento definidos por el schema. |
updated | string | Fecha y hora de la última actualización del instrumento, en formato ISO 8601. |
Campos de fields
Los campos que viajan dentro de fields dependen del tipo de instrumento. Consulte el diccionario de campos para ver, por cada tipo, los campos que publica con su nombre de negocio.