Получить события позиции для индикаторов графика, сгруппированные по свечам

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

Получить события позиции для индикаторов графика, сгруппированные по свечамТорговля

События позиции аккаунта на одном рынке, сгруппированные по свечам запрошенного разрешения, начиная с самой старой свечи.

Свечи выравниваются так же, как это делает datafeed: свеча начинается с момента, кратного разрешению, отсчитываемому с начала эпохи Unix, а дневная — в полночь UTC.
Свеча включается, когда её начало находится внутри [from, to]; расстояние между from и to не может превышать 350 свечей.
Свечи без событий опускаются.
У каждой свечи есть сторона buy (увеличения лонгов, уменьшения шортов, закрытия и ликвидации) и сторона sell (увеличения шортов, уменьшения лонгов, закрытия и ликвидации). Сторона содержит до 5 последних событий, сначала самые новые, и количество всех её событий в свече.
Учитываются только увеличения, закрытия, принудительные закрытия и ликвидации; изменения финансирования и маржи не являются событиями графика.
Ограничено фазой, в которой аккаунт находится в данный момент.

Базовый URL https://api.upscale.trade

Авторизация

bearerhttp · bearerобязательно

Персональный API-ключ с префиксом usk_.

Параметры

Путь

accountIdstring · uuidобязательно

Идентификатор торгового аккаунта. Должен принадлежать вызывающей стороне.

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})$

Пример: 00000000-0000-4000-8000-000000000000

assetstringобязательно

Тикер базового актива рынка, как возвращается GET /v2/markets.

minLength: 1

Пример: BTC

Строка запроса

resolutionstring · enumобязательно

Разрешение свечи, по которому группируются события, те же значения, что и у эндпоинта datafeed /history.

Допустимо: "1" "5" "15" "30" "60" "240" "1D"

Пример: 60

fromintegerобязательно

Начало первой свечи, метка времени Unix в секундах (включительно).

minimum: 0
maximum: 9007199254740991

Пример: 1767225600

tointegerобязательно

Начало последней свечи, метка времени Unix в секундах (включительно).

minimum: 0
maximum: 9007199254740991

Пример: 1768482000

Примеры

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)

Ответы

401

Неавторизовано

403

Аккаунт принадлежит другому пользователю (account_access_denied), или запрос аутентифицирован с помощью API-ключа, тогда как api_trading отключён на аккаунте (api_trading_not_enabled).

404

Нет аккаунта с этим идентификатором или нет рынка для этого тикера.

429

Превышен лимит частоты запросов API-ключа (api_key_rate_limit_exceeded). Retry-After указывает, когда вернуться; тело содержит бакет (read / write), окно, которое сработало, его лимит и retryAt.

defaultОтветapplication/json

Массив ChartEventBucketResponse

timenumberобязательно

Начало свечи, метка времени Unix в секундах.

Пример: 1767225600

buyobjectобязательно

Сторона покупки: увеличения длинных позиций и уменьшения, закрытия и ликвидации коротких позиций.

Объект · 2 поля

totalCountnumberобязательно

Количество всех событий этой стороны в свече.

Пример: 12

eventsobject[]обязательно

До 5 последних событий этой стороны в свече, сначала самые новые.

Элементы массива · object

assetstringобязательно

Тикер базового актива рынка, на котором произошло событие.

Пример: BTC

directionstring · enumобязательно

Направление позиции, к которой относится событие.

Допустимо: "long" "short"

Пример: long

eventNamestring · enumобязательно

Что обозначает маркер: open — для первого увеличения позиции, increase — для последующих, decrease — для частичного закрытия, close — для полного и liquidation — для ликвидации.

Допустимо: "open" "increase" "decrease" "close" "liquidation"

Пример: open

executedAtnumberобязательно

Когда произошло событие, временная метка Unix в секундах.

Пример: 1767225599

pricestring · int32обязательно

Цена, по которой было исполнено событие, fp9 в необработанном виде — обменённая сумма в котируемой валюте, делённая на обменённую сумму в базовом активе.

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

Пример: 1000000000

sizestring · int32обязательно

Абсолютный размер, перемещённый событием, в единицах базового актива, fp9 в необработанном виде.

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

Пример: 1000000000

Посмотреть пример

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

Посмотреть пример

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

sellobjectобязательно

Сторона продажи: увеличения коротких позиций и уменьшения, закрытия и ликвидации длинных позиций.

Объект · 2 поля

totalCountnumberобязательно

Количество всех событий этой стороны в свече.

Пример: 12

eventsobject[]обязательно

До 5 последних событий этой стороны в свече, сначала самые новые.

Элементы массива · object

assetstringобязательно

Тикер базового актива рынка, на котором произошло событие.

Пример: BTC

directionstring · enumобязательно

Направление позиции, к которой относится событие.

Допустимо: "long" "short"

Пример: long

eventNamestring · enumобязательно

Допустимо: "open" "increase" "decrease" "close" "liquidation"

Пример: open

executedAtnumberобязательно

Когда произошло событие, временная метка Unix в секундах.

Пример: 1767225599

pricestring · int32обязательно

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

Пример: 1000000000

sizestring · int32обязательно

Абсолютный размер, перемещённый событием, в единицах базового актива, fp9 в необработанном виде.

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

Пример: 1000000000

Посмотреть пример

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

Посмотреть пример

{
  "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"
        }
      ]
    }
  }
]