Endpoints para consulta de precios de instrumentos del mercado de capitales.
El endpoint de esta sección utiliza una API Key en el header Ocp-Apim-Subscription-Key y permite consultar el último precio de cierre de instrumentos del mercado de capitales en formato paginado con consultas OData.
Endpoints documentados
- Listado de precios: obtiene el listado de precios paginado de a 300 registros con soporte OData.
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 Prices. |
Content-Type | application/json | Header recomendado para las requests de ejemplo. |
Listado de precios
Devuelve un listado de precios paginado de a 300 registros. Acepta consultas OData para filtrar y ordenar, con la salvedad de que los operadores $top y $expand no son admitidos. La paginación se controla con $skip.
URL
Devuelve el listado de precios de instrumentos en formato paginado, con páginas de 300 registros, permitiendo filtrar y ordenar mediante operadores OData. Los operadores $top y $expand no son admitidos.
GET https://apids.primary.com.ar/pip-ro/v1/api/InstrumentPricesHeaders
Headers necesarios para invocar el servicio.
| Header | Valor | Estado | Descripción |
|---|---|---|---|
| Ocp-Apim-Subscription-Key | <API_KEY> | Requerido | API Key habilitada para consumir Primary Prices. |
| 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 |
|---|---|---|---|---|
| $skip | query | number | Opcional | Cantidad de registros a omitir desde el inicio del listado. Se usa para avanzar entre páginas de 300 registros. |
| $filter | query | string | Opcional | Expresión OData para filtrar los precios, por ejemplo type eq 'CD'. |
| $orderby | query | string | Opcional | Expresión OData para ordenar los resultados, por ejemplo name asc. |
Probar endpoint
La API Key se usa sólo para esta prueba y no se persiste en cookies.
Cantidad de registros a omitir. Use 300, 600, 900... para avanzar entre páginas. Opcional.
Expresión OData para filtrar los precios devueltos. Opcional.
Expresión OData para ordenar los resultados. Opcional.
Request preview
GET https://apids.primary.com.ar/pip-ro/v1/api/InstrumentPricesOcp-Apim-Subscription-Key: ********Campos de respuesta
La respuesta es un array de objetos. Cada elemento describe el precio de un instrumento con los campos detallados a continuación.
| Campo | Tipo | Descripción |
|---|---|---|
mdEntryDate | number | Fecha del precio informado en formato YYYYMMDD. |
symbol | string | Símbolo del instrumento. |
name | string | Nombre completo del instrumento. |
closingPrice | number | Precio de cierre del instrumento. |
tradeVolume | number | Volumen operado asociado al precio informado. |
type | string | Tipo de instrumento, por ejemplo CD, CS, OPT. |
instrumentCode | string | null | Código adicional del instrumento, cuando el servicio lo informa. |
La paginación se realiza por
$skipen bloques de 300 registros. Los operadores$topy$expandno están soportados.
