# Primary Information Docs

> Consolidated plain-text snapshot of the public documentation.

## API

URL: https://localhost:3000/docs/api
Description: Referencia de endpoints e integraciones documentadas en el sitio.

Esta sección agrupa la referencia de endpoints disponibles en el sitio de documentación.

## Colecciones

- [Primary Identity](/docs/api/primary-identity)
- [Primary Reference](/docs/api/primary-reference)
- [Primary Prices](/docs/api/primary-prices)
- [Primary Entity](/docs/api/primary-entity)

## Convenciones

- Todos los ejemplos usan `GET` cuando el endpoint es de sólo lectura.
- Los bloques de prueba interactiva consumen una ruta interna del sitio que reenvía la request al servicio remoto.
- La API Key se envía por request y no se persiste en cookies.

## Listado de entidades

URL: https://localhost:3000/docs/api/primary-entity/entities-list
Description: Listado de entidades del mercado de capitales con su código, nombre, tipo y mercados asociados.

Devuelve el listado completo de entidades del mercado de capitales, identificadas por su código y descritas por su tipo y los mercados a los que pertenecen.

## URL

Devuelve el catálogo completo de entidades disponibles, incluyendo bancos y otros participantes del mercado, con su código, nombre, tipo y mercados asociados.

```
GET https://apids.primary.com.ar/pie-ro/v1/api/Entities
```

## 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 Entity. |
| `Content-Type` | `application/json` | Requerido | Header recomendado para las requests de ejemplo. |

## Parámetros

Parámetros esperados por la URL para ejecutar la consulta.

Este endpoint no requiere parámetros adicionales.

## Campos de respuesta

La respuesta es un array de objetos. Cada elemento describe una entidad del mercado de capitales.

| Campo | Tipo | Descripción |
| --- | --- | --- |
| `code` | `string` | Código identificador de la entidad. |
| `name` | `string` | Razón social o nombre de la entidad. |
| `type` | `string` | Tipo de entidad, por ejemplo `BANK`. |
| `markets` | `array<string>` | Mercados a los que pertenece la entidad. Puede venir vacío. |

```json
[
  {
    "code": "00007",
    "name": "BANCO DE GALICIA Y BUENOS AIRES S.A.U.",
    "type": "BANK",
    "markets": []
  },
  {
    "code": "00011",
    "name": "BANCO DE LA NACION ARGENTINA",
    "type": "BANK",
    "markets": []
  },
  {
    "code": "00014",
    "name": "BANCO DE LA PROVINCIA DE BUENOS AIRES",
    "type": "BANK",
    "markets": []
  }
]
```

## Primary Entity

URL: https://localhost:3000/docs/api/primary-entity
Description: Endpoints para consulta de entidades 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 el catálogo de entidades del mercado de capitales, incluyendo bancos y otros participantes.

## Endpoints documentados

- [Listado de entidades](/docs/api/primary-entity/entities-list): obtiene el listado completo de entidades con su código, nombre, tipo y mercados asociados.

## 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 Entity. |
| `Content-Type` | `application/json` | Header recomendado para las requests de ejemplo. |

---

## Listado de entidades

Devuelve el listado completo de entidades del mercado de capitales, identificadas por su código y descritas por su tipo y los mercados a los que pertenecen.

## URL

Devuelve el catálogo completo de entidades disponibles, incluyendo bancos y otros participantes del mercado, con su código, nombre, tipo y mercados asociados.

```
GET https://apids.primary.com.ar/pie-ro/v1/api/Entities
```

## 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 Entity. |
| `Content-Type` | `application/json` | Requerido | Header recomendado para las requests de ejemplo. |

## Parámetros

Parámetros esperados por la URL para ejecutar la consulta.

Este endpoint no requiere parámetros adicionales.

### Campos de respuesta

La respuesta es un array de objetos. Cada elemento describe una entidad del mercado de capitales.

| Campo | Tipo | Descripción |
| --- | --- | --- |
| `code` | `string` | Código identificador de la entidad. |
| `name` | `string` | Razón social o nombre de la entidad. |
| `type` | `string` | Tipo de entidad, por ejemplo `BANK`. |
| `markets` | `array<string>` | Mercados a los que pertenece la entidad. Puede venir vacío. |

