Endpoints para consulta de instrumentos del mercado de capitales.
Los endpoints de esta sección comparten la misma raíz de servicio y utilizan una API Key en el header Ocp-Apim-Subscription-Key. Permiten consultar instrumentos del mercado de capitales por schema y obtener las novedades (altas, bajas y modificaciones) que se registran sobre ellos.
Endpoints documentados
- Diccionario de campos: nombre de negocio de cada campo, por tipo de instrumento.
- Instrumentos: listado de instrumentos desglosado por plazo de liquidación y moneda.
- Instrumentos consolidados: listado de instrumentos agrupado por ISIN.
- Novedades: altas, bajas y modificaciones de instrumentos.
Tipos de instrumentos
| Clave | Descripción |
|---|---|
FUT | Futuros |
OPT | Opciones ByMA |
BUYSELL | Combinadas |
XLINKD | Índices |
OOF | Opciones A3 |
OOFOTC | Opciones OTC |
FUTOTC | Futuros OTC |
CS | Acciones |
CD | Cedears |
GO | Títulos públicos |
CORP | Obligaciones negociables |
CC | Criptomonedas |
FT | Fideicomisos financieros |
Header común
| Header | Valor esperado | Descripción |
|---|---|---|
Ocp-Apim-Subscription-Key | <API_KEY> | API Key asociada a la suscripción con permisos sobre Primary Reference. |
Content-Type | application/json | Header recomendado para las requests de ejemplo. |
Instrumentos
Instrumentos devuelve el listado de instrumentos asociados a un schema, desglosado por plazo de liquidación y moneda, en formato paginado y aceptando consultas OData para filtrar, ordenar y paginar los resultados.
URL
Devuelve los instrumentos del schema consultado, desglosados por plazo de liquidación y moneda, permitiendo filtrar, ordenar y paginar los resultados mediante operadores OData.
GET https://apids.primary.com.ar/prd-ro/v3/api/schemas/{schemaName}/data/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/by-odataOcp-Apim-Subscription-Key: ********Campos de respuesta
Campos de primer nivel
| Campo | Tipo | Descripción |
|---|---|---|
data | array<object> | Listado 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.
Instrumentos consolidados
Instrumentos consolidados devuelve el listado de instrumentos agrupado por ISIN para un schema, 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.
Novedades
El endpoint de novedades devuelve los instrumentos que registraron alguna novedad a partir de una fecha indicada. Permite distinguir altas, bajas y modificaciones mediante el segmento de operación en la URL, y aplicar consultas OData para filtrar el resultado. La estructura de la respuesta es la misma que la del endpoint data/by-odata.
URL
Devuelve los instrumentos que tuvieron novedades de tipo alta, baja o modificación desde la fecha indicada, soportando filtros OData adicionales.
GET https://apids.primary.com.ar/prd-ro/v3/api/Schemas/schema-010/News/{operation}Headers
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 |
|---|---|---|---|---|
| operation | path | string | Requerido | Tipo de novedad a consultar. Valores admitidos: inserts (altas), updates (modificaciones) y deletes (bajas). |
| dateFrom | query | string | Requerido | Fecha desde la que se consultan las novedades. Acepta formato YYYY-MM-DD; opcionalmente puede incluir hora en formato YYYY-MM-DDTHH:mm:ss. |
| filter | query | string | Opcional | Expresión OData para filtrar las novedades, por ejemplo type eq 'CS' o type ne 'OPT'. |
| $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.
Tipo de novedad: inserts, updates o deletes. Requerido.
Fecha desde la que se consultan las novedades. Acepta YYYY-MM-DD u opcionalmente YYYY-MM-DDTHH:mm:ss. Requerido.
Expresión OData opcional para filtrar las novedades por tipo u otros atributos. 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/schema-010/News/{operation}Ocp-Apim-Subscription-Key: ********Campos de respuesta
Campos de primer nivel
| Campo | Tipo | Descripción |
|---|---|---|
data | array<object> | Instrumentos con la novedad informada para la operación consultada. |
totalCount | number | Cantidad total de registros que satisfacen los filtros aplicados. |
Estructura de data[]
| Campo | Tipo | Descripción |
|---|---|---|
name | string | Identificador del instrumento. |
type | string | Tipo de instrumento, por ejemplo CS, CD, OPT. |
active | boolean | Indica si el instrumento se encuentra activo. |
fields | object | Atributos del instrumento al momento de la novedad. |
updated | string | Fecha y hora de la novedad, 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.