Posición del comitente

Retorna la posición de un comitente de Allaria+, es decir, los activos que tiene en cartera a una fecha determinada.

GET/v1/bymas/allariamas/positions

Request

Headers

Campo	Tipo	Requerido	Descripción
Authorization	string	Sí	Token de acceso en formato Bearer ACCESS_TOKEN

No aplica: Path Parameters, Body.

Query Parameters

Campo	Tipo	Requerido	Descripción
account-id	integer	Sí	Número de cuenta del comitente
asset	string	No	Filtra por abreviatura del activo (e.g. GGAL, AL30)
date	string (date)	No	Fecha de la posición en formato YYYY-MM-DD. Por defecto retorna la posición al día actual
grouped-by	string	No	Agrupación de resultados. Valores permitidos: NONE, ASSET_TYPE, CURRENCY. Valor por defecto: NONE.
company	string	No	Filtra por empresa
group-by-sub-category-description	boolean	No	Agrupa por descripción de subcategoría. Valor por defecto: false.
group-by-sub-category-and-description	boolean	No	Agrupa por subcategoría y descripción. Valor por defecto: false.
page	integer	No	Número de página (base 0). Valor por defecto: 0.
count	integer	No	Cantidad de resultados por página. Mínimo: 1, máximo: 100. Valor por defecto: 50.

Response

2XX Éxito

Status: 200 OK

El response es un objeto JSON cuya estructura varía según los parámetros de agrupación utilizados. Sin agrupación, retorna los activos en cartera del comitente con sus cantidades y valuaciones.

Códigos de error

Status	Descripción
400	Bad Request — parámetros inválidos o faltantes
403	Forbidden — el token no tiene permisos para acceder a este recurso
404	Not Found — el comitente no existe
422	Unprocessable Entity — los parámetros son válidos pero no pueden procesarse
500	Internal Server Error — error interno del servidor

Estructura del error:

{
  "timestamp": "2024-01-15T10:30:00Z",
  "status": 400,
  "error": "Bad Request",
  "message": "account-id is required",
  "code": "VALIDATION_ERROR",
  "path": "/v1/bymas/allariamas/positions"
}

Ejemplo de código

cURL

curl -X GET "https://b2b.allaria.dev/v1/bymas/allariamas/positions?account-id=12345" \
  -H "Authorization: Bearer ACCESS_TOKEN"

JavaScript

const params = new URLSearchParams({
  'account-id': 12345
});

const response = await fetch(`https://b2b.allaria.dev/v1/bymas/allariamas/positions?${params}`, {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer ACCESS_TOKEN'
  }
});

const data = await response.json();
console.log(data);

Python

import requests

response = requests.get(
  'https://b2b.allaria.dev/v1/bymas/allariamas/positions',
  headers={
    'Authorization': 'Bearer ACCESS_TOKEN'
  },
  params={
    'account-id': 12345
  }
)

data = response.json()
print(data)

Node.js

const axios = require('axios');

const response = await axios.get('https://b2b.allaria.dev/v1/bymas/allariamas/positions', {
  headers: {
    Authorization: 'Bearer ACCESS_TOKEN'
  },
  params: {
    'account-id': 12345
  }
});

console.log(response.data);

2XX Éxito

{
  "content": [
    {
      "asset": "AL30",
      "quantity": 1000,
      "currency": "USD",
      "market_value": 850.00
    }
  ],
  "totalElements": 1,
  "totalPages": 1,
  "page": 0
}