```json
[
  {
    "code": "00007",
    "name": "BANCO DE GALICIA Y BUENOS AIRES S.A.U.",
    "type": "BANK",
    "markets": []
  },
  {
    "code": "00011",
    "name": "BANCO DE LA NACION ARGENTINA",
    "type": "BANK",
    "markets": []
  },
  {
    "code": "00014",
    "name": "BANCO DE LA PROVINCIA DE BUENOS AIRES",
    "type": "BANK",
    "markets": []
  }
]
```

## Validar CUIT/CBU o CVU

URL: https://localhost:3000/docs/api/primary-identity/bank-account-ownership
Description: Validacion de correspondencia entre un CUIT y una cuenta bancaria.

Este endpoint valida si un `CUIT` corresponde a la titularidad informada para una cuenta bancaria identificada por `CBU`.

## URL

Permite verificar si el CUIT consultado coincide con la titularidad informada para la cuenta bancaria indicada.

```
GET https://apids.primary.com.ar/pid-ro/v2/api/bankaccounts/{CBU}/ownership/{CUIT}
```

## 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 Identity. |
| `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 |
| --- | --- | --- | --- | --- |
| `CBU` | path | string | Requerido | CBU o CVU de la cuenta bancaria a validar. |
| `CUIT` | path | string | Requerido | CUIT que se desea contrastar contra la titularidad de la cuenta. |

## Campos de respuesta

### Campos de primer nivel

| Campo | Tipo | Descripcion |
| --- | --- | --- |
| `valid` | `boolean` | Indica si existe correspondencia entre el titular informado y la cuenta bancaria consultada. |
| `account` | `object` | Datos resumidos de la cuenta y del titular evaluado en la validacion. |

### Estructura de `account`

| Campo | Tipo | Descripcion |
| --- | --- | --- |
| `type` | `string` | Tipo de cuenta informado por el servicio, por ejemplo `CA`. |
| `currency` | `string` | Moneda asociada a la cuenta bancaria. |
| `bank` | `string` | Nombre de la entidad bancaria asociada a la cuenta. |
| `alias` | `string` | Alias o etiqueta asociada a la cuenta, cuando el servicio la informa. |
| `active` | `boolean` | Indica si la cuenta se encuentra activa. |
| `ownerName` | `string` | Nombre o razon social del titular evaluado. |
| `ownerKeyType` | `string` | Tipo de identificador del titular, por ejemplo `CUIT`. |
| `ownerIsHuman` | `boolean` | Indica si el titular evaluado corresponde a una persona humana. |

## Detalle de cuenta

URL: https://localhost:3000/docs/api/primary-identity/bank-accounts
Description: Informacion de cuentas bancarias a partir de un CBU o CVU.

`BankAccounts` permite consultar informacion de una cuenta bancaria a partir de un identificador `CBU` o `CVU`.

## URL

Devuelve la informacion asociada a la cuenta consultada, incluyendo datos de identificacion bancaria y titularidad cuando el servicio los informa.

```
GET https://apids.primary.com.ar/pid-ro/v2/api/bankaccounts/{CBU}
```

## 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 Identity. |
| `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 |
| --- | --- | --- | --- | --- |
| `CBU` | path | string | Requerido | CBU o CVU de la cuenta bancaria a consultar. |

## Campos de respuesta

### Campos de primer nivel

| Campo | Tipo | Descripcion |
| --- | --- | --- |
| `owners` | `array<object>` | Titulares informados para la cuenta bancaria consultada. |
| `type` | `string` | Tipo de cuenta informado por el servicio, por ejemplo `CA`. |
| `isActive` | `boolean` | Indica si la cuenta se encuentra activa. |
| `currency` | `string` | Moneda de la cuenta bancaria. |
| `label` | `string` | Alias o etiqueta asociada a la cuenta, cuando el servicio la informa. |
| `accountRouting` | `object` | Datos de identificacion de la cuenta bancaria consultada. |
| `bankRouting` | `object` | Datos de identificacion de la entidad bancaria asociada. |

### Estructura de `owners[]`

