For AI agents: the documentation index is available at https://docs.snaptrade.com/llms.txt, and the comprehensive documentation index is available at https://docs.snaptrade.com/llms-full.txt. The complete public OpenAPI specification is available at https://docs.snaptrade.com/openapi.yaml. Complete public OpenAPI specification with all documented operations, schemas, servers, and authentication requirements. Use it for SDK generation and API tooling; beta operations are marked x-beta. Markdown versions of documentation pages are available by appending .md to the URL path.
logo
Book A Demo
Book A Demo
View as Markdown
Full OpenAPI Spec
API Status

Get API Status

get
https://api.snaptrade.com/

Check whether the API is operational and verify timestamps.

Execute an API Request

This endpoint does not require authentication or request parameters.
Request
Installation
GitHubnpm
$
npm install snaptrade-typescript-sdk
1
import { Snaptrade } from "snaptrade-typescript-sdk";
2


3
const snaptrade = new Snaptrade({});
4


5
const response =
6
  await snaptrade.apiStatus.check();
7
console.log(response.data);

Response fields

object

Status of API

versioninteger
timestampstring
onlineboolean
1
{
2
  "version": 153,
3
  "timestamp": "2022-11-04T01:47:00.377Z",
4
  "online": true
5
}