Obtener eventos de posición para indicadores del gráfico agrupados por velas

GET/positions/{accountId}/{asset}/chart-events/buckets

Obtener eventos de posición para indicadores del gráfico agrupados por velasTrading

Eventos de posición de la cuenta en un mercado agrupados por velas de la resolución solicitada, la vela más antigua primero.

Las velas se alinean de la misma manera en que lo hace el datafeed: una vela comienza en un múltiplo de la resolución desde la época unix, una diaria a medianoche UTC.
Una vela se incluye cuando su inicio se encuentra dentro de [from, to]; la distancia entre from y to no puede exceder 350 velas.
Las velas sin eventos se omiten.
Cada vela tiene un lado buy (aumentos de largos, disminuciones de cortos, cierres y liquidaciones) y un lado sell (aumentos de cortos, disminuciones de largos, cierres y liquidaciones). Un lado contiene hasta 5 eventos más recientes, primero los más nuevos, y el número de todos sus eventos en la vela.
Solo se cuentan los aumentos, cierres, cierres forzosos y liquidaciones; los cambios de financiación y margen no son eventos del gráfico.
Limitado a la fase en la que se encuentra actualmente la cuenta.

URL base https://api.upscale.trade

Autorización

bearerhttp · bearerobligatorio

Clave de API personal, con el prefijo usk_.

Parámetros

Ruta

accountIdstring · uuidobligatorio

Identificador de la cuenta del trader. Debe pertenecer al solicitante.

pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$

Ejemplo: 00000000-0000-4000-8000-000000000000

assetstringobligatorio

Ticker del activo base del mercado, tal como lo devuelve GET /v2/markets.

minLength: 1

Ejemplo: BTC

Consulta

resolutionstring · enumobligatorio

Resolución de velas para agrupar eventos, mismos valores que el endpoint /history del datafeed.

Permitido: "1" "5" "15" "30" "60" "240" "1D"

Ejemplo: 60

fromintegerobligatorio

Comienzo de la primera vela, marca de tiempo unix en segundos (inclusive).

minimum: 0
maximum: 9007199254740991

Ejemplo: 1767225600

tointegerobligatorio

Comienzo de la última vela, marca de tiempo unix en segundos (inclusive).

minimum: 0
maximum: 9007199254740991

Ejemplo: 1768482000

Ejemplos

curl --request GET 'https://api.upscale.trade/positions/{accountId}/{asset}/chart-events/buckets' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_API_KEY'

const response = await fetch("https://api.upscale.trade/positions/{accountId}/{asset}/chart-events/buckets", {
  method: "GET",
  headers: {
    "Accept": "application/json",
    "Authorization": "Bearer YOUR_API_KEY"
  },
});
console.log(response.status, await response.text());

import requests
 
response = requests.request(
    "GET",
    "https://api.upscale.trade/positions/{accountId}/{asset}/chart-events/buckets",
    headers={"Accept":"application/json","Authorization":"Bearer YOUR_API_KEY"},
    timeout=30,
)
print(response.status_code, response.text)

Respuestas

401

No autorizado

403

La cuenta pertenece a otro usuario (account_access_denied), o la solicitud se autentica con una clave de API mientras api_trading está deshabilitado en la cuenta (api_trading_not_enabled).

404

No hay ninguna cuenta con este identificador, o no hay ningún mercado para este ticker.

429

Se superó el límite de velocidad de la clave de API (api_key_rate_limit_exceeded). Retry-After indica cuándo volver; el cuerpo incluye el bucket (read / write), la ventana que se activó, su límite y retryAt.

defaultRespuestaapplication/json

Array de ChartEventBucketResponse

timenumberobligatorio

Comienzo de la vela, marca de tiempo unix en segundos.

Ejemplo: 1767225600

buyobjectobligatorio

Lado de compra: aumentos de posiciones largas y disminuciones, cierres y liquidaciones de posiciones cortas.

Objeto · 2 campos

totalCountnumberobligatorio

Número de todos los eventos de este lado en la vela.

Ejemplo: 12

eventsobject[]obligatorio

Hasta los 5 eventos más recientes de este lado en la vela, los más recientes primero.

