Developers › API reference › Reference data

GET `/api/v1/securities`

The security master.

Scope reference:read
operationId referenceSecurities

The token needs the scope reference:read, and the person or service account behind it needs the matching privileges and account permissions, exactly as on the screens. See Scopes.

Paginated. Cursor pagination: limit (1 to 200, default 50); pass next_cursor as cursor until has_more is false. fields= returns only the named fields.

Request

GET /api/v1/securities

Query parameters

Name	Required	Description
`limit`	no	Page size, 1 to 200 (default 50)
`cursor`	no	The next_cursor of the previous page
`sort`	no	"-id" (newest first, default) or "id"
`fields`	no	Sparse fieldset: comma-separated field names
`symbol`	no	Exact symbol
`sector`	no	Sector
`active`	no	true or false
`isin`	no	ISIN

Headers

Header	Required	Value
`Authorization`	yes	`Bearer <token>`: an OAuth access token (`vat_…`) or a personal access token (`vpt_…`). Get a token

Examples

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

curl

curl "https://vestoris.com/api/v1/securities" \
  -H "Authorization: Bearer $VESTORIS_TOKEN"

Python (requests)

import os, requests

r = requests.get(
    "https://vestoris.com/api/v1/securities",
    headers={
        "Authorization": f"Bearer {os.environ['VESTORIS_TOKEN']}",
    },
    timeout=30,
)
r.raise_for_status()  # errors are application/problem+json with a stable "code"
print(r.json())

JavaScript (fetch)

const res = await fetch("https://vestoris.com/api/v1/securities", {
  method: "GET",
  headers: {
    Authorization: `Bearer ${process.env.VESTORIS_TOKEN}`,
  },
});
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: a page of Security. Rate-limit headers: RateLimit-Limit, RateLimit-Remaining, RateLimit-Reset.

Response fields

Field	Type	Description
`data`	list of Security	The records of this page.
`data[].id`	id (string)	The record's id (a string of digits).
`data[].symbol`	string	Ticker symbol.
`data[].name`	string	The security's name.
`data[].isin`	string or null	ISIN (check digit validated).
`data[].cusip`	string or null	CUSIP (check digit validated).
`data[].sedol`	string or null	SEDOL.
`data[].figi`	string or null	FIGI.
`data[].sec_type`	string	Security type (common, etf, adr…).
`data[].sector`	string	Sector.
`data[].industry`	string	Industry.
`data[].issuer`	string	The issuer's name.
`data[].issuer_code`	string or null	The issuer's code.
`data[].country`	string	Country (ISO 3166 alpha-2).
`data[].asset_class`	string	Asset class, e.g. "Equity".
`data[].market_cap_bucket`	string	Market-cap bucket (mega, large, mid, small).
`data[].currency`	string	Currency (ISO 4217).
`data[].exchange`	string	Exchange code.
`data[].avg_daily_volume`	decimal string or null	Average daily volume in shares (used by liquidity rules).
`data[].esg_flags`	list of string	ESG flags used by exclusion lists.
`data[].active`	boolean	Whether it is in use.
`data[].user_defined`	object	User-defined field values by field name.
`data[].created_at`	date-time or null	When it was created.
`next_cursor`	string or null	Pass as ?cursor= for the next page; null on the last page.
`has_more`	boolean	True when another page follows.

Example response

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

{
    "data": [
        {
            "id": "1042",
            "symbol": "AAPL",
            "name": "Apple Inc.",
            "isin": "US0378331005",
            "cusip": "037833100",
            "sedol": "2046251",
            "figi": "BBG000B9XRY4",
            "sec_type": "common",
            "sector": "Information Technology",
            "industry": "Consumer Electronics",
            "issuer": "Apple Inc.",
            "issuer_code": "AAPL",
            "country": "US",
            "asset_class": "Equity",
            "market_cap_bucket": "mega",
            "currency": "USD",
            "exchange": "XNAS",
            "avg_daily_volume": "58000000",
            "esg_flags": [],
            "active": true,
            "user_defined": {
                "Internal rating": "A"
            },
            "created_at": "2026-10-27T14:30:00Z"
        }
    ],
    "next_cursor": "eyJpZCI6NTI5OX0",
    "has_more": true
}

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.

Status	When	Problem codes
200	Success
400	The request is malformed	`invalid_request`
401	No token, or it is invalid or expired	`invalid_token`
403	The token lacks the scope, or the person or service account behind it lacks the privilege or account permission	`insufficient_scope` `forbidden` `ip_not_allowed`
429	Rate limited: wait for Retry-After seconds	`rate_limited`

{
    "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/securities"
}

On the screens

The same thing in the app is explained in:

Securities and prices