| Campo | Tipo | Descripcion |
| --- | --- | --- |
| `id` | `string` | Identificador del titular informado, por ejemplo un `CUIT`. |
| `displayName` | `string` | Nombre o razon social del titular. |
| `idType` | `string` | Tipo de identificador del titular, por ejemplo `CUIT`. |
| `isPhysicalPerson` | `boolean` | Indica si el titular informado corresponde a una persona humana. |

### Estructura de `accountRouting`

| Campo | Tipo | Descripcion |
| --- | --- | --- |
| `scheme` | `string` | Tipo de identificador bancario utilizado para la cuenta, por ejemplo `CBU`. |
| `address` | `string` | Valor del identificador bancario de la cuenta consultada. |

### Estructura de `bankRouting`

| Campo | Tipo | Descripcion |
| --- | --- | --- |
| `scheme` | `string` | Tipo de identificador usado para describir la entidad bancaria. |
| `address` | `string` | Nombre o descripcion de la entidad bancaria. |
| `code` | `string` | Codigo de la entidad bancaria informado por el servicio. |

## Detalle de persona

URL: https://localhost:3000/docs/api/primary-identity/entity-data-full
Description: Informacion ampliada de personas humanas o juridicas a partir de un CUIT.

`EntityDataFull` devuelve informacion identificatoria, fiscal, de contacto y padrones asociados a una persona o entidad consultada por CUIT.

## URL

Consolida la informacion principal de identificacion, actividad, impuestos, domicilios, medios de contacto y registros especiales asociados al CUIT consultado.

```
GET https://apids.primary.com.ar/pid-ro/v2/api/EntityDataFull?key={CUIT}
```

