API Overview

The Spartera API is a REST API that powers every action in the platform — creating assets, managing connections, executing analytics, and handling marketplace operations. All requests go through a single base URL and authenticate via API key.

Base URL

https://api.spartera.com

All endpoints follow this pattern:

https://api.spartera.com/companies/{company_id}/{resource}

Your company_id is available in your Spartera dashboard under Settings.

Authentication

All requests require an API key passed in the x-api-key header:

curl https://api.spartera.com/companies/{company_id}/assets \
  -H "x-api-key: your-api-key" \
  -H "accept: application/json"

Getting Your API Key

Dashboard → Settings → API Keys → Generate New Key

Store your key securely — it's only shown once at creation. If you lose it, generate a new one.

API Key Best Practices

Use separate keys for development and production
Never commit API keys to source control — use environment variables
Rotate keys if they're ever exposed
Use the name field when creating keys to track which system uses which key

Request Format

# Standard GET request
curl https://api.spartera.com/companies/{company_id}/assets \
  -H "x-api-key: your-api-key" \
  -H "accept: application/json"

# POST with JSON body
curl -X POST https://api.spartera.com/companies/{company_id}/assets \
  -H "x-api-key: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{"name": "My Asset", "asset_type": "CALCULATION"}'

# PATCH (partial update)
curl -X PATCH https://api.spartera.com/companies/{company_id}/assets/{asset_id} \
  -H "x-api-key: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{"description": "Updated description"}'

Response Format

All responses return JSON with a consistent structure:

{
  "data": { },
  "meta": {
    "timestamp": "2025-04-01T13:00:00Z",
    "version": "1.0",
    "execution_time_ms": 142
  }
}

List endpoints include pagination metadata:

{
  "data": [...],
  "meta": {
    "total": 247,
    "page": 1,
    "per_page": 50,
    "has_next": true
  }
}

HTTP Status Codes

Code	Meaning
`200 OK`	Successful GET or PATCH
`201 Created`	Successful POST — new resource created
`204 No Content`	Successful DELETE
`400 Bad Request`	Invalid request parameters
`401 Unauthorized`	Missing or invalid API key
`403 Forbidden`	Valid key but insufficient permissions
`404 Not Found`	Resource doesn't exist
`422 Unprocessable Entity`	Valid request but business logic error
`429 Too Many Requests`	Rate limit exceeded
`500 Internal Server Error`	Spartera server error

Error Responses

Errors always return a structured body:

{
  "error": {
    "code": "INSUFFICIENT_CREDITS",
    "message": "Your account does not have enough credits to execute this asset.",
    "details": {
      "required_credits": 5,
      "available_credits": 2,
      "asset_id": "asset_abc123"
    }
  }
}

Rate Limits

Endpoint Group	Limit
Authentication endpoints	1,000 requests/hour
Asset management	5,000 requests/hour
Asset execution	Based on your plan
Marketplace endpoints	10,000 requests/hour

Rate limit headers are included on every response:

X-RateLimit-Limit: 5000
X-RateLimit-Remaining: 4872
X-RateLimit-Reset: 1743516000

Pagination

List endpoints support limit and offset parameters:

# Get page 2 of assets (50 per page)
curl "https://api.spartera.com/companies/{company_id}/assets?limit=50&offset=50" \
  -H "x-api-key: your-api-key"

SDK Support

Official SDKs are available:

Language	Install
Python	`pip install spartera-api-sdk`
JavaScript	`npm install spartera-js-sdk`

# Python SDK example
from spartera_api_sdk import ApiClient, Configuration
from spartera_api_sdk.api import assets_api

config = Configuration()
config.host = "https://api.spartera.com"
config.api_key = {'X-API-Key': 'your-api-key'}

client = ApiClient(config)
assets = assets_api.AssetsApi(client)

# List all your assets
result = assets.companies_company_id_assets_get(company_id)

API Reference

Resource	Description
Authentication	Manage API keys and access
Assets	Create, manage, and execute analytics assets
Connections	Database connection management
Marketplace	Browse and purchase marketplace assets
Users	User and team management
Billing	Credits, invoices, and payouts

OpenAPI Specification

Download the full OpenAPI spec to generate client code for any language:

curl https://api.spartera.com/openapi.yaml -o spartera-api.yaml

Or import directly into Postman, Insomnia, or your preferred API client.