SerenQuantDocs
Sign up
Sign up
© 2026 SerenQuant. All rights reserved.
DocsPrivacyTermsStatusSupport
Docs
Documentation
Start here
Overview
Guide library
GuidesGetting Started: APIGetting Started: MCPAuth + Workspace ScopesAccount and Workspace ManagementMarkets workspaceMarkets Symbol WorkspaceMarket Guides and Beta ScopeFutures ReadinessResearch WorkflowResearch Workbench, Pipeline, and ExperimentsResearch Specialist MethodsResearch Context SurfacesBacktests Run LifecycleBacktests Run Detail and CompareStrategy Sweeps and OptimizerExecution WorkflowProviders and BenchmarkingSettings and Runtime ConfigAgent WorkbenchNews WorkflowDatasets WorkflowGlobal Language SelectionMFA Getting StartedMFA Recovery + Device LossMFA Trusted DevicesMFA API ReferenceLLM Market Analysis LoopStrategy Generation + Backtest LoopPromotion + Risk Guardrails
Reference
API ReferenceMCP Reference
Lifecycle
Changelog
  1. Docs/
  2. Guides/
  3. Getting Started: API
Public docs

Guide: Getting Started API

Quick setup for authenticated API usage in browser and automation contexts.

Before you start

  • Decide whether you are testing a public endpoint first or going straight to a workspace-scoped integration.
  • For authenticated requests, keep your API token and X-Workspace-Id ready.
  • Use a local or staging base URL first so you can validate auth and payload shape safely.
  • Keep /docs/api open beside your editor so you can compare live request and response contracts.

1. Verify basic connectivity

Start with a simple health check to confirm your base URL, network path, and client setup before you add auth or workspace state.

cURL
TypeScript
Python
curl --request GET \
  --url "$SERENQUANT_BASE_URL/api/v1/system/health" \
  --header "Accept: application/json"

2. Send a workspace-scoped request

Once the base URL works, move to an authenticated request that includes both bearer auth and workspace context.

cURL
TypeScript
Python
curl --request GET \
  --url "$SERENQUANT_BASE_URL/api/v1/markets/snapshot?universe=core" \
  --header "Accept: application/json" \
  --header "Authorization: Bearer $SERENQUANT_API_TOKEN" \
  --header "X-Workspace-Id: $SERENQUANT_WORKSPACE_ID"

What success looks like

  • Your connectivity request returns a 200 response without manual tweaking in the docs UI.
  • Your authenticated request includes both Authorization and X-Workspace-Id headers consistently.
  • You can now move from guide snippets into the API reference for exact endpoint-specific schemas and examples.
{
  "ok": true,
  "generated_at": "2026-03-24T00:00:00Z"
}

Next steps

Open API Reference

Inspect exact contracts, auth flags, role requirements, and code examples per endpoint.

Review Auth Model

Understand session vs token flows, workspace headers, and protected-route behavior.

Check Release Notes

Track contract changes before you update generated clients or automation workflows.

Last updated

Mar 24, 2026

Feedback

Report unclear guidance, stale contracts, missing coverage, or broken docs UI on this page.

Open feedback issue
Previous
Guides
Next
Getting Started: MCP
On this page

Jump to the section you need without losing your place.

  • Before you start
  • 1. Verify basic connectivity
  • 2. Send a workspace-scoped request
  • What success looks like
  • Next steps
Last updated

Mar 24, 2026

Feedback

Report unclear guidance, stale contracts, missing coverage, or broken docs UI on this page.

Open feedback issue