## 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 Identity. |
| `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 |
| --- | --- | --- | --- | --- |
| `key` | query | string | Requerido | CUIT de la persona o entidad a consultar. |

## Campos de respuesta

### Campos de primer nivel

| Campo | Tipo | Descripcion |
| --- | --- | --- |
| `naturalKey` | `number \| null` | Identificador numerico interno asociado a la entidad. |
| `keyType` | `string \| null` | Tipo de clave consultada. |
| `documentType` | `string \| null` | Tipo de documento principal. |
| `personType` | `string \| null` | Tipo de persona, por ejemplo humana o juridica. |
| `name` | `string \| null` | Nombre de la persona humana. |
| `lastName` | `string \| null` | Apellido de la persona humana. |
| `documentNumber` | `string \| null` | Numero de documento o CUIT consultado. |
| `birthdate` | `string \| null` | Fecha de nacimiento, cuando aplica. |
| `deathdate` | `string \| null` | Fecha de fallecimiento, cuando aplica. |
| `keyStatus` | `string \| null` | Estado de vigencia de la clave. |
| `legalType` | `string \| null` | Tipo societario o legal. |
| `inscriptionDate` | `string \| null` | Fecha de inscripcion de la entidad. |
| `associatedInactiveKey` | `string \| null` | Clave inactiva asociada, si existe. |
| `mainActivityId` | `number \| null` | Identificador de actividad principal. |
| `mainActivityPeriod` | `number \| null` | Periodo asociado a la actividad principal. |
| `mainActivityDescription` | `string \| null` | Descripcion de la actividad principal. |
| `closeMonth` | `number \| null` | Mes de cierre de ejercicio. |
| `socialContractDate` | `string \| null` | Fecha de contrato social o constitucion. |
| `businessName` | `string \| null` | Razon social o nombre comercial. |
| `gender` | `string \| null` | Genero, cuando aplica. |
| `residenceType` | `string \| null` | Tipo de residencia fiscal o registral. |
| `inscriptionAuthority` | `string \| null` | Organismo de inscripcion. |
| `inscriptionNumber` | `string \| null` | Numero de inscripcion. |
| `nationalEquityPercentage` | `string \| null` | Porcentaje de capital nacional informado. |
| `displayName` | `string \| null` | Nombre formateado para mostrar en interfaz. |
| `taxes` | `array<object>` | Padrones y estados impositivos asociados al CUIT. |
| `taxesConditions` | `array<object>` | Condiciones tributarias por impuesto. |
| `emails` | `array<object>` | Direcciones de correo registradas. |
| `activities` | `array<object>` | Actividades economicas asociadas. |
| `telephones` | `array<object>` | Telefonos registrados. |
| `addresses` | `array<object>` | Domicilios asociados a la entidad. |
| `exclusions` | `array<object>` | Registros de exclusion o certificados vigentes/historicos. |
| `specialRecordEntries` | `array<object>` | Entradas de registros especiales o padrones particulares. |

### Estructura de `taxes[]`

| Campo | Tipo |
| --- | --- |
| `description` | `string \| null` |
| `daysInPeriod` | `string \| null` |
| `taxId` | `number \| null` |
| `period` | `number \| null` |
| `status` | `string \| null` |
| `inscriptionDate` | `string \| null` |
| `estadoImpuesto` | `string \| undefined` |
| `motivo` | `string \| undefined` |

### Estructura de `taxesConditions[]`

| Campo | Tipo |
| --- | --- |
| `taxName` | `string \| null` |
| `taxCondition` | `string \| null` |

### Estructura de `emails[]`

| Campo | Tipo |
| --- | --- |
| `address` | `string \| null` |
| `status` | `string \| null` |
| `addressType` | `string \| null` |

### Estructura de `activities[]`

| Campo | Tipo |
| --- | --- |
| `description` | `string \| null` |
| `periodStart` | `number \| null` |
| `order` | `number \| null` |
| `activityId` | `number \| null` |
| `nomenclator` | `number \| null` |

### Estructura de `telephones[]`

| Campo | Tipo |
| --- | --- |
| `number` | `string \| null` |
| `lineType` | `string \| null` |
| `numberType` | `string \| null` |

### Estructura de `addresses[]`

| Campo | Tipo |
| --- | --- |
| `description` | `string \| null` |
| `zipCode` | `string \| null` |
| `state` | `string \| null` |
| `stateId` | `number \| null` |
| `street` | `string \| null` |
| `number` | `number \| null` |
| `floor` | `string \| null` |
| `block` | `string \| null` |
| `sector` | `string \| null` |
| `tower` | `string \| null` |
| `line1` | `string \| null` |
| `city` | `string \| null` |
| `aditionalDataType` | `string \| null` |
| `localDepartmentOffice` | `string \| null` |
| `addressStatus` | `string \| null` |
| `addressTypeAux` | `string \| null` |

### Estructura de `exclusions[]`

| Campo | Tipo |
| --- | --- |
| `issuer` | `string \| null` |
| `rule` | `string \| null` |
| `ruleName` | `string \| null` |
| `issueDate` | `string \| null` |
| `endDate` | `string \| null` |
| `percentage` | `number \| null` |
| `certificationNumber` | `string \| null` |
| `createdAt` | `string \| null` |
| `fiscalPeriod` | `string \| null` |

### Estructura de `specialRecordEntries[]`

| Campo | Tipo |
| --- | --- |
| `issuer` | `string \| null` |
| `rule` | `string \| null` |
| `ruleName` | `string \| null` |
| `category` | `string \| null` |
| `inclusionPublicationDate` | `string \| null` |
| `recordUpdateTime` | `string \| null` |
| `suspensionPublicationDate` | `string \| null` |
| `suspensionRemovalDate` | `string \| null` |
| `status` | `string \| null` |
| `entityData` | `record<string, string \| number \| null> \| null` |
| `createdAt` | `string \| null` |

## Primary Identity

URL: https://localhost:3000/docs/api/primary-identity
Description: Endpoints para consulta de personas, cuentas bancarias y validacion de titularidad.

Los endpoints de esta seccion comparten la misma raiz de servicio y utilizan una API Key en el header `Ocp-Apim-Subscription-Key`.

## Endpoints documentados

- [Detalle de persona](/docs/api/primary-identity/entity-data-full)
- [Detalle de cuenta](/docs/api/primary-identity/bank-accounts)
- [Validar CUIT/CBU o CVU](/docs/api/primary-identity/bank-account-ownership)

## Header comun

| Header | Valor esperado | Descripcion |
| --- | --- | --- |
| `Ocp-Apim-Subscription-Key` | `<API_KEY>` | API Key asociada a la suscripcion con permisos sobre Primary Identity. |
| `Content-Type` | `application/json` | Header recomendado para las requests de ejemplo. |

---

## Detalle de persona

`EntityDataFull` devuelve informacion identificatoria, fiscal, de contacto y padrones asociados a una persona o entidad consultada por CUIT.

## URL

Consolida la informacion principal de identificacion, actividad, impuestos, domicilios, medios de contacto y registros especiales asociados al CUIT consultado.

```
GET https://apids.primary.com.ar/pid-ro/v2/api/EntityDataFull?key={CUIT}
```

## 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 Identity. |
| `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 |
| --- | --- | --- | --- | --- |
| `key` | query | string | Requerido | CUIT de la persona o entidad a consultar. |

