Get scalping coefficient for ticker

GET/positions/{accountId}/{asset}/scalping-coefficient

Get scalping coefficient for tickerTrading

Whether the account is currently inside the scalping window on this market — the period after an increase during which the market charges the elevated dynamic spread.

amount is the multiplier applied inside the window and amountRegular the one applied outside it, both fp9.
activeSince and activeUntil are returned only while the window is running; without a recent increase they are absent and the regular multiplier applies.
recentVolume.long and recentVolume.short contain the accumulated volume after the latest executed open or increase in each direction, in USD fp9 raw. It excludes the order currently being entered and is added to its size when calculating dynamic price impact.
Each direction has its own updatedAt and activeUntil: the volume decays linearly to zero over 60 seconds, independently of the scalping window.
A direction is null when its volume has fully recovered or it has no dynamic price impact snapshot.

Base URL https://api.upscale.trade

Authorization

bearerhttp · bearerrequired

Personal API key, prefixed with usk_.

Parameters

Path

accountIdstring · uuidrequired

Trader account identifier. Must belong to the caller.

Example: 00000000-0000-4000-8000-000000000000

assetstringrequired

Base asset ticker of the market, as returned by GET /v2/markets.

Example: BTC

Examples

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

const response = await fetch("https://api.upscale.trade/positions/{accountId}/{asset}/scalping-coefficient", {
  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}/scalping-coefficient",
    headers={"Accept":"application/json","Authorization":"Bearer YOUR_API_KEY"},
    timeout=30,
)
print(response.status_code, response.text)

Responses

401

Unauthorized

403

The account belongs to another user (account_access_denied), or the request is authenticated with an API key while api_trading is disabled on the account (api_trading_not_enabled).

404

No account with this identifier, or no market for this ticker.

429

Rate limit of the API key exceeded (api_key_rate_limit_exceeded). Retry-After says when to come back; the body carries the bucket (read / write), the window that tripped, its limit and retryAt.

defaultResponseapplication/json

activeSincestring · date-timeoptional

Start of the running scalping window — the last increase on this market. Absent when no increase happened inside the window.

Example: 2026-05-01T12:30:00.000Z

activeUntilstring · date-timeoptional

End of the running scalping window. Absent together with activeSince.

Example: 2026-05-01T12:30:00.000Z

amountstring · fp9required

Spread multiplier charged while the window is running, fp9 raw (2000000000 = 2x).

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

Example: 1000000000

amountRegularstring · fp9required

Spread multiplier charged outside the window, fp9 raw (1000000000 = 1x).

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

Example: 1000000000

recentVolumeobjectrequired

Accumulated executed volume counted in the next open or increase, per direction, with its own recovery window; 60 seconds by default.

Object · 2 fields

longobject · nullablerequired

Recent long volume. Null when no volume remains in this direction.

Object · 3 fields

volumestring · fp9required

Volume right after the latest execution, USD fp9 raw. It decays linearly from updatedAt to zero at activeUntil.

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

Example: 1000000000

updatedAtstring · date-timerequired

Latest execution of an open or increase in this direction.

Example: 2026-05-01T12:30:00.000Z

activeUntilstring · date-timerequired

Moment the volume decays to zero according to the trading recovery window; 60 seconds by default.

Example: 2026-05-01T12:30:00.000Z

View example

{
  "volume": "1000000000",
  "updatedAt": "2026-05-01T12:30:00.000Z",
  "activeUntil": "2026-05-01T12:30:00.000Z"
}

shortobject · nullablerequired

Recent short volume. Null when no volume remains in this direction.

Object · 3 fields

volumestring · fp9required

Volume right after the latest execution, USD fp9 raw. It decays linearly from updatedAt to zero at activeUntil.

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

Example: 1000000000

updatedAtstring · date-timerequired

Latest execution of an open or increase in this direction.

Example: 2026-05-01T12:30:00.000Z

activeUntilstring · date-timerequired

Moment the volume decays to zero according to the trading recovery window; 60 seconds by default.

Example: 2026-05-01T12:30:00.000Z

View example

{
  "volume": "1000000000",
  "updatedAt": "2026-05-01T12:30:00.000Z",
  "activeUntil": "2026-05-01T12:30:00.000Z"
}

View example

{
  "long": {
    "volume": "1000000000",
    "updatedAt": "2026-05-01T12:30:00.000Z",
    "activeUntil": "2026-05-01T12:30:00.000Z"
  },
  "short": {
    "volume": "1000000000",
    "updatedAt": "2026-05-01T12:30:00.000Z",
    "activeUntil": "2026-05-01T12:30:00.000Z"
  }
}

{
  "activeSince": "2026-05-01T12:30:00.000Z",
  "activeUntil": "2026-05-01T12:30:00.000Z",
  "amount": "1000000000",
  "amountRegular": "1000000000",
  "recentVolume": {
    "long": {
      "volume": "1000000000",
      "updatedAt": "2026-05-01T12:30:00.000Z",
      "activeUntil": "2026-05-01T12:30:00.000Z"
    },
    "short": {
      "volume": "1000000000",
      "updatedAt": "2026-05-01T12:30:00.000Z",
      "activeUntil": "2026-05-01T12:30:00.000Z"
    }
  }
}