GameVault Partner API
Welcome to the GameVault Partner API
Manage your game catalog, track analytics, and grow your presence on GameVault.
The API is designed to be used with our official CLI tool, gamevault-cli, built in Rust for maximum performance and security.
Getting Started
Create an account, grab an API key and ship your first game in minutes.
API Reference
Every endpoint with request bodies, responses, CLI and cURL examples.
CLI Reference
All gamevault-cli commands in one place.
Base URL#
All endpoints in this documentation are relative to the API base URL:
Requests and responses use application/json. All timestamps are ISO 8601 in UTC.
Getting Started#
Follow these five steps to go from zero to managing your game catalog from the terminal.
-
Create a partner account
Sign up at
/partner/with your email, a password and your studio name. -
Get your API key
Open the partner dashboard and copy your API key. Keys start with
gv_. Keep it secret. -
Install the CLI tool
Download the prebuilt binary, make it executable and place it on your
PATH. -
Configure your key
gamevault-cli config set-key YOUR_API_KEY -
Start managing games
gamevault-cli games list
From here you can create games, view analytics and update your studio profile. See the CLI Reference for every command.
Authentication#
All partner endpoints require an API key sent in the X-API-Key header. Public endpoints (browsing and searching games, genres and reviews) and the auth endpoints do not require a key.
- API keys start with the
gv_prefix. - Send the key on every request to
/api/v1/partner/*endpoints. - The CLI handles this automatically once you run
gamevault-cli config set-key.
Header format#
Example request#
Never commit API keys to source control or expose them in client-side code. If a key is compromised, rotate it from the partner dashboard. A missing or invalid key returns 401 Unauthorized.
API Reference#
Each endpoint below shows the request, an example response, the equivalent gamevault-cli command and a cURL example. Endpoints marked API key require the X-API-Key header.
CLI Reference#
The full command reference for gamevault-cli. Arguments in angle brackets are required. Click the copy icon next to any command to copy it.
Rate Limits#
To keep the platform fast and fair for everyone, requests are rate limited.
| Scope | Limit | Keyed by |
|---|---|---|
| Partner endpoints | 100 requests / minute | API key |
| Public endpoints | 60 requests / minute | IP address |
Rate limit headers#
Every response includes headers describing your current quota.
| Header | Description |
|---|---|
X-RateLimit-Limit | Maximum number of requests allowed in the current window. |
X-RateLimit-Remaining | Requests remaining in the current window. |
X-RateLimit-Reset | Unix timestamp (seconds) at which the window resets. |
Exceeding the limit#
When you exceed the limit the API responds with 429 Too Many Requests. Wait until the time in X-RateLimit-Reset before retrying.
Error Handling#
The API uses conventional HTTP status codes. Errors share a standard response format:
Common error codes#
| Status | Meaning | Description |
|---|---|---|
400 | Bad Request | Invalid request body or parameters. |
401 | Unauthorized | Missing or invalid API key. |
403 | Forbidden | Not authorized to access this resource. |
404 | Not Found | Resource not found. |
429 | Too Many Requests | Rate limit exceeded. |
500 | Internal Server Error | Server error. Retry later; contact support if it persists. |
SDKs and Tools#
Community libraries
Built something for another language or platform? Contributions are welcome.
The API is designed to be used primarily through our official Rust CLI tool. While the HTTP endpoints are documented here for transparency, we recommend using gamevault-cli for the best experience.
Community contributions are welcome. If you build a wrapper, integration or tool on top of the Partner API, let us know through the partner dashboard so we can feature it here.