### Campos de respuesta

#### Campos de primer nivel

| Campo | Tipo | Descripcion |
| --- | --- | --- |
| `naturalKey` | `number \| null` | Identificador numerico interno asociado a la entidad. |
| `keyType` | `string \| null` | Tipo de clave consultada. |
| `documentType` | `string \| null` | Tipo de documento principal. |
| `personType` | `string \| null` | Tipo de persona, por ejemplo humana o juridica. |
| `name` | `string \| null` | Nombre de la persona humana. |
| `lastName` | `string \| null` | Apellido de la persona humana. |
| `documentNumber` | `string \| null` | Numero de documento o CUIT consultado. |
| `birthdate` | `string \| null` | Fecha de nacimiento, cuando aplica. |
| `deathdate` | `string \| null` | Fecha de fallecimiento, cuando aplica. |
| `keyStatus` | `string \| null` | Estado de vigencia de la clave. |
| `legalType` | `string \| null` | Tipo societario o legal. |
| `inscriptionDate` | `string \| null` | Fecha de inscripcion de la entidad. |
| `associatedInactiveKey` | `string \| null` | Clave inactiva asociada, si existe. |
| `mainActivityId` | `number \| null` | Identificador de actividad principal. |
| `mainActivityPeriod` | `number \| null` | Periodo asociado a la actividad principal. |
| `mainActivityDescription` | `string \| null` | Descripcion de la actividad principal. |
| `closeMonth` | `number \| null` | Mes de cierre de ejercicio. |
| `socialContractDate` | `string \| null` | Fecha de contrato social o constitucion. |
| `businessName` | `string \| null` | Razon social o nombre comercial. |
| `gender` | `string \| null` | Genero, cuando aplica. |
| `residenceType` | `string \| null` | Tipo de residencia fiscal o registral. |
| `inscriptionAuthority` | `string \| null` | Organismo de inscripcion. |
| `inscriptionNumber` | `string \| null` | Numero de inscripcion. |
| `nationalEquityPercentage` | `string \| null` | Porcentaje de capital nacional informado. |
| `displayName` | `string \| null` | Nombre formateado para mostrar en interfaz. |
| `taxes` | `array<object>` | Padrones y estados impositivos asociados al CUIT. |
| `taxesConditions` | `array<object>` | Condiciones tributarias por impuesto. |
| `emails` | `array<object>` | Direcciones de correo registradas. |
| `activities` | `array<object>` | Actividades economicas asociadas. |
| `telephones` | `array<object>` | Telefonos registrados. |
| `addresses` | `array<object>` | Domicilios asociados a la entidad. |
| `exclusions` | `array<object>` | Registros de exclusion o certificados vigentes/historicos. |
| `specialRecordEntries` | `array<object>` | Entradas de registros especiales o padrones particulares. |

#### Estructura de `taxes[]`

| Campo | Tipo |
| --- | --- |
| `description` | `string \| null` |
| `daysInPeriod` | `string \| null` |
| `taxId` | `number \| null` |
| `period` | `number \| null` |
| `status` | `string \| null` |
| `inscriptionDate` | `string \| null` |
| `estadoImpuesto` | `string \| undefined` |
| `motivo` | `string \| undefined` |

#### Estructura de `taxesConditions[]`

| Campo | Tipo |
| --- | --- |
| `taxName` | `string \| null` |
| `taxCondition` | `string \| null` |

#### Estructura de `emails[]`

