GET
/
marks
Get Chart Marks (Trades)
curl --request GET \
  --url http://localhost:2400/marks \
  --header 'Authorization: Bearer <token>'
{
  "id": [
    1,
    2
  ],
  "time": [
    1678886500,
    1678887000
  ],
  "color": [
    {
      "color": "#262628",
      "background": "#262628"
    },
    {
      "color": "#262628",
      "background": "#262628"
    }
  ],
  "text": [
    "Bought 10 TOKEN_SYMBOL with 1.5 ETH/SOL/BASE_QUOTE",
    "Sold 5 TOKEN_SYMBOL for 0.8 ETH/SOL/BASE_QUOTE"
  ],
  "label": [
    "B",
    "S"
  ],
  "labelFontColor": [
    "#00ff90",
    "#ff4150"
  ],
  "minSize": [
    20,
    20
  ],
  "markLocation": [
    "BelowBar",
    "AboveBar"
  ]
}

Endpoint

GET /marks

Description

Retrieves trade marks and annotations that can be displayed on the chart, showing buy and sell points for a specific token. These marks are used to visualize trading activity on the chart.

Query Parameters

ParameterTypeRequiredDescriptionExample
symbolstringYesThe token symbol or address to fetch marks for.PEPE
fromintegerYesThe start timestamp (Unix seconds) for the data range.1678886400
tointegerYesThe end timestamp (Unix seconds) for the data range.1678972800
resolutionstringYesThe chart resolution/interval.60
UserIDstringYesThe ID of the user requesting the marks.user-123
featuresstringNoJSON string containing pre-fetched feature data.[{"wallets":["0x..."],"orderType":"Bought",...}]

Response

Returns an object containing arrays of mark data:
{
  "id": [1, 2],
  "time": [1678886400, 1678887000],
  "color": [
    { "color": "#262628", "background": "#262628" },
    { "color": "#262628", "background": "#262628" }
  ],
  "text": [
    "Bought 1000 PEPE with 0.5 ETH",
    "Sold 500 PEPE for 0.3 ETH"
  ],
  "label": ["B", "S"],
  "labelFontColor": ["#00ff90", "#ff4150"],
  "minSize": [20, 20],
  "markLocation": ["BelowBar", "AboveBar"]
}

Request Example

GET /marks?symbol=PEPE&from=1678886400&to=1678972800&resolution=60&UserID=user-123

Notes

  • Buy marks are displayed below the price bars with a green label
  • Sell marks are displayed above the price bars with a red label
  • The marks include the amount traded and the price in the base currency (ETH/SOL)
  • Marks can be pre-fetched and passed in the features parameter to avoid additional API calls

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

symbol
string

The token address (used as symbol internally) to filter trades for. Either symbol or walletAddress might be expected by the backend.

from
integer
required

The start timestamp (Unix seconds) for the data range.

to
integer
required

The end timestamp (Unix seconds) for the data range.

resolution
enum<string>
required

The chart resolution/interval.

Available options:
1,
5,
15,
60,
D,
W,
M
userID
string
required

The ID of the user requesting the data.

features
string

A JSON string representing pre-fetched trade data. If provided, skips fetching from internal services.

Response

200
application/json

Successful retrieval of chart marks data

Object containing arrays of mark properties for chart display.