Nexarda SDK
NEXARDA API client, generated from the OpenAPI spec.
This is an unofficial SDK for the NEXARDA public API, generated by Voxgig with @voxgig/sdkgen. It is not affiliated with, endorsed by, or sponsored by the upstream API provider.
TypeScript, Python, PHP, Golang, Ruby, Lua SDKs, a CLI, an interactive REPL, and an MCP server for AI agents — all generated from one OpenAPI spec by @voxgig/sdkgen.
Entities, not endpoints
This SDK exposes the API as a small set of semantic entities — Console, Franchis, Game, Platform, Price, Retailer, Search, Studio, User and Widget — that you
call directly, instead of assembling URL paths and query strings. Entities are
Capitalised to mark them as the primary surface, each with the operations they
support (list, load):
const client = new NexardaSDK()
const items = await client.Console().list()
Thinking in entities keeps the mental model small — for people and AI agents alike — rather than reasoning about raw HTTP routes and query parameters.
Packages
| Language | Package | Install |
|---|---|---|
| TypeScript | @voxgig-sdk/nexarda | publish pending — install from git tag |
| Python | voxgig-sdk-nexarda | publish pending — install from git tag |
| PHP | voxgig-sdk/nexarda | publish pending — install from git tag |
| Golang | github.com/voxgig-sdk/nexarda-sdk/go | go get github.com/voxgig-sdk/nexarda-sdk/go@latest |
| Ruby | voxgig-sdk-nexarda | publish pending — install from git tag |
| Lua | voxgig-sdk-nexarda | publish pending — install from git tag |
Quickstart
TypeScript
import { NexardaSDK } from '@voxgig-sdk/nexarda'
const client = new NexardaSDK({
apikey: process.env.NEXARDA_APIKEY,
})
// List all consoles (returns Console[])
const consoles = await client.Console().list()
for (const console of consoles) {
console.log(console)
}
See the TypeScript README for the full guide.
Surfaces
| Surface | Path |
|---|---|
| SDK (TypeScript, Python, PHP, Golang, Ruby, Lua) | ts/ py/ php/ go/ rb/ lua/ |
| CLI | go-cli/ |
| MCP server | go-mcp/ |
Use it from an AI agent (MCP)
The generated MCP server exposes every operation in this SDK as an MCP tool that Claude, Cursor or Cline can call directly. Build and register it:
cd go-mcp && go build -o nexarda-mcp .
Then add it to your agent’s MCP config (Claude Desktop, Cursor, etc.):
{
"mcpServers": {
"nexarda": {
"command": "/abs/path/to/nexarda-mcp"
}
}
}
Entities
The API exposes 10 entities:
| Entity | Description | API path |
|---|---|---|
| Console | The Console entity (list, load). | /consoles |
| Franchis | The Franchis entity (list, load). | /franchises |
| Game | The Game entity (list, load). | /games |
| Platform | The Platform entity (load). | /status |
| Price | The Price entity (list). | /games/{gameId}/prices |
| Retailer | The Retailer entity (list). | /retailers |
| Search | The Search entity (load). | /search |
| Studio | The Studio entity (list, load). | /studios |
| User | The User entity (list, load). | /users/{userId}/library |
| Widget | The Widget entity (load). | /widgets/button |
The operations available across these entities are load, list — see each entity’s own list above for exactly which it supports.
Quickstart in other languages
Python
import os
from nexarda_sdk import NexardaSDK
client = NexardaSDK({
"apikey": os.environ.get("NEXARDA_APIKEY"),
})
# List all consoles (returns a list, raises on error)
consoles = client.Console().list()
for console in consoles:
print(console)
# Load a specific console (returns the record, raises on error)
console = client.Console().load({"id": "example_id"})
print(console)
PHP
<?php
require_once 'nexarda_sdk.php';
$client = new NexardaSDK([
"apikey" => getenv("NEXARDA_APIKEY"),
]);
// List all consoles (returns an array; throws on error)
$consoles = $client->Console()->list();
print_r($consoles);
// Load a specific console (returns the bare record; throws on error)
$console = $client->Console()->load(["id" => "example_id"]);
print_r($console);
Golang
import sdk "github.com/voxgig-sdk/nexarda-sdk/go"
client := sdk.NewNexardaSDK(map[string]any{
"apikey": os.Getenv("NEXARDA_APIKEY"),
})
// List all consoles
consoles, err := client.Console(nil).List(nil, nil)
fmt.Println(consoles)
Ruby
require_relative "Nexarda_sdk"
client = NexardaSDK.new({
"apikey" => ENV["NEXARDA_APIKEY"],
})
# List all consoles (returns an Array; raises on error)
consoles = client.Console.list
puts consoles
# Load a specific console (returns the bare record; raises on error)
console = client.Console.load({ "id" => "example_id" })
puts console
Lua
local sdk = require("nexarda_sdk")
local client = sdk.new({
apikey = os.getenv("NEXARDA_APIKEY"),
})
-- List all consoles
local consoles, err = client:Console():list()
print(consoles)
-- Load a specific console
local console, err = client:Console():load({ id = "example_id" })
print(console)
Unit testing in offline mode
Every SDK ships a test mode that swaps the HTTP transport for an in-memory mock, so unit tests run offline.
TypeScript
const client = NexardaSDK.test()
const console = await client.Console().list()
// console is a bare Console populated with mock data
console.log(console)
Python
client = NexardaSDK.test()
console = client.Console().list()
print(console)
PHP
// Seed fixture data so offline calls resolve without a live server.
$client = NexardaSDK::test([
"entity" => ["console" => ["test01" => ["id" => "test01"]]],
]);
$console = $client->Console()->list();
Golang
client := sdk.Test()
result, err := client.Console(nil).List(
nil, nil,
)
Ruby
# Seed fixture data so offline calls resolve without a live server.
client = NexardaSDK.test({
"entity" => { "console" => { "test01" => { "id" => "test01" } } },
})
console = client.Console.list()
Lua
local client = sdk.test()
local result, err = client:Console():list()
Direct and prepare
For endpoints the entity model doesn’t cover, use the low-level methods:
direct(fetchargs)— build and send an HTTP request in one step.prepare(fetchargs)— build the request without sending it.
Both accept a map with path, method, params, query,
headers, and body. See the How-to guides below.
How-to guides
Make a direct API call
When the entity interface does not cover an endpoint, use direct:
TypeScript:
const result = await client.direct({
path: '/api/resource/{id}',
method: 'GET',
params: { id: 'example' },
})
if (result instanceof Error) {
throw result
}
console.log(result.data)
Python:
result = client.direct({
"path": "/api/resource/{id}",
"method": "GET",
"params": {"id": "example"},
})
PHP:
$result = $client->direct([
"path" => "/api/resource/{id}",
"method" => "GET",
"params" => ["id" => "example"],
]);
Go:
result, err := client.Direct(map[string]any{
"path": "/api/resource/{id}",
"method": "GET",
"params": map[string]any{"id": "example"},
})
Ruby:
result = client.direct({
"path" => "/api/resource/{id}",
"method" => "GET",
"params" => { "id" => "example" },
})
Lua:
local result, err = client:direct({
path = "/api/resource/{id}",
method = "GET",
params = { id = "example" },
})
Advanced
Everyday use only needs the sections above. This explains the internals behind every call — relevant when writing custom features.
Every SDK call runs the same five-stage pipeline:
- Point — resolve the API endpoint from the operation definition.
- Spec — build the HTTP specification (URL, method, headers, body).
- Request — send the HTTP request.
- Response — receive and parse the response.
- Result — extract the result data for the caller.
A feature hook fires at each stage (e.g. PrePoint, PreSpec,
PreRequest), so features can inspect or modify the pipeline without
forking the SDK.
Features
| Feature | Purpose |
|---|---|
| TestFeature | In-memory mock transport for testing without a live server |
Pass custom features via the extend option at construction time.
Per-language documentation
Upstream API
This SDK is generated from the upstream OpenAPI specification. It is an unofficial client and is not affiliated with the API provider.
- Upstream API: https://api.nexarda.com
Security
Please report security issues to security@voxgig.com. See SECURITY.md. Do not open public issues for suspected vulnerabilities.
Generated from the NEXARDA API OpenAPI spec by @voxgig/sdkgen.