| Campo | Tipo |
| --- | --- |
| `address` | `string \| null` |
| `status` | `string \| null` |
| `addressType` | `string \| null` |

#### Estructura de `activities[]`

| Campo | Tipo |
| --- | --- |
| `description` | `string \| null` |
| `periodStart` | `number \| null` |
| `order` | `number \| null` |
| `activityId` | `number \| null` |
| `nomenclator` | `number \| null` |

#### Estructura de `telephones[]`

| Campo | Tipo |
| --- | --- |
| `number` | `string \| null` |
| `lineType` | `string \| null` |
| `numberType` | `string \| null` |

#### Estructura de `addresses[]`

| Campo | Tipo |
| --- | --- |
| `description` | `string \| null` |
| `zipCode` | `string \| null` |
| `state` | `string \| null` |
| `stateId` | `number \| null` |
| `street` | `string \| null` |
| `number` | `number \| null` |
| `floor` | `string \| null` |
| `block` | `string \| null` |
| `sector` | `string \| null` |
| `tower` | `string \| null` |
| `line1` | `string \| null` |
| `city` | `string \| null` |
| `aditionalDataType` | `string \| null` |
| `localDepartmentOffice` | `string \| null` |
| `addressStatus` | `string \| null` |
| `addressTypeAux` | `string \| null` |

#### Estructura de `exclusions[]`

| Campo | Tipo |
| --- | --- |
| `issuer` | `string \| null` |
| `rule` | `string \| null` |
| `ruleName` | `string \| null` |
| `issueDate` | `string \| null` |
| `endDate` | `string \| null` |
| `percentage` | `number \| null` |
| `certificationNumber` | `string \| null` |
| `createdAt` | `string \| null` |
| `fiscalPeriod` | `string \| null` |

#### Estructura de `specialRecordEntries[]`

| Campo | Tipo |
| --- | --- |
| `issuer` | `string \| null` |
| `rule` | `string \| null` |
| `ruleName` | `string \| null` |
| `category` | `string \| null` |
| `inclusionPublicationDate` | `string \| null` |
| `recordUpdateTime` | `string \| null` |
| `suspensionPublicationDate` | `string \| null` |
| `suspensionRemovalDate` | `string \| null` |
| `status` | `string \| null` |
| `entityData` | `record<string, string \| number \| null> \| null` |
| `createdAt` | `string \| null` |

---

## Detalle de cuenta

`BankAccounts` permite consultar informacion de una cuenta bancaria a partir de un identificador `CBU` o `CVU`.

## URL

Devuelve la informacion asociada a la cuenta consultada, incluyendo datos de identificacion bancaria y titularidad cuando el servicio los informa.

```
GET https://apids.primary.com.ar/pid-ro/v2/api/bankaccounts/{CBU}
```

## 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 Identity. |
| `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 |
| --- | --- | --- | --- | --- |
| `CBU` | path | string | Requerido | CBU o CVU de la cuenta bancaria a consultar. |

### Campos de respuesta

#### Campos de primer nivel

| Campo | Tipo | Descripcion |
| --- | --- | --- |
| `owners` | `array<object>` | Titulares informados para la cuenta bancaria consultada. |
| `type` | `string` | Tipo de cuenta informado por el servicio, por ejemplo `CA`. |
| `isActive` | `boolean` | Indica si la cuenta se encuentra activa. |
| `currency` | `string` | Moneda de la cuenta bancaria. |
| `label` | `string` | Alias o etiqueta asociada a la cuenta, cuando el servicio la informa. |
| `accountRouting` | `object` | Datos de identificacion de la cuenta bancaria consultada. |
| `bankRouting` | `object` | Datos de identificacion de la entidad bancaria asociada. |

#### Estructura de `owners[]`

| Campo | Tipo | Descripcion |
| --- | --- | --- |
| `id` | `string` | Identificador del titular informado, por ejemplo un `CUIT`. |
| `displayName` | `string` | Nombre o razon social del titular. |
| `idType` | `string` | Tipo de identificador del titular, por ejemplo `CUIT`. |
| `isPhysicalPerson` | `boolean` | Indica si el titular informado corresponde a una persona humana. |

#### Estructura de `accountRouting`

| Campo | Tipo | Descripcion |
| --- | --- | --- |
| `scheme` | `string` | Tipo de identificador bancario utilizado para la cuenta, por ejemplo `CBU`. |
| `address` | `string` | Valor del identificador bancario de la cuenta consultada. |

#### Estructura de `bankRouting`

| Campo | Tipo | Descripcion |
| --- | --- | --- |
| `scheme` | `string` | Tipo de identificador usado para describir la entidad bancaria. |
| `address` | `string` | Nombre o descripcion de la entidad bancaria. |
| `code` | `string` | Codigo de la entidad bancaria informado por el servicio. |

---

## Validar CUIT/CBU o CVU

Este endpoint valida si un `CUIT` corresponde a la titularidad informada para una cuenta bancaria identificada por `CBU`.

## URL

Permite verificar si el CUIT consultado coincide con la titularidad informada para la cuenta bancaria indicada.

```
GET https://apids.primary.com.ar/pid-ro/v2/api/bankaccounts/{CBU}/ownership/{CUIT}
```

## 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 Identity. |
| `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 |
| --- | --- | --- | --- | --- |
| `CBU` | path | string | Requerido | CBU o CVU de la cuenta bancaria a validar. |
| `CUIT` | path | string | Requerido | CUIT que se desea contrastar contra la titularidad de la cuenta. |

### Campos de respuesta

#### Campos de primer nivel

| Campo | Tipo | Descripcion |
| --- | --- | --- |
| `valid` | `boolean` | Indica si existe correspondencia entre el titular informado y la cuenta bancaria consultada. |
| `account` | `object` | Datos resumidos de la cuenta y del titular evaluado en la validacion. |

#### Estructura de `account`

| Campo | Tipo | Descripcion |
| --- | --- | --- |
| `type` | `string` | Tipo de cuenta informado por el servicio, por ejemplo `CA`. |
| `currency` | `string` | Moneda asociada a la cuenta bancaria. |
| `bank` | `string` | Nombre de la entidad bancaria asociada a la cuenta. |
| `alias` | `string` | Alias o etiqueta asociada a la cuenta, cuando el servicio la informa. |
| `active` | `boolean` | Indica si la cuenta se encuentra activa. |
| `ownerName` | `string` | Nombre o razon social del titular evaluado. |
| `ownerKeyType` | `string` | Tipo de identificador del titular, por ejemplo `CUIT`. |
| `ownerIsHuman` | `boolean` | Indica si el titular evaluado corresponde a una persona humana. |

## Primary Prices

URL: https://localhost:3000/docs/api/primary-prices
Description: 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](/docs/api/primary-prices/prices-list): 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/InstrumentPrices
```

## 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 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. |

### 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 `$skip` en bloques de 300 registros. Los operadores `$top` y `$expand` no están soportados.

## Listado de precios

URL: https://localhost:3000/docs/api/primary-prices/prices-list
Description: Obtiene el listado de precios paginado con soporte de operadores OData.

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/InstrumentPrices
```

## 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 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. |

## 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 `$skip` en bloques de 300 registros. Los operadores `$top` y `$expand` no están soportados.

## Diccionario de campos

URL: https://localhost:3000/docs/api/primary-reference/fields-dictionary
Description: Nombre de negocio y tipo de cada campo de instrumentos, por tipo de instrumento.

El diccionario documenta un conjunto distinto de campos para cada tipo de instrumento. Seleccione un tipo para consultar los campos incluidos, con su nombre de negocio y su tipo de valor. Los valores llegan serializados como texto, incluso los números y los booleanos.

<InstrumentFieldsDictionary />

## Primary Reference

URL: https://localhost:3000/docs/api/primary-reference
Description: 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](/docs/api/primary-reference/fields-dictionary): nombre de negocio de cada campo, por tipo de instrumento.
- [Instrumentos](/docs/api/primary-reference/instruments-report): listado de instrumentos desglosado por plazo de liquidación y moneda.
- [Instrumentos consolidados](/docs/api/primary-reference/instruments-consolidated): listado de instrumentos agrupado por ISIN.
- [Novedades](/docs/api/primary-reference/news): 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-odata
```

## 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 |
| --- | --- | --- | --- | --- |
| `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. |

