For AI agents: the complete documentation index is available at https://docs.snaptrade.com/llms.txt. Markdown versions of documentation pages are available by appending .md to the URL path.
View as Markdown
API Status

Get API Status

get
https://api.snaptrade.com/

Check whether the API is operational and verify timestamps.

Execute an API Request

No request parameters.
Authorization
Request
Installation
$
npm install snaptrade-typescript-sdk
1
import { Snaptrade } from "snaptrade-typescript-sdk";
2
3
const snaptrade = new Snaptrade({
4
clientId: "PARTNER_CLIENT_ID",
5
consumerKey: "CONSUMER_KEY",
6
});
7
8
const response =
9
await snaptrade.apiStatus.check();
10
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
}