Developers › API reference › Meta

GET /api/v1/openapi.json

This API's OpenAPI 3.1 document.

• No token needed
• No token
• operationId metaOpenapi

Request

GET /api/v1/openapi.json

Headers

Examples

Keep the token in an environment variable (VESTORIS_TOKEN), never in the script.

curl "https://vestoris.com/api/v1/openapi.json"

import os, requests

r = requests.get(
    "https://vestoris.com/api/v1/openapi.json",
    timeout=30,
)
r.raise_for_status()  # errors are application/problem+json with a stable "code"
print(r.json())

const res = await fetch("https://vestoris.com/api/v1/openapi.json", {
  method: "GET",
});
const data = await res.json();
if (!res.ok) throw new Error(`${data.code}: ${data.detail}`); // problem+json
console.log(data);

Response

200 OK, application/json: OpenApi.

Example response

HTTP/1.1 200 OK
Content-Type: application/json

{
    "openapi": "3.1.0",
    "info": {
        "title": "Vestoris API",
        "version": "1.4.0"
    },
    "paths": {
        "…": "…"
    }
}

Example values. Your values depend on your firm's data; prices, orders and fills are simulated.

Status codes and errors

Errors are application/problem+json (RFC 9457) with a stable code to program against; the detail says what to fix. See Errors.

{
    "type": "https://vestoris.com/developers/errors#validation_failed",
    "title": "Validation failed",
    "status": 422,
    "detail": "Quantity must be greater than zero.",
    "code": "validation_failed",
    "instance": "/api/v1/openapi.json"
}

On the screens

The same thing in the app is explained in:

• The Vestoris API, in short