### 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](/docs/api/primary-reference/fields-dictionary) 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-odata
```

## 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 |
| --- | --- | --- | --- | --- |
| `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. |

### 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](/docs/api/primary-reference/fields-dictionary) 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. |

### 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](/docs/api/primary-reference/fields-dictionary) para ver, por cada tipo, los campos que publica con su nombre de negocio.

## Instrumentos consolidados

URL: https://localhost:3000/docs/api/primary-reference/instruments-consolidated
Description: 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-odata
```

## 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 |
| --- | --- | --- | --- | --- |
| `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. |

## 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](/docs/api/primary-reference/fields-dictionary) para ver, por cada tipo, los campos que publica con su nombre de negocio.

## Instrumentos

URL: https://localhost:3000/docs/api/primary-reference/instruments-report
Description: 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-odata
```

## 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 |
| --- | --- | --- | --- | --- |
| `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. |

## 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](/docs/api/primary-reference/fields-dictionary) para ver, por cada tipo, los campos que publica con su nombre de negocio.

## Novedades

URL: https://localhost:3000/docs/api/primary-reference/news
Description: Novedades de instrumentos por operación (altas, bajas, modificaciones).

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. |

## 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](/docs/api/primary-reference/fields-dictionary) para ver, por cada tipo, los campos que publica con su nombre de negocio.

> Los valores admitidos para `operation` son `inserts` (altas), `updates` (modificaciones) y `deletes` (bajas). El parámetro `dateFrom` define el límite inferior temporal de la consulta.

## Introducción

URL: https://localhost:3000/docs
Description: Documentación funcional y técnica de las APIs y módulos principales.

Este sitio concentra la documentación funcional y técnica del proyecto.

## Secciones disponibles

- [API](/docs/api)
- [Primary Identity](/docs/api/primary-identity)
- [Primary Reference](/docs/api/primary-reference)
- [Primary Prices](/docs/api/primary-prices)
- [Primary Entity](/docs/api/primary-entity)

## En esta sección

La documentación de cada colección de API incluye:

- descripción funcional de cada endpoint;
- URL completa con sus parámetros;
- headers requeridos;
- ejemplos de respuesta JSON;
- una prueba interactiva con API Key.

### Primary Identity

Endpoints para consulta de personas y cuentas bancarias:

- [Detalle de persona](/docs/api/primary-identity/entity-data-full): información identificatoria, fiscal, de contacto y padrones asociados a un CUIT.
- [Detalle de cuenta](/docs/api/primary-identity/bank-accounts): información de una cuenta bancaria a partir de su CBU o CVU.
- [Validar CUIT/CBU o CVU](/docs/api/primary-identity/bank-account-ownership): validación de correspondencia entre un CUIT y la titularidad de una cuenta bancaria.

### Primary Reference

Endpoints para consulta de instrumentos de referencia y novedades:

- [Diccionario de campos](/docs/api/primary-reference/fields-dictionary): nombre de negocio de cada campo de instrumentos, por tipo de instrumento.
- [Reporte de instrumentos](/docs/api/primary-reference/instruments-report): listado paginado de instrumentos asociados a un schema, con soporte de consultas OData (`$filter`, `$orderby`, `$skip`, `$top`).
- [Consolidado de instrumentos](/docs/api/primary-reference/instruments-consolidated): vista consolidada de instrumentos asociados a un schema, con los mismos parámetros OData que el reporte de instrumentos.
- [Novedades](/docs/api/primary-reference/news): novedades de instrumentos (altas, bajas y modificaciones) a partir de una fecha indicada mediante `dateFrom`, con filtros OData adicionales.

### Primary Prices

Endpoints para consulta de precios de instrumentos:

- [Listado de precios](/docs/api/primary-prices/prices-list): listado paginado de a 300 registros con soporte OData (`$filter`, `$orderby`, `$skip`; `$top` y `$expand` no admitidos).

### Primary Entity

Endpoints para consulta de entidades del mercado de capitales:

- [Listado de entidades](/docs/api/primary-entity/entities-list): catálogo completo de entidades con su código, nombre, tipo y mercados asociados.