DocumentationQuick Start

Quick Start

Get started with GroundAPI in 5 minutes — connect your Agent to real-world data

1. Register and Get an API Key

Go to GroundAPI Console, create an account, and generate an API Key. The key is shown only once — save it securely.

2. Make Your First Request

Query the latest quote for Kweichow Moutai:

curl -H "X-API-Key: sk_gapi_xxxxx" \
  "https://api.groundapi.net/v1/finance/stock?symbol=600519"

3. Python Example

import httpx
 
resp = httpx.get(
    "https://api.groundapi.net/v1/finance/stock",
    params={"symbol": "600519"},
    headers={"X-API-Key": "sk_gapi_xxxxx"},
)
print(resp.json())

4. MCP Configuration

Add to your Claude Desktop or Cursor config:

{
  "mcpServers": {
    "groundapi": {
      "url": "https://mcp.groundapi.net/mcp",
      "headers": {
        "X-API-Key": "sk_gapi_xxxxx"
      }
    }
  }
}

After configuration, Claude can directly call all 14 data tools.

5. Response Format

All endpoints return a unified format:

{
  "success": true,
  "data": { ... }
}

On error:

{
  "success": false,
  "error": {
    "code": "INVALID_PARAMS",
    "message": "Error description"
  }
}

6. All Endpoints

Finance

EndpointDescription
GET /v1/finance/stockStock search/quotes/history/technicals
GET /v1/finance/stock/screenStock screening and ranking
GET /v1/finance/marketMarket overview/sectors/funds/macro
GET /v1/finance/fundFund query/ranking/details

Information

EndpointDescription
GET /v1/info/searchWeb search
GET /v1/info/scrapeWeb scraping
GET /v1/info/newsNews headlines

Life Services

EndpointDescription
GET /v1/life/weatherWeather
GET /v1/life/logisticsLogistics tracking
GET /v1/life/ipIP geolocation

7. Free Tier

500 free calls per month across all endpoints. No credit card required.

Updated 6 days ago
Did this page help you?