View as Markdown
Bitget icon

Bitget ACTION

Spot - Market - Get Candle Data

Retrieve candlestick data for a specified symbol and time period. See the documentation
  • Action
  • Read only
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Bitget account once, then configure and run Spot - Market - Get Candle Data from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "bitget-spot-market-get-candle-data",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    bitget: { authProvisionId: "apn_xxxxxxx" },
    symbol: "Symbol",
    granularity: "Granularity",
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

Spot - Market - Get Candle Data inputs
Property Type Description
symbol Symbol string
Trading pair symbol
Required Dynamic
granularity Granularity string

Time interval of charts. For the corresponding relationship between granularity and value, refer to the list below.

  • minute: 1min, 3min, 5min, 15min, 30min
  • hour: 1h, 4h, 6h, 12h
  • day: 1day, 3day
  • week: 1week
  • month: 1M
  • hour in UTC: 6Hutc, 12Hutc
  • day in UTC: 1Dutc, 3Dutc
  • week in UTC: 1Wutc
  • month in UTC: 1Mutc
  • 1m, 3m, 5m can query for one month, 15m can query for 52 days, 30m can query for 62 days, 1H can query for 83 days, 2H can query for 120 days, 4H can query for 240 days, 6H can query for 360 days.
Required
startTime Start Time string
The time start point of the chart data, i.e., to get the chart data after this timestamp Unix millisecond timestamp, e.g. 1690196141868
Optional
endTime End Time string
The time end point of the chart data, i.e., get the chart data before this timestamp Unix millisecond timestamp, e.g. 1690196141868
Optional
limit Limit integer
Default: 100, maximum: 1000.
Optional

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
bitget-spot-market-get-candle-data
Version
0.0.3
App
Bitget
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes