Quickstart Guide

Welcome to SteamData Connect API! This guide will help you get started in just a few minutes.

Prerequisites

Before you begin, you'll need:

  • A SteamData account
  • A team created
  • An API key generated

Step 1: Create an API Key

  1. Log in to your Dashboard
  2. Select or create a team
  3. Navigate to the team management page and click the "Connect API" tab
  4. Click the "Create Key" button
  5. Give your key a descriptive name (e.g., "Production" or "Testing")
  6. After creation, immediately copy and save your API key (it's shown only once)

Important: Keep your API key secure. Never commit it to code repositories or share it publicly.

Step 2: Make Your First Request

Using your API key, you can start calling our API. Here's a simple example:

Get Game Details

curl -X GET "https://endpoint.steamdata.ai/api/v1/apps/1938090" \
  -H "X-API-Key: your_api_key_here"

Response Example

{
  "app_id": 1938090,
  "name": "Call of Duty®: Black Ops 6",
  "type": "game",
  "release_date": "2024-10-25",
  "publishers": ["Activision"],
  "developers": ["Treyarch"],
  "categories": ["Multi-player", "Single-player"],
  "genres": ["Action", "Adventure"]
}

Step 3: Authentication

All API requests require your API key in the request header:

X-API-Key: your_api_key_here

Authentication Examples

cURL:

curl -H "X-API-Key: your_api_key_here" \
  https://endpoint.steamdata.ai/api/v1/apps/1938090

Python:

import requests

headers = {
    'X-API-Key': 'your_api_key_here'
}

response = requests.get(
    'https://endpoint.steamdata.ai/api/v1/apps/1938090',
    headers=headers
)

print(response.json())

JavaScript (Node.js):

const axios = require('axios');

const headers = {
  'X-API-Key': 'your_api_key_here'
};

axios.get('https://endpoint.steamdata.ai/api/v1/apps/1938090', { headers })
  .then(response => {
    console.log(response.data);
  })
  .catch(error => {
    console.error('Error:', error);
  });

API Quotas

Each API key has usage quota limits:

  • Free Tier: 10,000 requests per month
  • Standard Tier: 100,000 requests per month
  • Enterprise Tier: Custom quotas

You can view your current quota usage on the "Connect API" page in your Dashboard.

Error Handling

The API uses standard HTTP status codes:

Status CodeDescription
200Success
400Bad request
401Invalid or missing API key
403Insufficient permissions or quota exceeded
404Resource not found
429Too many requests (rate limit)
500Internal server error

Error Response Example

{
  "error": {
    "code": "invalid_api_key",
    "message": "The provided API key is invalid",
    "status": 401
  }
}

Rate Limiting

To ensure service quality, the API implements rate limiting:

  • Maximum 10 requests per second
  • 429 status code when limit exceeded
  • Rate limit information in response headers:
    • X-RateLimit-Limit: Total rate limit
    • X-RateLimit-Remaining: Remaining requests
    • X-RateLimit-Reset: Reset timestamp

Language Parameters

Many API endpoints support a language parameter to retrieve data in different languages. We support three formats:

  • Standard Names: e.g., English, Chinese (Simplified), Japanese (recommended)
  • BCP 47 Language Codes: e.g., en-US, zh-CN, ja-JP
  • Steam API Codes: e.g., english, schinese, japanese

Example: Get Simplified Chinese game information

curl -X GET "https://endpoint.steamdata.ai/api/v1/apps/1938090/localized?language=Chinese%20(Simplified)" \
  -H "X-API-Key: your_api_key_here"

Detailed Documentation: See Language Parameter Specification for complete language mapping table and usage instructions.

Next Steps

Now that you understand the basics, continue exploring:

Get Help

If you encounter any issues:

Happy coding! 🚀