GroveX API | REST & WebSocket Crypto Trading API

Getting started

GroveX API overview

The official GroveX API documentation defines REST interfaces for spot trading and account operations plus WebSocket channels for market data.

REST base URLhttps://openapi.grovex.io

WebSocket URLwss://ws.grovex.io/kline-api/ws

Public market-data interfaces explicitly marked as not requiring signature verification can be called without a signed account request.

Authentication

Signed REST requests

Generate an API Key and Secret Key from your GroveX account before using private endpoints. The spot endpoint reference contracts below require api_key, time and sign parameters. GroveX's older general authentication text also references ACCESS-* headers, so use the contract for the specific endpoint being integrated. The spot endpoint reference contracts below require api_key, time and sign parameters. GroveX's older general authentication text also references ACCESS-* headers, so use the contract for the specific endpoint being integrated.

Spot API credentialapi_key

Spot signaturesign - MD5

Spot request timetime - required by endpoint

Content-Typeapplication/x-www-form-urlencoded

Timestamp compatibility: the upstream GroveX document contains conflicting timestamp-unit examples. Public live responses also use endpoint-specific timestamp representations. Do not assume one response timestamp unit applies to every signed request; follow the contract and tested client implementation for the endpoint being integrated.

SIGNGroveX request signature

1. Sort non-null request parameters by parameter name in ascending lexicographic order.

2. Concatenate the sorted parameters in keyvalue form.

3. Include the Secret Key value as shown by the official GroveX signing example and calculate the MD5 digest.

api_key = YOUR_API_KEY
time    = UNIX_TIMESTAMP
secret  = YOUR_SECRET_KEY

sign = md5(
  api_key + API_KEY_VALUE +
  time + TIMESTAMP_VALUE +
  SECRET_KEY_VALUE
)

Never expose your Secret Key in browser code, public repositories, screenshots or client-side applications.

Public API

Market data

These are the public market-data interfaces documented by GroveX. The endpoints below were also tested directly against openapi.grovex.io and returned code 0 / msg suc without API credentials.

GET/open/api/get_alltickerPublic - no signature

All market tickers

ParametersNone

Returns the ticker collection. The documented market fields include symbol, buy, sell, high, low, last, vol and rose; the response envelope also includes server timing information.

GET/open/api/get_recordsPublic - no signature

K-line / candlestick data

Parameterssymbol, period

period is expressed in minutes. The official examples include 1 minute and 1440 for one day. Live data is returned as [timestamp, open, high, low, close, volume].

GET/open/api/get_tickerPublic - no signature

Current ticker for one market

Parameterssymbol

The current live response includes amount, high, vol, last, low, buy, sell, rose and time.

GET/open/api/get_tradesPublic - no signature

Recent market trades

Parameterssymbol

The current live response includes amount, price, ctime, id and type, where type is buy or sell.

GET/open/api/market_deptPublic - no signature

Order book depth

Parameterssymbol, type

Depth types documented by GroveX include step0, step1, step2 and step0time. Live step0 responses contain tick.asks, tick.bids, lastUpdateId and time.

GET/open/api/common/symbolsPublic - live verified without authentication

Supported markets and precision

ParametersNone

Returns supported symbols, base_coin, count_coin, price_precision and amount_precision. The current live response also includes limit_volume_min.

Private API

Spot trading

Trading operations require the signed API request fields documented by GroveX.

POST/open/api/create_orderSigned

Create order

Parametersside, type, volume, price?, symbol, fee_is_user_exchange_coin?, api_key, time, sign

side is BUY or SELL. type 1 is a limit order and type 2 is a market order. For type 1, volume is the order quantity. For type 2, BUY volume represents the total quote price while SELL volume represents the total quantity. price is not required for type 2. fee_is_user_exchange_coin is documented as an optional legacy/redundant field.

POST/open/api/cancel_orderSigned

Cancel order

Parametersorder_id, symbol, api_key, time, sign

POST/open/api/cancel_order_allSigned

Cancel all orders for a market

Parameterssymbol, api_key, time, sign

The official documentation states this operation supports up to 2,000 cancellations.

POST/open/api/mass_replaceV2Signed

Batch place / batch cancel - V2

Parameterssymbol, mass_place?, mass_cancel?, api_key, time, sign

V2 is the recommended batch interface. The source documents up to 1,000 batch items.

POST/open/api/mass_replaceSigned - legacy

Legacy batch place / cancel

Parameterssymbol, mass_place?, mass_cancel?, api_key, time, sign

Legacy batch interface. mass_place and mass_cancel support up to 100 items per request. The official documentation recommends mass_replaceV2 instead.

Private API

Orders and account

Signed account endpoints provide balances, order state, account trade history and other authorised data.

GET/open/api/user/accountSigned

Asset balances

Parametersapi_key, time, sign

Returns total asset information and per-asset available and locked balances.

GET/open/api/v2/all_orderSigned

All orders / delegation history

Parameterssymbol, startDate?, endDate?, pageSize?, page?, api_key, time, sign

The documentation states the startDate/endDate interval cannot exceed ten minutes. When they are omitted, the documented default is the first ten-minute window.

GET/open/api/all_tradeSigned

Account trade records

Parameterssymbol, startDate?, endDate?, pageSize?, page?, sort?, api_key, time, sign

GET/open/api/v2/new_orderSigned

Current open / working orders

Parameterssymbol, pageSize?, page?, api_key, time, sign

The V2 endpoint is recommended instead of the older /open/api/new_order endpoint.

GET/open/api/order_infoSigned

Order details

Parametersorder_id, symbol, api_key, time, sign

Returns order information and its associated trade records.

GET/open/api/marketSigned

Latest prices for markets

Parametersapi_key, time, sign

POST/open/api/user_balance_infoSigned - privileged

User asset and deposit information

Parametersuid | mobile_number | email, api_key, time, sign

One user identifier is required. This endpoint requires the appropriate query privilege.

The general documentation describes cursor pagination using CB-BEFORE and CB-AFTER, while several individual spot endpoints explicitly document page and pageSize parameters. Follow the parameter contract for the endpoint being called.

Streaming API

WebSocket channels

GroveX WebSocket subscriptions use event-based JSON messages and the documented market channel naming convention.

WSwss://ws.grovex.io/kline-api/ws

K-linemarket_$base$quote_kline_[1min/5min/15min/30min/60min/1day/1week/1month]24h tickermarket_$base$quote_tickerDepthmarket_$base$quote_depth_step[0-2]Tradesmarket_$base$quote_trade_ticker24h market reviewreview

SUBSubscribe to BTC/USDT ticker

{
  "event": "sub",
  "params": {
    "channel": "market_btcusdt_ticker",
    "cb_id": "btcusdt"
  }
}

REQRequest recent BTC/USDT trades

{
  "event": "req",
  "params": {
    "channel": "market_btcusdt_trade_ticker",
    "cb_id": "btcusdt",
    "top": 200
  }
}

Limits

REST API rate limits

Public interfaces6 requests / 2 seconds / IP

Private interfaces6 requests / 2 seconds / user ID

Exceeding the documented REST limit returns HTTP 429 Too Many Requests.

Responses

Common HTTP errors

400Bad Request

401Invalid API Key / Unauthorized

403Access to resource denied

404Not Found

429Too Many Requests

500Internal Server Error

Individual endpoints can document additional GroveX application-level error codes.

Official source

GroveX API source documentation

This page is based on the official GroveX API document maintained in the GroveXchange GitHub repository.

View official API source

Getting started

GroveX API overview

The official GroveX API documentation defines REST interfaces for spot trading and account operations plus WebSocket channels for market data.

REST base URLhttps://openapi.grovex.io

WebSocket URLwss://ws.grovex.io/kline-api/ws

Public market-data interfaces explicitly marked as not requiring signature verification can be called without a signed account request.

Authentication

Signed REST requests

Spot API credentialapi_key

Spot signaturesign - MD5

Spot request timetime - required by endpoint

Content-Typeapplication/x-www-form-urlencoded

SIGNGroveX request signature

1. Sort non-null request parameters by parameter name in ascending lexicographic order.

2. Concatenate the sorted parameters in keyvalue form.

3. Include the Secret Key value as shown by the official GroveX signing example and calculate the MD5 digest.

api_key = YOUR_API_KEY
time    = UNIX_TIMESTAMP
secret  = YOUR_SECRET_KEY

sign = md5(
  api_key + API_KEY_VALUE +
  time + TIMESTAMP_VALUE +
  SECRET_KEY_VALUE
)

Never expose your Secret Key in browser code, public repositories, screenshots or client-side applications.

Public API

Market data

These are the public market-data interfaces documented by GroveX. The endpoints below were also tested directly against openapi.grovex.io and returned code 0 / msg suc without API credentials.

GET/open/api/get_alltickerPublic - no signature

All market tickers

ParametersNone

Returns the ticker collection. The documented market fields include symbol, buy, sell, high, low, last, vol and rose; the response envelope also includes server timing information.

GET/open/api/get_recordsPublic - no signature

K-line / candlestick data

Parameterssymbol, period

period is expressed in minutes. The official examples include 1 minute and 1440 for one day. Live data is returned as [timestamp, open, high, low, close, volume].

GET/open/api/get_tickerPublic - no signature

Current ticker for one market

Parameterssymbol

The current live response includes amount, high, vol, last, low, buy, sell, rose and time.

GET/open/api/get_tradesPublic - no signature

Recent market trades

Parameterssymbol

The current live response includes amount, price, ctime, id and type, where type is buy or sell.

GET/open/api/market_deptPublic - no signature

Order book depth

Parameterssymbol, type

Depth types documented by GroveX include step0, step1, step2 and step0time. Live step0 responses contain tick.asks, tick.bids, lastUpdateId and time.

GET/open/api/common/symbolsPublic - live verified without authentication

Supported markets and precision

ParametersNone

Returns supported symbols, base_coin, count_coin, price_precision and amount_precision. The current live response also includes limit_volume_min.

Private API

Spot trading

Trading operations require the signed API request fields documented by GroveX.

POST/open/api/create_orderSigned

Create order

Parametersside, type, volume, price?, symbol, fee_is_user_exchange_coin?, api_key, time, sign

POST/open/api/cancel_orderSigned

Cancel order

Parametersorder_id, symbol, api_key, time, sign

POST/open/api/cancel_order_allSigned

Cancel all orders for a market

Parameterssymbol, api_key, time, sign

The official documentation states this operation supports up to 2,000 cancellations.

POST/open/api/mass_replaceV2Signed

Batch place / batch cancel - V2

Parameterssymbol, mass_place?, mass_cancel?, api_key, time, sign

V2 is the recommended batch interface. The source documents up to 1,000 batch items.

POST/open/api/mass_replaceSigned - legacy

Legacy batch place / cancel

Parameterssymbol, mass_place?, mass_cancel?, api_key, time, sign

Legacy batch interface. mass_place and mass_cancel support up to 100 items per request. The official documentation recommends mass_replaceV2 instead.

Private API

Orders and account

Signed account endpoints provide balances, order state, account trade history and other authorised data.

GET/open/api/user/accountSigned

Asset balances

Parametersapi_key, time, sign

Returns total asset information and per-asset available and locked balances.

GET/open/api/v2/all_orderSigned

All orders / delegation history

Parameterssymbol, startDate?, endDate?, pageSize?, page?, api_key, time, sign

The documentation states the startDate/endDate interval cannot exceed ten minutes. When they are omitted, the documented default is the first ten-minute window.

GET/open/api/all_tradeSigned

Account trade records

Parameterssymbol, startDate?, endDate?, pageSize?, page?, sort?, api_key, time, sign

GET/open/api/v2/new_orderSigned

Current open / working orders

Parameterssymbol, pageSize?, page?, api_key, time, sign

The V2 endpoint is recommended instead of the older /open/api/new_order endpoint.

GET/open/api/order_infoSigned

Order details

Parametersorder_id, symbol, api_key, time, sign

Returns order information and its associated trade records.

GET/open/api/marketSigned

Latest prices for markets

Parametersapi_key, time, sign

POST/open/api/user_balance_infoSigned - privileged

User asset and deposit information

Parametersuid | mobile_number | email, api_key, time, sign

One user identifier is required. This endpoint requires the appropriate query privilege.

Streaming API

WebSocket channels

GroveX WebSocket subscriptions use event-based JSON messages and the documented market channel naming convention.

WSwss://ws.grovex.io/kline-api/ws

SUBSubscribe to BTC/USDT ticker

{
  "event": "sub",
  "params": {
    "channel": "market_btcusdt_ticker",
    "cb_id": "btcusdt"
  }
}

REQRequest recent BTC/USDT trades

{
  "event": "req",
  "params": {
    "channel": "market_btcusdt_trade_ticker",
    "cb_id": "btcusdt",
    "top": 200
  }
}

Limits

REST API rate limits

Public interfaces6 requests / 2 seconds / IP

Private interfaces6 requests / 2 seconds / user ID

Exceeding the documented REST limit returns HTTP 429 Too Many Requests.

Responses

Common HTTP errors

400Bad Request

401Invalid API Key / Unauthorized

403Access to resource denied

404Not Found

429Too Many Requests

500Internal Server Error

Individual endpoints can document additional GroveX application-level error codes.

Official source

GroveX API source documentation

This page is based on the official GroveX API document maintained in the GroveXchange GitHub repository.

View official API source

Build directly on GroveX market infrastructure.

GroveX API overview

Signed REST requests

Market data

Spot trading

Orders and account

WebSocket channels

REST API rate limits

Common HTTP errors

GroveX API source documentation

Build directly on GroveX market infrastructure.

GroveX API overview

Signed REST requests

Market data

Spot trading

Orders and account

WebSocket channels

REST API rate limits

Common HTTP errors

GroveX API source documentation