INSTRUMENTS

Servicio por el cual se pueden consultar los distintos instrumentos de mercado y fci.

GET/ instruments/market

Realiza una consulta para obtener información detallada sobre un instrumento específico utilizando su "market_instrument_id".

• URL del Endpoint: GET/{{baseUrl}}/api/instruments/market/{market_instrument_id}

Parámetros de Ruta:

• market_instrument_id (pathParam): identificador único del instrumento.

Campo	Tipo	Descripción
market_instrument_id	int	Código identificador del instrumento.
ticker	str	Abreviatura para identificar el instrumento en el mercado.
currency_id	str	Master-tables: currencies.
instrument_type	str	Tipo del instrumento.
instrument_description	str	Descripción del instrumento.
selling_enabled	bool	Indicador si el instrumento está disponible para la venta.
buying_enabled	bool	Indicador si el instrumento está disponible para la compra.
base_instrument_id	int	Código identificador del instrumento base.

Response:

{
  "items": [
    {
      "market_instrument_id": "int",
      "ticker": "str",
      "currency_id": "str",
      "instrument_type": "str",
      "instrument_description": "str",
      "market_index": [
        "str"
      ],
      "selling_enabled": "bool",
      "buying_enabled": "bool",
      "base_instrument_id": "int"
    }
  ]
}

Endpoint para obtener información detallada de todos los instrumentos que pueden comercializar.

• URL del Endpoint: GET/{{baseUrl}}/api/instruments/market/all

Response:

{
  "items": [
    {
      "market_instrument_id": "int",
      "ticker": "str",
      "currency_id": "str",
      "instrument_type": "str",
      "instrument_description": "str",
      "market_index": [
        "str"
      ],
      "selling_enabled": "bool",
      "buying_enabled": "bool",
      "base_instrument_id": "int"
    },
    {
      "market_instrument_id": "int",
      "ticker": "str",
      "currency_id": "str",
      "instrument_type": "str",
      "instrument_description": "str",
      "market_index": [
        "str"
      ],
      "selling_enabled": "bool",
      "buying_enabled": "bool",
      "base_instrument_id": "int"
    }
  ],
  "total": "int",
  "page": "int",
  "size": "int"
}

GET/ instruments/mutual-funds

Realiza una consulta para obtener información detallada sobre un fci específico utilizando su "mutual_fund_id".

• URL del Endpoint: GET/{{baseUrl}}/api/instruments/mutual-funds/{mutual_fund_id}

Parámetros de Ruta:

• mutual_fund_id (pathParam): identificador único del fci.

Endpoint para obtener información detallada de todos los fci que pueden comercializar.

• URL del Endpoint: GET/{{baseUrl}}/api/instruments/mutual-funds/all

Campo	Tipo	Descripción
admin_agent	str	Agente administrador del FCI.
cafci_id	int	Identificador único del FCI según la Comisión Nacional de Valores.
clazz	str	Clase o tipo del FCI.
currency_id	str	Master-tables: currencies.
custody_agent	str	Entidad responsable de la custodia de los activos del fondo.
mutual_fund_id	int	Código del instrumento de FCI.
name	str	Nombre del fondo de inversión.
objective	str	Objetivo del fondo de inversión.
only_natural_person	bool	Indica si el fondo está disponible solo para personas físicas (True) o también para personas jurídicas (False).
instrument_description	str	Descripción del FCI.
profile	str	Perfil del fondo de inversión.
redemption_enabled	bool	Indica si el rescate del fondo está habilitado.
redemption_period	int	Período de tiempo en días para el rescate.
strategy	str	Estrategia de inversión del fondo.
subscription_enabled	bool	Indica si la suscripción del fondo está habilitada.

Response de un fci específico:

{
    "items": [
        {
            "admin_agent": "str",
            "cafci_id": "int",
            "clazz": "str",
            "currency_id": "str",
            "custody_agent": "str",
            "mutual_fund_id": "int",
            "name": "str",
            "objective": "str",
            "only_natural_person": "bool",
            "instrument_description": "str",
            "profile": "str",
            "redemption_enabled": "bool",
            "redemption_period": "int",
            "strategy": "str",
            "subscription_enabled": "bool"
        }
    ]
}

Response de todos los fci que pueden comercializar:

{
  "items": [
    {
      "mutual_fund_id": "int",
      "name": "str",
      "clazz": "str",
      "currency_id": "str",
      "profile": "str",
      "objective": "str",
      "strategy": "str",
      "redemption_period": "int",
      "cafci_id": "int",
      "admin_agent": "str",
      "custody_agent": "str",
      "instrument_description": "str",
      "only_natural_person": "bool",
      "subscription_enabled": "bool",
      "redemption_enabled": "bool"
    },
    {
      "mutual_fund_id": "int",
      "name": "str",
      "clazz": "str",
      "currency_id": "str",
      "profile": "str",
      "objective": "str",
      "strategy": "str",
      "redemption_period": "int",
      "cafci_id": "int",
      "admin_agent": "str",
      "custody_agent": "str",
      "instrument_description": "str",
      "only_natural_person": "bool",
      "subscription_enabled": "bool",
      "redemption_enabled": "bool"
    }
  ],
  "total": "int",
  "page": "int",
  "size": "int"
}