Obtener posición en OMS
Devuelve la posición actual (tenencias) de una cuenta determinada en el Order Management System (OMS), agrupada por período de liquidación y símbolo.
GET
/v1/broker/operations/position/orders/{account-id}Request
Headers
| Campo | Tipo | Requerido | Descripción |
|---|---|---|---|
Authorization | string | Sí | Token de acceso en formato Bearer ACCESS_TOKEN |
Path Parameters
| Campo | Tipo | Requerido | Descripción |
|---|---|---|---|
account-id | integer | Sí | Número de cuenta para el cual se obtiene la posición en OMS. |
No aplica: Query Parameters, Body.
Response
2XX Éxito
Forma de la respuesta
positions_by_settlement es un objeto indexado por período de liquidación (T0, T1, T2, T3). Cada período de liquidación contiene un objeto indexado por símbolo del instrumento, cuyo valor es la posición para ese símbolo en ese período de liquidación.
| Campo | Tipo | Descripción |
|---|---|---|
account_number | integer | Número de cuenta al que pertenece la posición. |
positions_by_settlement | object | Posiciones agrupadas por período de liquidación. Las claves son T0, T1, T2 y T3. |
positions_by_settlement.{settlement_period} | object | Objeto indexado por símbolo del instrumento para el período de liquidación dado. |
positions_by_settlement.{settlement_period}.{symbol}.settlementType | string | Período de liquidación al que pertenece esta posición. Valores posibles: T0, T1, T2, T3. |
positions_by_settlement.{settlement_period}.{symbol}.symbol | string | Ticker del instrumento. |
positions_by_settlement.{settlement_period}.{symbol}.total | number | Cantidad total en tenencia. |
positions_by_settlement.{settlement_period}.{symbol}.unavailable | number | Cantidad actualmente no disponible para operar (por ejemplo, pendiente de liquidación o bloqueada). |
positions_by_settlement.{settlement_period}.{symbol}.available | number | Cantidad disponible para operar. |
positions_by_settlement.{settlement_period}.{symbol}.pending_sell_quantity | number | Cantidad involucrada en órdenes de venta pendientes que aún no fueron ejecutadas. |
Códigos de error
| Status | Descripción |
|---|---|
400 | Bad Request — el número de cuenta es inválido |
401 | Unauthorized — token de acceso inválido o faltante |
403 | Forbidden — el token no tiene permiso para acceder a este recurso |
500 | Internal Server Error |
Estructura del error:
{
"code": "invalid_request",
"description": "Invalid account number: 70104"
}
Ejemplo de código
- cURL
- JavaScript
- Python
- Node.js
curl -X GET https://b2b.allaria.cloud/v1/broker/operations/position/orders/70104 \
-H "Authorization: Bearer ACCESS_TOKEN"
const accountId = 70104;
const response = await fetch(
`https://b2b.allaria.cloud/v1/broker/operations/position/orders/${accountId}`,
{
method: 'GET',
headers: { 'Authorization': 'Bearer ACCESS_TOKEN' }
}
);
const data = await response.json();
console.log(data);
import requests
account_id = 70104
response = requests.get(
f'https://b2b.allaria.cloud/v1/broker/operations/position/orders/{account_id}',
headers={ 'Authorization': 'Bearer ACCESS_TOKEN' }
)
data = response.json()
print(data)
const axios = require('axios');
const accountId = 70104;
const response = await axios.get(
`https://b2b.allaria.cloud/v1/broker/operations/position/orders/${accountId}`,
{ headers: { Authorization: 'Bearer ACCESS_TOKEN' } }
);
console.log(response.data);
2XX Éxito
{
"account_number": 70104,
"positions_by_settlement": {
"T0": {
"AL30": {
"settlementType": "T0",
"symbol": "AL30",
"total": 1000.00,
"unavailable": 0.00,
"available": 1000.00,
"pending_sell_quantity": 0.00
}
},
"T1": {
"GD30": {
"settlementType": "T1",
"symbol": "GD30",
"total": 500.00,
"unavailable": 200.00,
"available": 300.00,
"pending_sell_quantity": 100.00
}
}
}
}