Developers › API reference › Reference data

POST /api/v1/securities

Add a security.

• Scope reference:write
• Idempotency-Key
• operationId referenceCreateSecurity

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

Request

POST /api/v1/securities

Headers

Body: SecurityIn

Other fields of the resource are accepted too; unknown fields are reported by a validation problem, never ignored silently.

Decimals (money, prices, quantities, percentages) are sent as strings, ids as strings, times as ISO 8601 UTC.

Examples

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

curl -X POST "https://vestoris.com/api/v1/securities" \
  -H "Authorization: Bearer $VESTORIS_TOKEN" \
  -H 'Idempotency-Key: 7f9c2b1e-4d0a-4a7e-9a51-3c2f0b8d6e11' \
  -H "Content-Type: application/json" \
  -d '{"symbol":"EXMP","name":"Example Corp.","sector":"Industrials","issuer":"Example Corp.","user_defined":{"Internal rating":"BBB"}}'

import os, requests

r = requests.post(
    "https://vestoris.com/api/v1/securities",
    headers={
        "Authorization": f"Bearer {os.environ['VESTORIS_TOKEN']}",
        "Idempotency-Key": "7f9c2b1e-4d0a-4a7e-9a51-3c2f0b8d6e11",
    },
    json={
        "symbol": "EXMP",
        "name": "Example Corp.",
        "sector": "Industrials",
        "issuer": "Example Corp.",
        "user_defined": {
            "Internal rating": "BBB"
        }
    },
    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/securities", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.VESTORIS_TOKEN}`,
    "Idempotency-Key": "7f9c2b1e-4d0a-4a7e-9a51-3c2f0b8d6e11",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
      "symbol": "EXMP",
      "name": "Example Corp.",
      "sector": "Industrials",
      "issuer": "Example Corp.",
      "user_defined": {
          "Internal rating": "BBB"
      }
  }),
});
const data = await res.json();
if (!res.ok) throw new Error(`${data.code}: ${data.detail}`); // problem+json
console.log(data);

Response

201 Created, application/json: Security. Rate-limit headers: RateLimit-Limit, RateLimit-Remaining, RateLimit-Reset.

Example response

HTTP/1.1 201 Created
Content-Type: application/json

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

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

On the screens

The same thing in the app is explained in:

• Securities and prices