Elementos del array · object

assetstringobligatorio

Ticker del activo base del mercado en el que ocurrió el evento.

Ejemplo: BTC

directionstring · enumobligatorio

Dirección de la posición a la que pertenece el evento.

Permitido: "long" "short"

Ejemplo: long

eventNamestring · enumobligatorio

Qué representa el marcador: open para el primer aumento de una posición, increase para los posteriores, decrease para un cierre parcial, close para un cierre total y liquidation para una liquidación.

Permitido: "open" "increase" "decrease" "close" "liquidation"

Ejemplo: open

executedAtnumberobligatorio

Cuándo ocurrió el evento, marca de tiempo unix en segundos.

Ejemplo: 1767225599

pricestring · int32obligatorio

Precio al que se ejecutó el evento, fp9 en bruto — cotización intercambiada sobre base intercambiada.

pattern: ^(?:-?[1-9][0-9]*|0)$

Ejemplo: 1000000000

sizestring · int32obligatorio

Tamaño absoluto que movió el evento, en unidades del activo base, fp9 en bruto.

pattern: ^(?:-?[1-9][0-9]*|0)$

Ejemplo: 1000000000

Ver ejemplo

[
  {
    "asset": "BTC",
    "direction": "long",
    "eventName": "open",
    "executedAt": 1767225599,
    "price": "1000000000",
    "size": "1000000000"
  }
]

Ver ejemplo

{
  "totalCount": 12,
  "events": [
    {
      "asset": "BTC",
      "direction": "long",
      "eventName": "open",
      "executedAt": 1767225599,
      "price": "1000000000",
      "size": "1000000000"
    }
  ]
}

sellobjectobligatorio

Lado de venta: aumentos de posiciones cortas y disminuciones, cierres y liquidaciones de posiciones largas.

Objeto · 2 campos

totalCountnumberobligatorio

Número de todos los eventos de este lado en la vela.

Ejemplo: 12

eventsobject[]obligatorio

Hasta los 5 eventos más recientes de este lado en la vela, los más recientes primero.

Elementos del array · object

assetstringobligatorio

Ticker del activo base del mercado en el que ocurrió el evento.

Ejemplo: BTC

directionstring · enumobligatorio

Dirección de la posición a la que pertenece el evento.

Permitido: "long" "short"

Ejemplo: long

eventNamestring · enumobligatorio

Permitido: "open" "increase" "decrease" "close" "liquidation"

Ejemplo: open

executedAtnumberobligatorio

Cuándo ocurrió el evento, marca de tiempo unix en segundos.

Ejemplo: 1767225599

pricestring · int32obligatorio

Precio al que se ejecutó el evento, fp9 en bruto — cotización intercambiada sobre base intercambiada.

pattern: ^(?:-?[1-9][0-9]*|0)$

Ejemplo: 1000000000

sizestring · int32obligatorio

Tamaño absoluto que movió el evento, en unidades del activo base, fp9 en bruto.

pattern: ^(?:-?[1-9][0-9]*|0)$

Ejemplo: 1000000000

Ver ejemplo

[
  {
    "asset": "BTC",
    "direction": "long",
    "eventName": "open",
    "executedAt": 1767225599,
    "price": "1000000000",
    "size": "1000000000"
  }
]

Ver ejemplo

{
  "totalCount": 12,
  "events": [
    {
      "asset": "BTC",
      "direction": "long",
      "eventName": "open",
      "executedAt": 1767225599,
      "price": "1000000000",
      "size": "1000000000"
    }
  ]
}

[
  {
    "time": 1767225600,
    "buy": {
      "totalCount": 12,
      "events": [
        {
          "asset": "BTC",
          "direction": "long",
          "eventName": "open",
          "executedAt": 1767225599,
          "price": "1000000000",
          "size": "1000000000"
        }
      ]
    },
    "sell": {
      "totalCount": 12,
      "events": [
        {
          "asset": "BTC",
          "direction": "long",
          "eventName": "open",
          "executedAt": 1767225599,
          "price": "1000000000",
          "size": "1000000000"
        }
      ]
    }
  }
]