Listado de instrumentos por schema desglosado por plazo de liquidación y moneda con consultas OData.
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. |
Estructura de fields
El objeto fields contiene los atributos específicos del schema consultado y, por lo tanto, es dinámico. Los siguientes campos se observan habitualmente para los schemas de instrumentos.
| Campo | Tipo | Descripción |
|---|---|---|
symbol | string | Símbolo del instrumento. |
issuer | string | Emisor o mercado asociado, por ejemplo BYMA, ROFX. |
currency | string | Moneda principal del instrumento. |
country | string | País asociado al instrumento, por ejemplo ARG. |
cfiCode | string | Código CFI del instrumento. |
securityStatus | string | Estado del instrumento informado por el servicio. |
marketId | string | Mercado en el que opera el instrumento. |
maturityDate | string | null | Fecha de vencimiento del instrumento, cuando aplica. |
strikePrice | string | null | Precio de ejercicio para opciones, cuando aplica. |
tickSize | string | null | Tamaño del incremento mínimo de precio. |
tickPriceRules | array<object> | null | Reglas de incremento de precio por rango. |
priceDecimals | string | null | Cantidad de decimales utilizados para el precio. |
roundLot | string | null | Lote estándar de negociación. |
minSize | string | null | Cantidad mínima negociable. |
maxSize | string | null | Cantidad máxima negociable. |
settlementDate | string | null | Fecha de liquidación del instrumento, cuando aplica. |
Los atributos disponibles dependen del schema consultado y pueden incluir campos adicionales propios del producto, como datos de fondos comunes de inversión, opciones, futuros u obligaciones negociables.