Get account balances

Obtiene la posición monetaria de una cuenta comitente en distintas monedas y plazos.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Consultá la posición monetaria de una cuenta comitente en las distintas monedas y plazos disponibles.

Antes de empezar

  1. Tené a mano el investment_account_id de la cuenta comitente que querés consultar.
  2. Usá filtros como concepts, currencies o terms si querés limitar la consulta.
  3. Definí position_discriminator_bcra=false si querés ver los dólares sin discriminar entre disponibles y bloqueados.
  4. Definí include_remunerated_balance=true si querés incluir el saldo remunerado cuando la cuenta lo tenga activo.

Cómo consultar la posición monetaria

GET /api/portfolio/account-balances/{investment_account_id}

Consultar con discriminación BCRA

GET /api/portfolio/account-balances/{investment_account_id}?position_discriminator_bcra=true

Consultar por plazo

GET /api/portfolio/account-balances/{investment_account_id}?terms=t0

Parámetros

Path parameters

ParámetroTipoRequeridoDescripción
investment_account_idintegerSíIdentificador de la cuenta comitente en ApiBroker.

Query parameters

ParámetroTipoRequeridoDefaultDescripción
conceptsstringNo—Conceptos a incluir en la posición monetaria.
currenciesstringNo—Monedas a incluir en la consulta.
termsstringNo—Plazos a consultar. Si no lo enviás, se devuelven todos los disponibles.
position_discriminator_bcrabooleanNotrueSi enviás false, la respuesta devuelve el total en dólares sin discriminar entre montos disponibles y bloqueados.
include_remunerated_balancebooleanNofalseSi enviás true y la cuenta remunera saldo, la respuesta puede incluir el detalle del saldo remunerado.

Qué devuelve este endpoint

La respuesta devuelve un arreglo items. Cada elemento representa la posición monetaria de una cuenta comitente.

Cada elemento puede incluir:

  • investment_account_id: identificador de la cuenta consultada
  • available_amount: posición monetaria disponible agrupada por mercado, moneda y plazo
  • bcra_blocked: posición monetaria bloqueada según el criterio BCRA
  • remunerated_balance: saldo remunerado, si fue solicitado y la cuenta lo tiene activo

Estructura de available_amount y bcra_blocked

Estos nodos devuelven un objeto anidado con esta lógica:

  • primer nivel: market_type
  • segundo nivel: currency_id
  • tercer nivel: plazo (t0, t1, t2)
  • último nivel: amount

Respuesta esperada

{
  "items": [
    {
      "investment_account_id": 74659,
      "available_amount": {
        "stock_market": {
          "ARS": {
            "t0": {
              "amount": 1000
            },
            "t1": {
              "amount": 1000
            },
            "t2": {
              "amount": 1000
            }
          },
          "USD": {
            "t0": {
              "amount": 250
            }
          }
        }
      },
      "bcra_blocked": {
        "stock_market": {
          "USD": {
            "t0": {
              "amount": 100
            }
          }
        }
      }
    }
  ]
}

Sobre position_discriminator_bcra

  • Si position_discriminator_bcra=true, la respuesta puede discriminar dólares disponibles y bloqueados.
  • Si position_discriminator_bcra=false, la posición en dólares se devuelve consolidada sin separar disponibles y bloqueados.

Sobre include_remunerated_balance

Cuando enviás include_remunerated_balance=true y la cuenta tiene remuneración activa, la respuesta puede incluir un nodo como este:

{
  "remunerated_balance": {
    "ARS": {
      "instrument_type": "CURRENCY",
      "amount": 0,
      "available_amount": 0,
      "used_overdraft": 0,
      "market_type": "stock_market"
    }
  }
}

Cuándo usar este endpoint

Este endpoint es útil cuando necesitás:

  • consultar la posición monetaria por moneda y plazo
  • revisar fondos disponibles o bloqueados
  • mostrar saldo remunerado cuando aplique

Errores frecuentes

  • 422 Validation Error: alguno de los parámetros tiene un formato inválido.

Siguiente paso

Si además necesitás consultar tenencias o el estado de cuenta completo, continuá con GET /api/portfolio/holdings/{investment_account_id} o GET /api/portfolio/account-statements/{investment_account_id}.

Path Params
integer
required
Query Params
string
string
string
boolean
Defaults to true
boolean
Defaults to false
Responses

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json