{ "openapi": "3.0.3", "x-speakeasy-retries": { "strategy": "backoff", "statusCodes": [ 429, 500, 502, 503 ], "backoff": { "initialInterval": 500, "maxInterval": 60000, "maxElapsedTime": 3600000, "exponent": 1.5 }, "retryConnectionErrors": true }, "info": { "contact": { "email": "dev@aries.com", "name": "Aries Financial" }, "description": "OpenAPI Specification for the Aries trading platform API.\n\n# Authentication\n\nLearn how to authenticate with the Aries API using OAuth2 and manage access tokens in your SDK.\n\n## Overview\n\nThe Aries API uses **OAuth2 with Bearer tokens** (JWT format) for authentication. All API requests require a valid access token in the `Authorization` header:\n\n```\nAuthorization: Bearer \n```\n\n## Providing Client ID and Client Secret (SDK)\n\nWhen using the generated SDK, provide your **Client ID** and **Client Secret** when you create the API client (e.g. in the constructor or security options). The SDK will use these to obtain and refresh the access token internally; you do not need to manage tokens yourself.\n\nObtain your OAuth2 credentials from the Aries platform (e.g. Client Center / Manage Account at https://app.aries.com):\n\n- **Client ID** – Your application identifier (pass to SDK client)\n- **Client Secret** – Your application secret key (pass to SDK client; use PKCE for public clients where secret cannot be stored)\n\n## Authentication Flow\n\n### 1. Authorization Code Flow\n\nFor server-side or confidential clients:\n\n1. **Redirect the user** to the authorization URL to sign in and consent:\n - **URL:** `https://app.aries.com/oauth2/authorize`\n - **Query params:** `response_type=code`, `client_id`, `redirect_uri`, `scope`, `state`\n\n2. **Exchange the code for tokens** (after user is redirected back with `?code=.`):\n - **POST** `https://api.aries.com/v1/oauth2/token`\n - **Body:** `grant_type=authorization_code`, `code`, `redirect_uri`, `client_id`, `client_secret`\n - Response includes `access_token` and `refresh_token`\n\n3. **Call the API** with the access token: `Authorization: Bearer `\n\n### 2. PKCE Flow\n\nFor SPAs and mobile apps (public clients that cannot store `client_secret`):\n\n1. Generate a **code_verifier** (random string) and **code_challenge** = BASE64URL(SHA256(code_verifier)).\n2. **Redirect the user** to `https://app.aries.com/oauth2/authorize` with `code_challenge`, `code_challenge_method=S256`, plus `client_id`, `redirect_uri`, `scope`, `state`.\n3. **Exchange the code** at POST `https://api.aries.com/v1/oauth2/token` with `grant_type=authorization_code`, `code`, `redirect_uri`, `client_id`, `code_verifier` (no client_secret).\n4. Use the returned `access_token` as Bearer.\n\n### 3. MFA Verification\n\nIf the user has MFA enabled, the authorize step may return `is_mfa: true` and a `next_step_auth_id`. Call **POST** `https://api.aries.com/v1/oauth2/authorize/mfa` with `next_step_auth_id` and `verification_code` (6-digit code). Then continue with **POST** `/v1/oauth2/authorize/confirm` to get the authorization code, and exchange it at `/v1/oauth2/token`.\n\n## Token Management\n\n- **Refresh when expired:** POST `https://api.aries.com/v1/oauth2/token` with `grant_type=refresh_token`, `client_id`, `client_secret`, `refresh_token`.\n- **Using a Bearer token directly:** If you already have an access token, set the header `Authorization: Bearer ` on every request. The SDK can accept a pre-obtained token and use it until it expires.\n\n## OAuth2 Scopes\n\nRequest only the scopes your application needs. Available scopes:\n\n| Scope | Description |\n|-------|-------------|\n| `user:information` | View user profile and personal details |\n| `account:information` | View account balances, positions, and transaction history |\n| `order:execution` | Place, modify, and cancel orders |\n| `order:information` | View order history and status |\n| `position:information` | View current positions and holdings |\n| `market:information` | Access live and historical market data |\n| `calendar:information` | Access earnings, economic, and market schedule data |\n| `options:information` | Access options chains and expiration data |\n| `analytics:information` | View analytics, ratings, and market insights |\n| `market:supplemental` | News, company profiles, financials, filings, ETF data, technical analysis |\n\nSpecify multiple scopes as a space-separated string, e.g. `account:information order:execution market:information`.\n\n## Security Best Practices\n\n- **Store credentials securely** – Use environment variables or a secrets manager for `client_id` and `client_secret`. Never hardcode them.\n- **Handle token expiration** – Check for 401 responses and refresh the token using the refresh_token, then retry the request.\n- **Use HTTPS** – All authorization and token endpoints must be called over HTTPS.\n- **Validate state** – When using the authorization code flow, validate the `state` parameter on the callback to prevent CSRF.\n\n## Error Handling\n\n- **400 Bad Request** – Invalid or missing parameters, validation failures, or malformed JSON. Response bodies follow the same patterns as other errors (flat `error` string, optional `codes`, nested `error` object, or rarely no body).\n\n- **401 Unauthorized** – Invalid or expired access token; refresh the token or re-authenticate. JSON bodies are not identical on every route: you may see a flat `error` string (sometimes with `codes`), a nested `error` object (`type`, `code`, `message`), or rarely an empty body\n\n- **403 Forbidden** – Insufficient scope or permissions for the requested resource. Error JSON may be flat or nested, like 400/401.\n\n- **404 Not Found** – Resource does not exist or is not visible. Error JSON may be flat or nested.\n\n- **429 Too Many Requests** – Rate limit exceeded; slow down and respect `Retry-After` when the header is present. Error JSON may be flat or nested.\n\n- **500 / 5xx** – Server or upstream failure; retry with backoff. Do not depend on a single error JSON shape; some responses may have no body.\n\n\n---\n\nEndpoints in this spec: health, OAuth2 (authorize, confirm, mfa, token), users, accounts, orders, market data, watchlist, chart, analytics, calendars, company, economy, financials, indices, options, news, and supplemental data.", "title": "Aries API — OpenAPI Specification", "version": "1.0.0" }, "servers": [ { "description": "Production server", "url": "https://api.aries.com" } ], "tags": [ { "description": "Analytics endpoints for market data analysis including top gainers, losers, volume leaders, sector analysis, analyst ratings, market breadth, and net inflow", "name": "Analytics" }, { "description": "User management and profile endpoints", "name": "Users" }, { "description": "Order management endpoints for placing, updating, canceling, and previewing orders", "name": "Orders" }, { "description": "Account management endpoints for positions, orders, and balances", "name": "Accounts" }, { "description": "Calendar and mergers/acquisitions endpoints", "name": "Calendar" }, { "description": "Market data endpoints for symbol search, real-time data access, and equity details", "name": "Market Data" }, { "description": "Watchlist endpoints for listing, creating, updating, and deleting watchlists", "name": "Watchlist" }, { "description": "Chart endpoints for config, symbols, history, quotes, and server time", "name": "Chart" }, { "description": "News and news sentiment endpoints", "name": "News" }, { "description": "Indices endpoints for groups, list, search, bar, bars, chart-bars, realtime values", "name": "Indices" }, { "description": "Logos search and sync endpoints", "name": "Logos" }, { "description": "Corporate actions: spinoffs, tender offers, IPO calendar, dividends", "name": "Corporate Actions" }, { "description": "Economy endpoints: inflation, inflation expectations, treasury yields", "name": "Economy" }, { "description": "Options endpoints: expiry dates, contracts, activity, trades, quotes, unusual activity", "name": "Options" }, { "description": "Financials: reported, statements, revenue breakdown, short volume, ratios, short interest", "name": "Financials" }, { "description": "Signals and bull-bear cases", "name": "Signals" }, { "name": "Company" }, { "name": "ETF" }, { "name": "Filings" }, { "name": "Market" }, { "name": "Ownership" }, { "name": "Stocks" }, { "name": "Stock Estimates" }, { "name": "Stock Alternative", "description": "Transcripts, company presentation, social sentiment, investment themes, supply chain, and ESG data" }, { "name": "Technical Analysis" } ], "paths": { "/v1/oauth2/token": { "post": { "tags": [ "OAuth2" ], "summary": "Exchange OAuth2 code or refresh token", "description": "Exchanges an authorization code for access and refresh tokens, exchanges a PKCE authorization code using a `code_verifier`, or refreshes an existing access token using a refresh token. This endpoint issues tokens and does not require an existing Bearer token.", "operationId": "oauth2Token", "security": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/OAuth2TokenAuthorizationCodeRequest" }, { "$ref": "#/components/schemas/OAuth2TokenPkceRequest" }, { "$ref": "#/components/schemas/OAuth2TokenRefreshRequest" } ] }, "examples": { "authorizationCode": { "summary": "Authorization Code", "value": { "grant_type": "authorization_code", "code": "auth_code_abc123xyz789def456", "client_id": "client_abc123xyz", "client_secret": "secret_xyz789abc", "redirect_uri": "https://yourapp.com/callback" } }, "pkce": { "summary": "PKCE", "value": { "grant_type": "authorization_code", "code": "auth_code_abc123xyz789def456", "client_id": "client_abc123xyz", "redirect_uri": "https://yourapp.com/callback", "code_verifier": "verifier_abc123xyz789def456" } }, "refreshToken": { "summary": "Refresh Token", "value": { "grant_type": "refresh_token", "refresh_token": "refresh_token_abc123xyz789def456", "client_id": "client_abc123xyz", "client_secret": "secret_xyz789abc" } } } } } }, "responses": { "200": { "description": "Tokens issued successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OAuth2TokenResponse" }, "example": { "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIn0.signature", "refresh_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJyZWYiOiIxMjM0NTY3ODkwIn0.signature", "token_type": "Bearer", "expires_in": 3600, "refresh_token_expires_in": 2592000, "scope": "read write" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimitExceeded" }, "500": { "$ref": "#/components/responses/InternalServerError" } } } }, "/v1/accounts/{id}/balances": { "get": { "description": "Retrieve account balances, cash, equity, and buying power for a specific account. Use this before showing an order ticket or checking whether the account can support a trade.", "operationId": "getAccountBalances", "parameters": [ { "description": "Account whose balances you want to read. Enter the account ID from `GET /v1/users/me/accounts`.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountBalance" }, "example": { "accountId": "TEST-ACCOUNT-001", "dayTradeBuyingPower": "50000.00", "netBuyingPower": "125000.50", "optionBuyingPower": "25000.00", "stockBuyingPower": "125000.50", "totalEquity": "250000.00", "realizedPl": "1500.25", "unrealizedPl": "-250.75", "settledFunds": "100000.00", "unsettledFunds": "5000.00", "startOfDayCash": "95000.00", "maintReq": "75000.00", "grossMargin": "120000.00", "sma": "0", "credit": "0", "creditRemaining": "0", "pdt": "0", "pdtCreditRemaining": "0", "pendingOrdersCount": 2, "pendingOrdersMarginRequirements": "2500.00", "valueBought": "45000.00", "valueSold": "12000.00", "dayTradeOvernightRegTBuyingPower": "48000.00", "heldBackFunds": "0", "sodPositionsMarketValue": "180000.00", "sodTtlEquity": "248000.00", "sodTtlEquityUpdatedAt": "2026-01-15T09:30:00Z" } } }, "description": "Account balances retrieved successfully" }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimitExceeded" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "security": [ { "OAuth2": [ "account:information" ] } ], "summary": "Get Account Balances", "tags": [ "Accounts" ] } }, "/v2/accounts/{id}/balance": { "get": { "description": "Retrieve account balance, cash, equity, and buying power for a specific account (v2). Use this before showing an order ticket or checking whether the account can support a trade.", "operationId": "getAccountBalanceV2", "parameters": [ { "description": "Account whose balance you want to read. Enter the account ID from `GET /v1/users/me/accounts`.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountBalanceV2" }, "example": { "balance": "248874.14377781", "accountId": "TEST-ACCOUNT-001", "dayTradeBuyingPower": "50000", "netBuyingPower": "125000.5", "optionBuyingPower": "25000", "stockBuyingPower": "125000.5", "realizedPl": "37.5", "unrealizedPl": "836.64377781", "openPnl": "836.64377781", "dayOpenPnl": "512.14", "dayRealizedPnl": "37.5", "dayTotalPnl": "549.64", "costOfPositions": "180000", "settledFunds": "100000", "unsettledFunds": "5000", "cashBalance": "105000", "amountAvailableToWithdraw": "100000", "startOfDayCash": "95000", "maintReq": "75000", "grossMargin": "120000", "sma": "0", "credit": "0", "creditRemaining": "0", "pdt": "0", "pdtCreditRemaining": "0", "pendingOrdersCount": 0, "pendingOrdersMarginRequirements": "0", "valueBought": "45000", "valueSold": "12000", "dayTradeOvernightRegTBuyingPower": "48000", "heldBackFunds": "0", "sodPositionsMarketValue": "180000", "sodTtlEquity": "248000", "sodTtlEquityUpdatedAt": "2026-01-15T09:30:00Z", "smaCreditRemaining": "0" } } }, "description": "Account balance retrieved successfully" }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimitExceeded" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "security": [ { "OAuth2": [ "account:information" ] } ], "summary": "Get Account Balance", "tags": [ "Accounts" ] } }, "/v2/accounts/{id}/orders": { "get": { "tags": [ "Orders" ], "summary": "List active orders (v2)", "description": "Returns active orders for an account: open orders plus today's terminal activity. By default reads from the **orders v2 cache**; pass `source=db` to page from PostgreSQL instead.\n\n**Pagination:** Opaque `int64` cursors. Send `cursor=0` for the first page, then the prior response's `nextCursor`. `nextCursor` of `0` means no more pages. **Do not change `source` while paginating** — cache cursors (ZSET offsets) are not valid for DB reads and vice versa.\n\n**Response shape:** Each element is the v2 domain order (`domains/order.Order`) — the same JSON shape as cache v2 and WebSocket `accUpdates` snapshots, so you can merge live updates with REST by `clOrdId` without field remapping.", "operationId": "getOrdersV2", "parameters": [ { "description": "Account ID whose active orders you want to read. Use the account identifier from the user's account list or trading setup.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "description": "Where to read orders from. Use `cache` for live screens and order tickets. Use `db` when you need the stored database view. Keep the same source while paginating.", "in": "query", "name": "source", "required": false, "schema": { "type": "string", "enum": [ "cache", "db" ] } }, { "description": "Maximum number of orders to return in this page. Use smaller values for UI lists and larger values for back-office exports. Default is 50; maximum is 500.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 500, "default": 50 } }, { "description": "Opaque pagination cursor. Send `0` (or omit) for the first page; pass the previous response's `nextCursor` for subsequent pages. Stop when `nextCursor` is `0`.", "in": "query", "name": "cursor", "required": false, "schema": { "type": "integer", "format": "int64", "default": 0 } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetOrdersV2Response" }, "example": { "orders": [ { "clOrdId": "clord-20260115-aapl-001", "ordId": "ord-7f3a9c2e-0001", "accountId": "TEST-ACCOUNT-001", "clientId": "demo-oauth-client", "symbol": "AAPL", "side": "BUY", "type": "LIMIT", "timeInForce": "DAY", "qty": "100", "price": "175.50", "stopPrice": "", "ordStatus": "NEW", "cumQty": "0", "leavesQty": "100", "avgPrice": "0", "currency": "USD", "exDestination": "MNGD", "text": "", "ordRejReason": "", "securityType": "CS", "category": "SINGLE_LEG", "legs": [], "createdAt": "2026-01-15T14:30:00Z", "updatedAt": "2026-01-15T14:30:05Z" } ], "nextCursor": 0 } } }, "description": "Page of active orders" }, "400": { "description": "Bad request — unknown `source` or other validation error. Returns a flat `ErrorResponse` (`error` string).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "invalid_source": { "summary": "Unknown source", "value": { "error": "invalid source: \"elasticsearch\"" } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimitExceeded" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "security": [ { "OAuth2": [ "order:information" ] } ] } }, "/v2/accounts/{id}/orders/history": { "get": { "tags": [ "Orders" ], "summary": "List order history (v2)", "description": "Date-range query against **PostgreSQL** only (no `source` parameter). `from` is required; `to` defaults to the current time truncated to the minute (UTC). The server caps the window at **90 days**.\n\nResults are ordered and filtered by `order_created_at` (keyset pagination uses the row `id` for correctness). Rows with `SUPERSEDED` status and rows with `failed_flag = true` are excluded.\n\nSet `exclude_today=true` to narrow `to` to just before midnight **America/New_York**, omitting today's activity (already returned by **GET /v2/accounts/{id}/orders**).\n\n**Pagination:** Same opaque `int64` cursor contract as active orders when reading from DB — `cursor=0` first, then `nextCursor`; `0` means exhausted.", "operationId": "getOrdersHistoryV2", "parameters": [ { "description": "Account ID whose historical orders you want to read.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "description": "Start of the history window, inclusive. Enter an RFC 3339 timestamp with timezone, for example `2026-04-01T00:00:00Z`.", "in": "query", "name": "from", "required": true, "schema": { "format": "date-time", "type": "string" } }, { "description": "End of the history window, inclusive. Omit it to use the current time. The total range from `from` cannot exceed 90 days.", "in": "query", "name": "to", "required": false, "schema": { "format": "date-time", "type": "string" } }, { "description": "Sort direction by `order_created_at`. Defaults to `desc` (newest first). Use `asc` for chronological exports.", "in": "query", "name": "order_by", "required": false, "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "description": "Set to `true` when you want historical orders only and do not want today's activity duplicated with the active-orders endpoint.", "in": "query", "name": "exclude_today", "required": false, "schema": { "type": "boolean", "default": false } }, { "description": "Maximum number of historical orders to return in this page. Default is 50; maximum is 500.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 500, "default": 50 } }, { "description": "Opaque pagination cursor for the database history walk. Send `0` (or omit) for the first page; pass the previous `nextCursor` until it returns `0`.", "in": "query", "name": "cursor", "required": false, "schema": { "type": "integer", "format": "int64", "default": 0 } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetOrdersV2Response" }, "example": { "orders": [ { "clOrdId": "clord-20260310-msft-001", "ordId": "ord-hist-0001", "accountId": "TEST-ACCOUNT-001", "clientId": "demo-oauth-client", "symbol": "MSFT", "side": "SELL", "type": "LIMIT", "timeInForce": "DAY", "qty": "10", "price": "410.00", "stopPrice": "", "ordStatus": "FILLED", "cumQty": "10", "leavesQty": "0", "avgPrice": "410.25", "currency": "USD", "exDestination": "MNGD", "text": "", "ordRejReason": "", "securityType": "CS", "category": "SINGLE_LEG", "legs": [], "createdAt": "2026-03-10T15:00:00Z", "updatedAt": "2026-03-10T15:00:12Z" } ], "nextCursor": 0 } } }, "description": "Page of historical orders" }, "400": { "description": "Bad request — missing or invalid `from`/`to`, range over 90 days, or invalid `order_by`. Returns a flat `ErrorResponse` (`error` string).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "from_required": { "summary": "Missing from", "value": { "error": "from is required" } }, "invalid_from": { "summary": "Malformed timestamp", "value": { "error": "invalid from: parsing time \"2006-01-02T15:04:05Z07:00\" as \"2006-01-02T15:04:05Z07:00\": cannot parse \"\" as \"Z07:00\"" } }, "invalid_order_by": { "summary": "Invalid sort direction", "value": { "error": "order_by must be asc or desc" } }, "range_exceeded": { "summary": "Window over 90 days", "value": { "error": "range exceeds 90 days" } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimitExceeded" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "security": [ { "OAuth2": [ "order:information" ] } ] } }, "/v1/accounts/{id}/positions": { "get": { "description": "Retrieve all open positions for a specific account. Use this for portfolio screens and pre-trade checks before selling or closing a position.", "operationId": "getAccountPositions", "parameters": [ { "description": "Account whose positions you want to read. Enter the account ID from [User Accounts](/api-reference/accounts/user-accounts).", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetPositionsResponse" }, "example": { "positions": [ { "accountId": "TEST-ACCOUNT-001", "symbol": "AAPL", "securityType": "EQUITY", "quantity": "100", "averagePrice": "170.25", "price": "175.40", "todayRealizedPnL": "0", "unrealizedPl": "515.00", "todayPl": "125.00", "marketValue": "17540.00", "costBasis": "17025.00", "createdAt": "2026-01-10T16:00:00Z" } ] } } }, "description": "Account positions retrieved successfully" }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimitExceeded" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "security": [ { "OAuth2": [ "account:information" ] } ], "summary": "Get Account Positions", "tags": [ "Accounts" ] } }, "/v1/analytics/market-breadth": { "get": { "description": "Retrieve market breadth data showing advancers vs decliners", "operationId": "getMarketBreadth", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/MarketBreadth" } } }, "example": { "success": true, "data": { "advanceDeclineRatio": 1.85, "advancers": 2840, "advancersPercent": 62.5, "decliners": 1532, "declinersPercent": 33.7, "timestamp": "2026-03-09T13:48:11.726532Z", "totalSymbols": 4544, "unchanged": 172 } } } }, "description": "Market breadth data retrieved successfully" }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "security": [ { "OAuth2": [ "analytics:information" ] } ], "summary": "Get Market Breadth", "tags": [ "Analytics" ], "parameters": [] } }, "/v1/analytics/net-inflow": { "get": { "description": "Retrieve net inflow data for NASDAQ and NYSE", "operationId": "getNetInflow", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/NetInflow" } } }, "example": { "success": true, "data": { "nasdaqNetInflow": 125000000.5, "nasdaqTradeCount": 8500000, "nyseNetInflow": 98000000.25, "nyseTradeCount": 6200000, "timestamp": "2026-03-09T13:48:11.726532Z" } } } }, "description": "Net inflow data retrieved successfully" }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "security": [ { "OAuth2": [ "analytics:information" ] } ], "summary": "Get Net Inflow", "tags": [ "Analytics" ], "parameters": [] } }, "/v1/analytics/ratings": { "get": { "description": "Retrieve analyst ratings for stocks. All query parameters are optional.", "operationId": "getRatings", "parameters": [ { "description": "Comma-separated list of ticker symbols to filter by", "in": "query", "name": "tickers", "schema": { "example": "AAPL,GOOGL", "type": "string" } }, { "description": "Page number for pagination (0-based)", "in": "query", "name": "page", "schema": { "minimum": 0, "type": "integer" } }, { "description": "Number of results per page. Use this to control pagination size in list views.", "in": "query", "name": "pageSize", "schema": { "minimum": 1, "type": "integer" } }, { "description": "Filter by specific date (YYYY-MM-DD)", "in": "query", "name": "date", "schema": { "format": "date", "type": "string" } }, { "description": "Start date for date range (YYYY-MM-DD)", "in": "query", "name": "dateFrom", "schema": { "format": "date", "type": "string" } }, { "description": "End date for date range (YYYY-MM-DD)", "in": "query", "name": "dateTo", "schema": { "format": "date", "type": "string" } }, { "description": "Minimum importance level to include. Use higher values to filter for more market-moving events or ratings.", "in": "query", "name": "importance", "schema": { "type": "integer" } }, { "description": "Rating action filter. Use it to return only upgrades, downgrades, initiations, or other supported action types.", "in": "query", "name": "action", "schema": { "type": "string" } }, { "description": "Comma-separated analyst IDs. Use this to limit insight results to specific analysts. to filter by", "in": "query", "name": "analystId", "schema": { "type": "string" } }, { "description": "Comma-separated firm IDs to filter by", "in": "query", "name": "firmId", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetRatingsResponse" }, "example": { "ratings": [ { "id": "rate-1001", "date": "2026-01-12", "time": "09:45:00", "ticker": "AAPL", "exchange": "NASDAQ", "name": "Apple Inc.", "currency": "USD", "action_pt": "raised", "action_company": "maintain", "rating_current": "Buy", "rating_prior": "Hold", "pt_current": 210, "pt_current_adjusted": 208.5, "pt_prior": 195, "pt_prior_adjusted": 194, "analyst": "jdoe", "analyst_id": "an-9001", "analyst_name": "Jane Doe", "ratings_accuracy": { "smart_score": 72.5, "success_rate": 0.68, "total_ratings": 140, "gain_count_1m": 8, "loss_count_1m": 3, "avg_return_1m": 0.021, "std_dev_return_1m": 0.045, "gain_count_3m": 22, "loss_count_3m": 9, "avg_return_3m": 0.055, "std_dev_return_3m": 0.09, "gain_count_9m": 58, "loss_count_9m": 21, "avg_return_9m": 0.12, "std_dev_return_9m": 0.14, "gain_count_1y": 72, "loss_count_1y": 28, "avg_return_1y": 0.18, "std_dev_return_1y": 0.22, "gain_count_2y": 130, "loss_count_2y": 48, "avg_return_2y": 0.31, "std_dev_return_2y": 0.28, "gain_count_3y": 180, "loss_count_3y": 65, "avg_return_3y": 0.42, "std_dev_return_3y": 0.33 }, "importance": 2, "notes": "Services outlook improved.", "updated": "2026-01-12T09:45:00Z" } ] } } }, "description": "Analyst ratings. Response has a ratings array; each item may include id, date, time, ticker, exchange, name, currency, action_pt, action_company, rating_current, rating_prior, pt_current, pt_current_adjusted, pt_prior, pt_prior_adjusted, analyst, analyst_id, analyst_name, importance, updated. Some fields may be absent when empty." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "security": [ { "OAuth2": [ "analytics:information" ] } ], "summary": "Get Analyst Ratings", "tags": [ "Analytics" ] } }, "/v1/analytics/insights": { "get": { "summary": "Get Analyst Insights", "description": "Retrieve analyst insights and research data. All query parameters are optional. Supports pagination and filtering by symbols, analyst, ratingId, and firm.", "parameters": [ { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0 }, "description": "Zero-based page number. Enter 0 for the first page, 1 for the second page, and so on." }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 1000 }, "description": "Number of results per page. Use this to control pagination size in list views. Use this to control page size; default is 10." }, { "name": "symbols", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Comma-separated ticker symbols, such as AAPL,MSFT. Use this to request or filter multiple companies in one call. (e.g. AAPL,MSFT)" }, { "name": "analyst", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Comma-separated analyst IDs. Use this to limit insight results to specific analysts." }, { "name": "ratingId", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Comma-separated rating IDs. Use this to limit insight results to specific rating records." }, { "name": "searchKeysType", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "firm_id", "firm" ] }, "description": "Tells the API how to interpret the value you send in `searchKeys`. Allowed values:\n- `firm_id` — the value is a firm/company internal ID.\n- `firm` — the value is the firm/company name." }, { "name": "searchKeys", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Search key value (based on searchKeysType)" } ], "responses": { "200": { "description": "Analyst insights. Each item may include id, date, updated, action, rating, ratingId, pt, firm, firmId, analystInsights, security (cik, exchange, isin, name, symbol).", "content": { "application/json": { "schema": { "type": "object", "properties": { "insights": { "type": "array", "items": { "$ref": "#/components/schemas/AnalystInsightItem" } } } }, "example": { "insights": [ { "id": "insight-001", "date": "2026-01-10", "updated": 1736534400, "action": "Upgrade", "rating": "Buy", "ratingId": "r-8821", "pt": "210.00", "firm": "Demo Research", "firmId": "firm-42", "analystInsights": "Raised price target on stronger services revenue.", "security": { "cik": "0000320193", "exchange": "NASDAQ", "isin": "US0378331005", "name": "Apple Inc.", "symbol": "AAPL" } } ] } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "tags": [ "Analytics" ], "security": [ { "OAuth2": [ "analytics:information" ] } ], "operationId": "get_v1_analytics_insights" } }, "/v1/stock/screener": { "post": { "tags": [ "Analytics" ], "summary": "Stock Screener", "description": "Screen securities by sending a JSON body with operator and clauses (and optional groups). At least one clause or group is required. Query params: page_size, order_column, order_direction, primary_only. **Required scope:** analytics:information", "operationId": "stockScreener", "parameters": [ { "name": "page_size", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 50000 }, "description": "Number of results to return per page. Use smaller values (10–50) for UI screens, larger (100–500) for batch exports. Defaults to the upstream provider's default." }, { "name": "order_column", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Which data column to sort the screened results by. Accepts any column the upstream screener exposes — not a fixed enum on our side. Common columns:\n- `marketcap` — market capitalization.\n- `pricetoearnings` — trailing P/E ratio.\n- `pricetobook` — price-to-book ratio.\n- `roe` — return on equity.\n- `volume` — average daily volume.\n- `open_price` / `close_price` — most recent open / close.\n- `dilutedeps` — diluted earnings per share (TTM).\n- `cashandequivalents` — cash + cash equivalents on the balance sheet.\n\nPair with `order_direction` (`asc` / `desc`)." }, { "name": "order_direction", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/SortOrderEnum" }, "description": "Direction to sort `order_column` in:\n- `asc` — ascending (smallest first).\n- `desc` — descending (largest first)." }, { "name": "primary_only", "in": "query", "required": false, "schema": { "type": "string" }, "description": "When `true`, return only the primary listing for each company (e.g. NYSE for a U.S. dual-listed stock) instead of every listing. Defaults to `false`." } ], "requestBody": { "description": "Screener request with operator (AND/OR), clauses (field, operator, value), and optional groups.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StockScreenerRequest" }, "examples": { "marketCapAndPE": { "summary": "Market cap and P/E filter", "value": { "operator": "AND", "clauses": [ { "field": "marketcap", "operator": "gte", "value": "1000000000" }, { "field": "pricetoearnings", "operator": "gte", "value": "5" }, { "field": "pricetoearnings", "operator": "lte", "value": "25" } ] } }, "roeAndEps": { "summary": "ROE and EPS filter", "value": { "operator": "AND", "clauses": [ { "field": "roe", "operator": "gte", "value": "0.15" }, { "field": "dilutedeps", "operator": "gte", "value": "1" } ] } } } } } }, "responses": { "200": { "description": "Array of screened securities; each item has security (id, ticker, name, etc.) and data (array of tag, number_value, text_value)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StockScreenerResponse" }, "example": [ { "security": { "id": "sec_XaL6mg", "company_id": "com_qzEByJ", "stock_exchange_id": "sxg_ozMr9y", "exchange": null, "exchange_mic": null, "name": "Microsoft Corporation", "code": null, "currency": null, "ticker": "MSFT", "composite_ticker": "MSFT:US", "figi": "BBG000BPHFS9", "composite_figi": null, "share_class_figi": null, "primary_listing": null }, "data": [ { "tag": "pricetoearnings", "number_value": 24.2204, "text_value": null }, { "tag": "marketcap", "number_value": 2888569710564, "text_value": null } ] } ] } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "security": [ { "OAuth2": [ "analytics:information" ] } ] } }, "/v1/calendars/earnings": { "get": { "description": "Retrieve upcoming earnings release dates and historical earnings announcement schedules for earnings season planning.", "operationId": "getEarningsCalendar", "parameters": [ { "description": "Start date in YYYY-MM-DD format. Enter the first date to include in the research window.", "in": "query", "name": "from", "required": true, "schema": { "example": "2024-01-01", "format": "date", "type": "string" } }, { "description": "End date in YYYY-MM-DD format. Enter the last date to include in the research window.", "in": "query", "name": "to", "required": true, "schema": { "example": "2024-01-31", "format": "date", "type": "string" } }, { "description": "Optional stock symbol to filter results. If not provided, returns earnings for all symbols.", "in": "query", "name": "symbol", "schema": { "example": "AAPL", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetEarningsCalendarResponse" }, "examples": { "success": { "value": [ { "date": "2024-01-16", "symbol": "AAPL", "name": "Apple Inc.", "hour": "amc", "quarter": 1, "year": 2024, "epsActual": 2.18, "epsEstimate": 2.1, "epsSurprise": 0.08, "revenueActual": 119580000000, "revenueEstimate": 118000000000, "revenueSurprise": 1580000000, "marketCap": 2850000, "logo": { "logoLight": "https://example.com/aapl-light.png", "logoDark": "https://example.com/aapl-dark.png" }, "analystRating": { "currentRating": "Buy", "priceTarget": 200.5, "totalRatings": 45, "successRate": "72%", "averageReturn": "15.3%" } } ] } } } }, "description": "Earnings calendar data retrieved successfully" }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "security": [ { "OAuth2": [ "calendar:information" ] } ], "summary": "Get Earnings Calendar", "tags": [ "Calendar" ] } }, "/v1/calendars/economics": { "get": { "description": "Retrieve scheduled economic data releases including employment reports, GDP announcements, inflation data, and central bank decisions.", "operationId": "getEconomicsCalendar", "parameters": [ { "description": "Date in YYYY-MM-DD format. Enter the specific calendar date you want to query.", "in": "query", "name": "date", "required": true, "schema": { "example": "2024-01-15", "format": "date", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetEconomicsCalendarResponse" }, "example": { "events": [ { "calendarID": "te_395222", "date": "2026-03-05", "time": "13:30:00", "country": "United States", "category": "Continuing Jobless Claims", "event": "Continuing Jobless Claims", "importance": 1, "reference": "Feb/21", "referenceDate": "2026-02-21T00:00:00", "previous": "1833K", "forecast": "1850K", "teForecast": "1840.0K", "source": "U.S. Department of Labor", "sourceUrl": "http://www.dol.gov", "unit": "K", "ticker": "UNITEDSTACONJOBCLA", "symbol": "UNITEDSTACONJOBCLA", "lastUpdate": "2026-03-03T10:49:26.58" } ] } } }, "description": "Economics calendar events retrieved successfully" }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "security": [ { "OAuth2": [ "calendar:information" ] } ], "summary": "Get Economics Calendar", "tags": [ "Calendar" ] } }, "/v1/calendars/historical/{symbol}": { "get": { "description": "Retrieve historical time series data for an economic indicator. Returns a direct array of data points (no wrapper). Path parameter **symbol** is the economic indicator symbol (e.g. USURTOT, UNITEDSTACONJOBCLA, UNITEDSTACONCRE). No query parameters.", "operationId": "getHistoricalData", "parameters": [ { "description": "Economic indicator code from the upstream calendar provider. These codes are not a fixed enum on our side — fetch [GET /v1/calendars/economics](/api-reference/calendars/economics) to see the codes attached to recent calendar entries, then use that code here for the historical series. Common examples:\n- `USURTOT` — United States Unemployment Rate (total).\n- `UNITEDSTACONJOBCLA` — U.S. Continuing Jobless Claims.\n- `UNITEDSTACONCRE` — U.S. Consumer Credit.", "in": "path", "name": "symbol", "required": true, "schema": { "example": "USURTOT", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetHistoricalDataResponse" }, "example": [ { "category": "Employment", "country": "US", "dateTime": "2026-01-15T08:30:00Z", "frequency": "monthly", "historicalDataSymbol": "USURTOT", "lastUpdate": "2026-01-15T08:30:00Z", "value": 3.7 } ] } }, "description": "Economic indicator historical data retrieved successfully" }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "security": [ { "OAuth2": [ "calendar:information" ] } ], "summary": "Get Historical Economic Data", "tags": [ "Calendar" ] } }, "/v1/chart/config": { "get": { "description": "Returns the chart configuration including supported resolutions and charting capabilities. The response includes tick-based resolutions with a `T` suffix, minute-based resolutions, and daily, weekly, and monthly multipliers used by charting clients. It also indicates whether intraday, daily, weekly, and monthly data are available, plus search and time endpoint support.", "operationId": "getChartConfig", "responses": { "200": { "content": { "application/json": { "example": { "supported_resolutions": [ "1T", "5T", "10T", "25T", "50T", "100T", "250T", "500T", "1000T", "1", "3", "5", "15", "30", "45", "60", "120", "180", "240", "1D", "1W", "1M", "3M", "6M", "12M" ], "has_intraday": true, "intraday_multipliers": [ "1", "5", "15", "30", "60", "240" ], "has_daily": true, "daily_multipliers": [ "1" ], "has_weekly_and_monthly": true, "weekly_multipliers": [ "1" ], "monthly_multipliers": [ "1" ], "supports_search": true, "supports_group_request": false, "supports_marks": false, "supports_timescale_marks": false, "supports_time": false }, "schema": { "$ref": "#/components/schemas/ChartConfig" } } }, "description": "Chart configuration retrieved successfully" }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "security": [ { "OAuth2": [ "market:information" ] } ], "summary": "Get Chart Configuration", "tags": [ "Chart" ], "parameters": [] } }, "/v1/chart/history": { "get": { "description": "Retrieves historical price bars (OHLCV - Open, High, Low, Close, Volume) for a specific symbol within a date range. This endpoint supports various time resolutions from seconds to months. The data is returned in arrays format optimized for charting libraries, with timestamps in Unix format (seconds).", "operationId": "getChartHistory", "parameters": [ { "description": "Symbol to fetch bars for. Use the exact symbol returned by symbol search, such as `AAPL` for equities or the selected chart symbol for futures/options.", "example": "AAPL", "in": "query", "name": "symbol", "required": true, "schema": { "type": "string" } }, { "description": "Candle size. Use minute values such as `1`, `5`, or `60` for intraday charts, `D` or `1D` for daily charts, `W` or `1W` for weekly charts, and `M`, `1M`, `3M`, `6M`, or `12M` for monthly views.", "example": "60", "in": "query", "name": "resolution", "required": true, "schema": { "$ref": "#/components/schemas/ChartResolution" } }, { "description": "Start of the chart window as a Unix timestamp. Send seconds; millisecond timestamps are accepted and converted automatically.", "example": 1672531200, "in": "query", "name": "from", "required": true, "schema": { "format": "int64", "minimum": 1, "type": "integer" } }, { "description": "End of the chart window as a Unix timestamp. Must be greater than `from`. Send seconds; millisecond timestamps are accepted and converted automatically.", "example": 1675209600, "in": "query", "name": "to", "required": true, "schema": { "format": "int64", "minimum": 1, "type": "integer" } }, { "description": "TradingView compatibility flag. Omit or send a non-zero value for the first chart request; send `0` for follow-up history requests.", "in": "query", "name": "firstDataRequest", "required": false, "schema": { "type": "string" } }, { "description": "Set to `true` when the chart should include eligible pre-market and after-hours bars. Leave `false` for regular session charts.", "in": "query", "name": "includeExtended", "required": false, "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "content": { "application/json": { "examples": { "success": { "value": { "c": [ 130.15, 130.89, 131.24 ], "h": [ 130.28, 131.05, 131.37 ], "l": [ 129.88, 130.09, 130.81 ], "nextTime": 1672542000, "o": [ 129.93, 130.15, 130.89 ], "s": "ok", "t": [ 1672531200, 1672534800, 1672538400 ], "v": [ 1234567, 1345678, 1456789 ] } } }, "schema": { "$ref": "#/components/schemas/ChartBars" } } }, "description": "Historical bars in TradingView UDF format. Always returns 200; check **s** (status): `ok` = data in t, o, h, l, c, v; `no_data` = no bars; `error` = errmsg contains reason (e.g. invalid resolution or time range)." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "security": [ { "OAuth2": [ "market:information" ] } ], "summary": "Get Historical Chart Data", "tags": [ "Chart" ] } }, "/v1/chart/quotes": { "get": { "description": "Retrieves quote data for one or multiple symbols. Returns current market data including last price, bid/ask prices, volume, high/low prices, change, and percent change. This endpoint supports bulk requests by providing comma-separated symbols, making it efficient for fetching quotes for multiple instruments simultaneously.", "operationId": "getQuotes", "parameters": [ { "description": "Comma-separated symbols to quote, such as `AAPL,MSFT`. Use one symbol for a quote tile or multiple symbols for watchlists and dashboards.", "example": "AAPL,GOOGL,MSFT", "in": "query", "name": "symbols", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "d": [ { "n": "Apple INC", "s": "AAPL", "v": { "ask": 130.92, "bid": 130.88, "ch": 2.15, "chp": 1.67, "description": "Apple Inc. Common Stock", "exchange": "NASDAQ", "high_price": 131.25, "low_price": 129.3, "lp": 130.89, "open_price": 129.5, "prev_close_price": 128.74, "short_name": "Apple Inc.", "volume": 45678900 } }, { "n": "Alphabet Inc", "s": "GOOGL", "v": { "ask": 130.55, "bid": 130.48, "ch": -1.25, "chp": -0.95, "description": "Alphabet Inc. Class A Common Stock", "exchange": "NASDAQ", "high_price": 131.8, "low_price": 130.1, "lp": 130.5, "open_price": 131.2, "prev_close_price": 131.75, "short_name": "Alphabet Inc.", "volume": 23456789 } } ], "s": "ok" }, "schema": { "$ref": "#/components/schemas/QuotesResponse" } } }, "description": "Quotes retrieved successfully" }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "security": [ { "OAuth2": [ "market:information" ] } ], "summary": "Get Real-Time Quotes", "tags": [ "Chart" ] } }, "/v1/chart/search": { "get": { "description": "Searches for trading symbols (stocks, indices, options, futures) based on a query string. Returns a list of matching symbols with symbol, ticker, description, exchange, and type. Supports equities, options (prefix query with '.'), and futures (prefix with '/'). Useful for symbol search autocomplete in charting UIs.", "operationId": "searchSymbols", "parameters": [ { "description": "Text to search. Use plain text for stocks and indices, `.` prefix for options such as `.AAPL`, and `/` prefix for futures such as `/ES`.", "example": "Apple", "in": "query", "name": "query", "required": true, "schema": { "minLength": 1, "type": "string" } }, { "description": "Maximum number of results to return. Use smaller values for autocomplete and larger values for search result pages. Default is 20; maximum is 100.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 } } ], "responses": { "200": { "content": { "application/json": { "example": [ { "description": "Apple Inc.", "exchange": "NASDAQ", "symbol": "AAPL", "ticker": "AAPL", "type": "stock" }, { "description": "Apple Inc.", "exchange": "XNAS", "symbol": "AAPL", "ticker": "AAPL", "type": "stock" } ], "schema": { "items": { "$ref": "#/components/schemas/SearchSymbolItem" }, "type": "array" } } }, "description": "Symbol search results retrieved successfully" }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "security": [ { "OAuth2": [ "market:information" ] } ], "summary": "Search Symbols", "tags": [ "Chart" ] } }, "/v1/chart/symbols": { "get": { "description": "Retrieves detailed symbol information for charting: exchange, timezone, session, supported resolutions, price scale, format. Required for TradingView-style chart setup. For **futures**, symbol must start with '/' (e.g., /ES, /NQ).", "operationId": "getSymbolInfo", "parameters": [ { "description": "Symbol to resolve for charting. Use equities like `AAPL` or futures with a leading slash such as `/ES`. Prefer values returned by chart search.", "example": "AAPL", "in": "query", "name": "symbol", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "ticker": "AAPL", "name": "Apple Inc", "description": "Apple Inc", "type": "stock", "session": "0400-2000", "subsession_id": "", "subsessions": null, "timezone": "America/New_York", "exchange": "NASDAQ", "format": "price", "minmov": 1, "pricescale": 100, "has_intraday": true, "intraday_multipliers": [ "1", "5", "15", "30", "60", "240" ], "has_daily": true, "daily_multipliers": [ "1" ], "has_weekly_and_monthly": true, "weekly_multipliers": [ "1" ], "monthly_multipliers": [ "1" ], "has_ticks": true, "has_seconds": true, "visible_plots_set": "ohlcv", "supported_resolutions": [ "1T", "5T", "10T", "25T", "50T", "100T", "250T", "500T", "1000T", "1", "3", "5", "15", "30", "45", "60", "120", "180", "240", "1D", "1W", "1M", "3M", "6M", "12M" ], "volume_precision": 1, "listed_exchange": "NASDAQ" }, "schema": { "$ref": "#/components/schemas/SymbolInfo" } } }, "description": "Symbol information retrieved successfully" }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "security": [ { "OAuth2": [ "market:information" ] } ], "summary": "Get Symbol Information", "tags": [ "Chart" ] } }, "/v1/chart/time": { "get": { "description": "Returns the current server time as a Unix timestamp in **seconds**. Response is plain text containing only the timestamp number (e.g., 1704067200). Useful for synchronizing client time with the server for charting.", "operationId": "getChartTime", "responses": { "200": { "content": { "text/plain": { "schema": { "description": "Unix timestamp in seconds", "example": 1704067200, "type": "integer" } } }, "description": "Current server time (Unix seconds) as plain text" }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "security": [ { "OAuth2": [ "market:information" ] } ], "summary": "Get Server Time", "tags": [ "Chart" ], "parameters": [] } }, "/v1/equity/sector-tickers": { "get": { "description": "Retrieves all stock symbols within a specified sector, sorted by trading volume.", "operationId": "getSectorTickers", "parameters": [ { "description": "Which industry sector to list tickers for. Use the exact uppercase value (including spaces) — these match the values returned by [GET /v1/equity/sector-wise-change](/api-reference/analytics/equity-sector-wise-change).\n- `TECHNOLOGY` — software, hardware, semiconductors\n- `HEALTHCARE` — pharma, biotech, medical devices, providers\n- `FINANCIAL SERVICES` — banks, insurance, asset managers\n- `CONSUMER CYCLICAL` — discretionary spending (autos, retail, travel)\n- `CONSUMER DEFENSIVE` — staples (food, household goods, drugstores)\n- `INDUSTRIALS` — manufacturing, transport, defense, machinery\n- `ENERGY` — oil & gas, renewable energy\n- `UTILITIES` — power, water, gas distribution\n- `BASIC MATERIALS` — mining, chemicals, paper, metals\n- `COMMUNICATION SERVICES` — telecom, media, internet platforms\n- `REAL ESTATE` — REITs and real-estate operators\n- `OTHER` — uncategorized\n- `NONE` — no sector classification", "in": "query", "name": "sector", "required": true, "schema": { "type": "string", "example": "TECHNOLOGY", "enum": [ "HEALTHCARE", "UTILITIES", "CONSUMER CYCLICAL", "INDUSTRIALS", "CONSUMER DEFENSIVE", "BASIC MATERIALS", "COMMUNICATION SERVICES", "FINANCIAL SERVICES", "TECHNOLOGY", "REAL ESTATE", "NONE", "OTHER", "ENERGY" ] } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/SymbolDetails" }, "type": "array" }, "example": [ { "symbol": "AAPL", "type": "stock", "change": 1.25, "changePercent": 0.72, "isETF": false, "lastPrice": 175.43, "logoUrl": "https://cdn.example.com/logos/AAPL.png", "previousClose": 174.18, "sector": "Technology", "sicCode": "3571", "timestamp": 1736956800, "volume": 52000000 } ] } }, "description": "Sector tickers retrieved successfully" }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "security": [ { "OAuth2": [ "analytics:information" ] } ], "summary": "Get Sector Tickers", "tags": [ "Analytics" ] } }, "/v1/equity/sector-wise-change": { "get": { "description": "Retrieves the average percentage change for all available sectors, sorted by change. Use limit=all to return all sectors.", "operationId": "getSectorWiseChange", "parameters": [ { "description": "Maximum number of sectors to return. Two formats are accepted:\n- An integer like `5`, `10`, `15` to cap the list (default `15`).\n- The literal string `all` to return every sector with no cap.", "in": "query", "name": "limit", "required": false, "schema": { "type": "string", "example": "15" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/SectorAvgChange" }, "type": "array" }, "example": [ { "sector": "TECHNOLOGY", "avgChange": 1.25 } ] } }, "description": "Sector-wise changes retrieved successfully" }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "security": [ { "OAuth2": [ "analytics:information" ] } ], "summary": "Get Sector-wise Change", "tags": [ "Analytics" ] } }, "/v1/equity/top-gainers": { "get": { "description": "Retrieves stocks with the highest positive percentage changes, sorted by change percentage in descending order.", "operationId": "getTopGainers", "parameters": [ { "description": "Maximum number of results to return. Use smaller values for UI pages and larger values for exports within API limits. (optional, default 10)", "in": "query", "name": "limit", "required": false, "schema": { "default": 10, "maximum": 99, "minimum": 1, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/SymbolDetails" }, "type": "array" }, "example": [ { "symbol": "AAPL", "type": "stock", "change": 1.25, "changePercent": 0.72, "isETF": false, "lastPrice": 175.43, "logoUrl": "https://cdn.example.com/logos/AAPL.png", "previousClose": 174.18, "sector": "Technology", "sicCode": "3571", "timestamp": 1736956800, "volume": 52000000 } ] } }, "description": "Top gaining stocks retrieved successfully" }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "security": [ { "OAuth2": [ "analytics:information" ] } ], "summary": "Get Top Gaining Stocks", "tags": [ "Analytics" ] } }, "/v1/equity/top-losers": { "get": { "description": "Retrieves stocks with the largest negative percentage changes, sorted by change percentage in ascending order.", "operationId": "getTopLosers", "parameters": [ { "description": "Maximum number of results to return. Use smaller values for UI pages and larger values for exports within API limits. (optional, default 10)", "in": "query", "name": "limit", "required": false, "schema": { "default": 10, "maximum": 99, "minimum": 1, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/SymbolDetails" }, "type": "array" }, "example": [ { "symbol": "AAPL", "type": "stock", "change": 1.25, "changePercent": 0.72, "isETF": false, "lastPrice": 175.43, "logoUrl": "https://cdn.example.com/logos/AAPL.png", "previousClose": 174.18, "sector": "Technology", "sicCode": "3571", "timestamp": 1736956800, "volume": 52000000 } ] } }, "description": "Top losing stocks retrieved successfully" }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "security": [ { "OAuth2": [ "analytics:information" ] } ], "summary": "Get Top Losing Stocks", "tags": [ "Analytics" ] } }, "/v1/equity/top-most-active": { "get": { "description": "Retrieves stocks sorted by trading volume in descending order.", "operationId": "getTopMostActive", "parameters": [ { "description": "Maximum number of results to return. Use smaller values for UI pages and larger values for exports within API limits. (optional, default 10)", "in": "query", "name": "limit", "required": false, "schema": { "default": 10, "maximum": 99, "minimum": 1, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/SymbolDetails" }, "type": "array" }, "example": [ { "symbol": "AAPL", "type": "stock", "change": 1.25, "changePercent": 0.72, "isETF": false, "lastPrice": 175.43, "logoUrl": "https://cdn.example.com/logos/AAPL.png", "previousClose": 174.18, "sector": "Technology", "sicCode": "3571", "timestamp": 1736956800, "volume": 52000000 } ] } }, "description": "Most active stocks retrieved successfully" }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "security": [ { "OAuth2": [ "analytics:information" ] } ], "summary": "Get Most Active Stocks", "tags": [ "Analytics" ] } }, "/v1/marketdata/equities/details": { "get": { "description": "Batch equity details from an internal cache with an automatic fallback when cached quotes are unavailable. Response includes `data` with per-symbol fields (camelCase: `bidPrice`, `openPrice`, `totalVolume`, etc.); see `EquityDetailsDTO` and `GetEquityDetailsResponse`. At least one symbol is required.", "operationId": "GetEquityDetails", "parameters": [ { "description": "One or more uppercase ticker symbols, separated by commas (e.g. `AAPL,MSFT,GOOGL`). Send at least one. The response order matches the request order.", "in": "query", "name": "symbols", "required": true, "schema": { "example": "AAPL,MSFT", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetEquityDetailsResponse" }, "example": { "data": [ { "symbol": "AAPL", "type": "ETRADE", "price": 267.53, "openPrice": 272.78, "highPrice": 273.06, "lowPrice": 269.65, "lastPrice": 271.06, "closePrice": 273.43, "netChange": -3.53, "tradeSeq": 1009904, "size": 1, "totalVolume": 300562, "tick": 0, "tradeTimestamp": "2026-04-27T05:38:10.674000-04:00", "tradeExchange": "PACF|NYSE ARCA (Pacific)", "bidPrice": 267.5, "askPrice": 268, "bidSize": 1400, "askSize": 500, "bidExchange": "EDGX|Direct Edge X", "askExchange": "BATS|BATS Trading", "quoteTimestamp": "2026-04-27T05:38:09.901000-04:00", "spread": 0.5, "midPrice": 267.75, "instrumentType": "Equity", "name": "Apple Inc.", "sicCode": 3663, "hasOptions": true, "isETF": false, "sharesOutstanding": 14681140, "assets": 379297000, "liabilities": 291107000, "longTermDebt": 905090000, "EPSDiluted": 2.84, "EPSLatest12Month": 18.3333, "EPS3YearGrowthRate": 17.6111, "EPS5YearGrowthRate": 11.0713, "avgVolume4Weeks": 38174153, "marketCap": 30064771072, "PE": 32.181, "high52WeekDate": "2025-12-03T00:00:00Z", "low52WeekDate": "2025-04-08", "high52WeekPrice": 288.62, "low52WeekPrice": 169.2101, "dividend": 0.26, "shortSaleRestricted": 0 } ], "errors": [] } } }, "description": "`data` holds per-symbol objects matching `EquityDetailsDTO`. Omitted keys were empty in cache. See schema for the `errors` array shape when a symbol cannot be returned." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "security": [ { "OAuth2": [ "market:information" ] } ], "summary": "Get equity details", "tags": [ "Market Data" ] } }, "/v1/marketdata/options/details": { "get": { "description": "Batch option contract details for one or more OSI option symbols. Response includes `data` with per-symbol pricing fields (`lastPrice`, `bidPrice`, `askPrice`, `midPrice`, `closePrice`) and an `errors` array for symbols that cannot be returned. At least one symbol is required.", "operationId": "GetOptionDetails", "parameters": [ { "description": "One or more OSI option symbols, separated by commas (e.g. `GOOG270115C00285000`). Send at least one. The response order matches the request order.", "in": "query", "name": "symbols", "required": true, "schema": { "example": "GOOG270115C00285000", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetOptionDetailsResponse" }, "example": { "data": [ { "symbol": "GOOG270115C00285000", "lastPrice": 79.76, "bidPrice": 78.05, "askPrice": 80.9, "midPrice": 79.475, "closePrice": 93.5 } ], "errors": [] } } }, "description": "`data` holds per-symbol option pricing objects matching `OptionDetailsDTO`. See schema for the `errors` array shape when a symbol cannot be returned." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "security": [ { "OAuth2": [ "market:information" ] } ], "summary": "Get option details", "tags": [ "Market Data" ] } }, "/v1/marketdata/search": { "get": { "description": "Search for trading symbols including stocks, indices, options, and futures. **Prefixes:** '.' searches options (e.g. '.AAPL'); '/' searches futures (e.g. '/ES'). Without a prefix, searches stocks and indices together, merges matches, ranks them, and returns at most `limit` results. The '!' character is **not** a special prefix—only '.' and '/' are. Default limit is 20 if omitted (max 100).", "operationId": "searchMarketSymbols", "parameters": [ { "description": "Text the user entered in symbol search. Use `AAPL` for stocks and indices, `.AAPL` for option-chain style searches, and `/ES` for futures. Do not use `!` as a special prefix; it is treated as literal text.", "examples": { "option": { "summary": "Option search", "value": ".AAPL" }, "stock": { "summary": "Stock search", "value": "AAPL" }, "futures": { "summary": "Futures search", "value": "/ES" } }, "in": "query", "name": "query", "required": true, "schema": { "x-default": "AAPL", "minLength": 1, "type": "string" } }, { "description": "Maximum number of matches to return. Use a small number for autocomplete and a larger number for full search pages. Default is 20; minimum is 1; maximum is 100.", "in": "query", "name": "limit", "schema": { "default": 20, "maximum": 100, "minimum": 1, "type": "integer" } } ], "responses": { "200": { "description": "Search results retrieved successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchSymbolResponse" }, "example": [ { "symbol": "AAPL", "description": "Apple Inc.", "tag": "XNAS", "type": "stock" }, { "symbol": "AAPL240119C00190000", "description": "AAPL Jan 19 2024 190 Call", "tag": "OPRA", "type": "option" } ] } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "security": [ { "OAuth2": [ "market:information" ] } ], "summary": "Search Symbols", "tags": [ "Market Data" ] } }, "/v1/news": { "get": { "description": "Retrieve real-time market news articles and press releases. Returns combined results from both news and press releases, sorted by timestamp (newest first). Default returns news for SPY if no symbols are specified.", "operationId": "GetNews", "parameters": [ { "description": "Comma-separated list of stock symbols to filter news by. Default is `SPY` when omitted. Maximum 10 symbols per request. Each symbol must be a plain uppercase ticker (e.g. `AAPL,TSLA,NVDA`).", "in": "query", "name": "symbols", "required": false, "schema": { "type": "string", "example": "AAPL,GOOGL,MSFT", "default": "SPY" } }, { "description": "Comma-separated list of topics to filter news. Maximum 10 topics per request. Common topics:\n- `earnings` — earnings releases and reports.\n- `guidance` — forward guidance updates.\n- `mergers_acquisitions` — M&A activity.\n- `dividends` — dividend announcements.\n- `analyst_ratings` — analyst upgrades and downgrades.\n- `ipo` — initial public offerings.\n- `regulatory` — SEC filings, lawsuits, regulatory actions.\n\nTopic names depend on the upstream news catalog and may evolve over time.", "in": "query", "name": "topics", "required": false, "schema": { "type": "string", "example": "earnings,guidance" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "news": { "type": "array", "description": "Array of news items and press releases, sorted by timestamp (newest first)", "items": { "type": "object", "properties": { "action": { "type": "string", "description": "News action type (typically empty)" }, "authors": { "type": "array", "description": "Authors of the news item", "items": { "type": "string" } }, "id": { "type": "integer", "description": "Unique news item ID" }, "symbols": { "type": "array", "description": "Related stock symbols", "items": { "type": "string" } }, "title": { "type": "string", "description": "News headline" }, "body": { "type": "string", "description": "Full body of the news (typically empty with default display output)" }, "news_type": { "$ref": "#/components/schemas/NewsTypeEnum" }, "timestamp": { "type": "string", "format": "date-time", "description": "Publication timestamp in ISO 8601 format" } } } } } }, "examples": { "default": { "value": { "news": [ { "action": "", "authors": [ "Jane Smith" ], "id": 123456, "symbols": [ "AAPL" ], "title": "Apple Announces New Product Line", "body": "", "news_type": "news", "timestamp": "2024-02-16T14:30:00Z" }, { "action": "", "authors": [ "John Doe" ], "id": 123457, "symbols": [ "MSFT" ], "title": "Microsoft Q4 Earnings Beat Expectations", "body": "", "news_type": "press_release", "timestamp": "2024-02-16T13:15:00Z" } ] } } } } }, "description": "News retrieved successfully" }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "example": "VALIDATION_ERROR" }, "message": { "type": "string", "example": "Query parameter validation failed" }, "details": { "type": "object", "additionalProperties": { "type": "string" } } } } } }, "description": "Validation error - invalid query parameters" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "security": [ { "OAuth2": [ "market:supplemental" ] } ], "summary": "Get Market News", "tags": [ "News" ] } }, "/v1/news/{id}": { "get": { "description": "Retrieve a specific news article or press release by its unique ID. Returns detailed information about a single news item. The ID must be numeric and newsType must be either 'news' or 'press_release'.", "operationId": "GetNewsById", "parameters": [ { "description": "Unique news item ID (must be numeric)", "in": "path", "name": "id", "required": true, "schema": { "type": "string", "example": "123456" } }, { "description": "Type of news item to retrieve. Must be either 'news' or 'press_release'.", "in": "query", "name": "newsType", "required": true, "schema": { "$ref": "#/components/schemas/NewsTypeEnum" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "action": { "type": "string", "description": "News action type (typically empty)" }, "authors": { "type": "array", "description": "Authors of the news item", "items": { "type": "string" } }, "id": { "type": "integer", "description": "Unique news item ID" }, "symbols": { "type": "array", "description": "Related stock symbols", "items": { "type": "string" } }, "title": { "type": "string", "description": "News headline" }, "body": { "type": "string", "description": "Full body of the news article" }, "news_type": { "$ref": "#/components/schemas/NewsTypeEnum" }, "timestamp": { "type": "string", "format": "date-time", "description": "Publication timestamp in ISO 8601 format" } } }, "examples": { "default": { "value": { "action": "", "authors": [ "John Author" ], "id": 12345, "symbols": [ "AAPL", "MSFT" ], "title": "Apple Announces New Product", "body": "Full news article content here...", "news_type": "news", "timestamp": "2024-02-16T10:30:00Z" } } } } }, "description": "News item retrieved successfully" }, "400": { "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": { "type": "string" } } } }, "examples": { "missing_id": { "summary": "Missing ID parameter", "value": { "error": "Query parameter validation failed", "details": { "id": "id path parameter is required" } } }, "invalid_newsType": { "summary": "Invalid newsType", "value": { "error": "Query parameter validation failed", "details": { "newsType": "must be one of: news, press_release" } } }, "non_numeric_id": { "summary": "ID is not numeric", "value": { "error": "Validation Error", "code": "INVALID_NEWS_ID_FORMAT", "message": "news id must be numeric" } } } } }, "description": "Bad request - validation errors" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Not Found" }, "code": { "type": "string", "example": "NEWS_BY_ID_NOT_FOUND" }, "message": { "type": "string" } } }, "examples": { "news_not_found": { "summary": "News item not found", "value": { "error": "Not Found", "code": "NEWS_BY_ID_NOT_FOUND", "message": "news not found" } }, "press_release_not_found": { "summary": "Press release not found", "value": { "error": "Not Found", "code": "NEWS_BY_ID_NOT_FOUND", "message": "press release not found" } } } } }, "description": "News item not found" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "security": [ { "OAuth2": [ "market:supplemental" ] } ], "summary": "Get News by ID", "tags": [ "News" ] } }, "/v1/options/etfs/top-volume": { "get": { "description": "Retrieve ETF options with the highest trading volume showing the most actively traded contracts across all ETFs.", "operationId": "getOptionsETFsTopVolume", "parameters": [ { "description": "Maximum number of results to return. Use smaller values for UI pages and larger values for exports within API limits. (optional, default 10)", "in": "query", "name": "size", "required": false, "schema": { "default": 10, "maximum": 99, "minimum": 1, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/OptionsScreenerItem" }, "type": "array" }, "example": [ { "symbol": "AAPL240119C00190000", "underlyingSymbol": "AAPL", "logoUrl": "https://cdn.example.com/logos/AAPL.png", "type": "c", "strike": 190, "expiry": "2024-01-19", "volume": 12500, "openInterest": 45000, "lastPrice": 3.45, "change": 0.22, "changePercent": 6.81, "bid": 3.4, "ask": 3.5, "impliedVolatility": 0.28 } ] } }, "description": "Array of option contract details (symbol, underlyingSymbol, type, strike, expiry, volume, openInterest, lastPrice, change, changePercent, bid, ask, impliedVolatility, logoUrl)." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "security": [ { "OAuth2": [ "analytics:information" ] } ], "summary": "Get Top ETF Options by Volume", "tags": [ "Analytics" ] } }, "/v1/options/stocks/top-gainers": { "get": { "description": "Retrieve stock options with the largest percentage gains showing the best performing options contracts.", "operationId": "getOptionsStocksTopGainers", "parameters": [ { "description": "Maximum number of results to return. Use smaller values for UI pages and larger values for exports within API limits. (optional, default 10)", "in": "query", "name": "size", "required": false, "schema": { "default": 10, "maximum": 99, "minimum": 1, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/OptionsScreenerItem" }, "type": "array" }, "example": [ { "symbol": "AAPL240119C00190000", "underlyingSymbol": "AAPL", "logoUrl": "https://cdn.example.com/logos/AAPL.png", "type": "c", "strike": 190, "expiry": "2024-01-19", "volume": 12500, "openInterest": 45000, "lastPrice": 3.45, "change": 0.22, "changePercent": 6.81, "bid": 3.4, "ask": 3.5, "impliedVolatility": 0.28 } ] } }, "description": "Array of option contract details (symbol, underlyingSymbol, type, strike, expiry, volume, openInterest, lastPrice, change, changePercent, bid, ask, impliedVolatility, logoUrl)." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "security": [ { "OAuth2": [ "analytics:information" ] } ], "summary": "Get Top Stock Options by Gains", "tags": [ "Analytics" ] } }, "/v1/options/stocks/top-volume": { "get": { "description": "Retrieve stock options with the highest trading volume identifying the most actively traded equity options contracts.", "operationId": "getOptionsStocksTopVolume", "parameters": [ { "description": "Maximum number of results to return. Use smaller values for UI pages and larger values for exports within API limits. (optional, default 10)", "in": "query", "name": "size", "required": false, "schema": { "default": 10, "maximum": 99, "minimum": 1, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/OptionsScreenerItem" }, "type": "array" }, "example": [ { "symbol": "AAPL240119C00190000", "underlyingSymbol": "AAPL", "logoUrl": "https://cdn.example.com/logos/AAPL.png", "type": "c", "strike": 190, "expiry": "2024-01-19", "volume": 12500, "openInterest": 45000, "lastPrice": 3.45, "change": 0.22, "changePercent": 6.81, "bid": 3.4, "ask": 3.5, "impliedVolatility": 0.28 } ] } }, "description": "Array of option contract details (symbol, underlyingSymbol, type, strike, expiry, volume, openInterest, lastPrice, change, changePercent, bid, ask, impliedVolatility, logoUrl)." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "security": [ { "OAuth2": [ "analytics:information" ] } ], "summary": "Get Top Stock Options by Volume", "tags": [ "Analytics" ] } }, "/v1/orders": { "post": { "tags": [ "Orders" ], "summary": "Place an order", "description": "Place an equity or option order. The order type is automatically determined:\n- No `legs` array = Equity order\n- 1 leg in `legs` array = Single-leg option order\n- 2-4 legs in `legs` array = Multi-leg option order\n\nOption and multi-leg orders only support `DAY` and `GTC` for `timeInForce`.\n\nIf you send an OSI option symbol in `symbol` and omit `legs`, the backend derives a single option leg automatically.\n\nPrice precision validation:\n- `LIMIT` validates `price`\n- `STOP` validates `stopPrice`\n- `STOP_LIMIT` validates both\n- Decimal inputs support up to 5 digits after the decimal point.", "operationId": "placeOrder", "requestBody": { "description": "The order to place. Required: `tradingAccountId`, `symbol`, `side`, `type`, `qty`, `timeInForce`. Add `price` for limit-style orders, `stopPrice` for stop-style orders, and `legs` for option orders. You may also send an OSI option symbol in `symbol` without `legs` and let the backend derive the option instrument.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlaceOrdRequest" }, "examples": { "equityMarket": { "summary": "Equity Market Order", "value": { "tradingAccountId": "TEST-ACCOUNT-001", "symbol": "AAPL", "side": "BUY", "type": "MARKET", "qty": "10", "timeInForce": "DAY" } }, "equityLimit": { "summary": "Equity Limit Order", "value": { "tradingAccountId": "TEST-ACCOUNT-001", "symbol": "AAPL", "side": "BUY", "type": "LIMIT", "qty": "10", "price": "150.00", "timeInForce": "DAY" } }, "singleLegCall": { "summary": "Single-Leg Call Option", "value": { "tradingAccountId": "TEST-ACCOUNT-001", "symbol": "AAPL", "side": "BUY", "type": "LIMIT", "qty": "1", "price": "5.50", "timeInForce": "DAY", "legs": [ { "side": "BUY", "ratioQty": "1", "securityType": "OPT", "putCall": "CALL", "strikePrice": "150.00", "maturity": "2025-01-17", "positionEffect": "OPEN" } ] } }, "verticalSpread": { "summary": "Multi-Leg Vertical Spread", "value": { "tradingAccountId": "TEST-ACCOUNT-001", "symbol": "AAPL", "side": "BUY", "type": "LIMIT", "qty": "1", "price": "2.50", "timeInForce": "DAY", "legs": [ { "side": "BUY", "ratioQty": "1", "securityType": "OPT", "putCall": "CALL", "strikePrice": "150.00", "maturity": "2025-01-17", "positionEffect": "OPEN" }, { "side": "SELL", "ratioQty": "1", "securityType": "OPT", "putCall": "CALL", "strikePrice": "155.00", "maturity": "2025-01-17", "positionEffect": "OPEN" } ] } } } } } }, "responses": { "200": { "description": "Order placed successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrdResponse" }, "example": { "success": true, "clOrdId": "ORDER-20260115-001", "status": "NEW", "symbol": "AAPL", "side": "BUY", "qty": "10", "cumQty": "0", "leavesQty": "10", "avgPrice": "0", "text": "Order accepted", "ordRejReason": "", "transactTime": "2026-01-15T14:30:05Z" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalServerError" }, "503": { "description": "Broker connection not established", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "504": { "description": "Order response timeout", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "OAuth2": [ "order:execution" ] } ], "parameters": [] } }, "/v1/orders/preview": { "post": { "tags": [ "Orders" ], "summary": "Preview order", "description": "Preview an order to calculate estimated cost, fees, buying power impact, and option requirements before placing. Uses the same request body as Place Order (PlaceOrdRequest), including the same option `timeInForce` restrictions, OSI-symbol support, and price-precision validation.", "operationId": "previewOrder", "requestBody": { "description": "Same shape as Place Order — fill out exactly what you would send to actually place the order. The preview just returns cost/fees/buying-power numbers without putting the order on the market.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlaceOrdRequest" }, "examples": { "equityMarket": { "summary": "Preview Equity Market Order", "value": { "tradingAccountId": "TEST-ACCOUNT-001", "symbol": "AAPL", "side": "BUY", "type": "MARKET", "qty": "10", "timeInForce": "DAY" } }, "equityLimit": { "summary": "Preview Equity Limit Order", "value": { "tradingAccountId": "TEST-ACCOUNT-001", "symbol": "AAPL", "side": "BUY", "type": "LIMIT", "qty": "10", "price": "150.00", "timeInForce": "DAY" } }, "optionOrder": { "summary": "Preview Option Order", "value": { "tradingAccountId": "TEST-ACCOUNT-001", "symbol": "AAPL", "side": "BUY", "type": "LIMIT", "qty": "1", "price": "5.50", "timeInForce": "DAY", "legs": [ { "side": "BUY", "ratioQty": "1", "securityType": "OPT", "putCall": "CALL", "strikePrice": "150.00", "maturity": "2025-01-17", "positionEffect": "OPEN" } ] } }, "multiLegSpread": { "summary": "Preview Multi-Leg Spread", "value": { "tradingAccountId": "TEST-ACCOUNT-001", "symbol": "AAPL", "side": "BUY", "type": "LIMIT", "qty": "1", "price": "2.50", "timeInForce": "DAY", "legs": [ { "side": "BUY", "ratioQty": "1", "securityType": "OPT", "putCall": "CALL", "strikePrice": "150.00", "maturity": "2025-01-17", "positionEffect": "OPEN" }, { "side": "SELL", "ratioQty": "1", "securityType": "OPT", "putCall": "CALL", "strikePrice": "155.00", "maturity": "2025-01-17", "positionEffect": "OPEN" } ] } } } } } }, "responses": { "200": { "description": "Order preview calculated successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PreviewOrderResponse" }, "examples": { "equityPreview": { "summary": "Equity Order Preview", "value": { "estimatedCost": "240.25", "estimatedMargin": "60.04875", "commission": "0", "buyingPowerImpact": "120.0975", "fees": "0", "optionFees": "0", "optionRequirement": "0", "optionPremium": "0", "numDayTrades": 0, "warnRuleId": "0" } }, "optionPreview": { "summary": "Option Order Preview", "value": { "estimatedCost": "550.00", "estimatedMargin": "0.00", "commission": "0.65", "fees": "0.05", "optionFees": "0.70", "optionPremium": "550.00", "optionRequirement": "0.00", "buyingPowerImpact": "550.70", "numDayTrades": 0, "warnRuleId": "0" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalServerError" }, "503": { "description": "Sterling REST service not available", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "504": { "description": "Preview response timeout", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "OAuth2": [ "order:execution" ] } ], "parameters": [] } }, "/v2/users/me/accounts": { "get": { "description": "Retrieve all trading accounts for the currently authenticated user. Returns a list of accounts with trading account ID, broker account ID, status, simulation flag, and account type and class. Users may have multiple accounts (for example a live account and a simulation account). Requires bearer token authentication.", "operationId": "getUserAccounts", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetAccountsResponse" }, "example": { "accounts": [ { "trading_account_id": "SIM6B86XEYOC", "broker_account_id": "", "status": "OPEN", "is_sim": true, "account_type": "", "account_class": "" }, { "trading_account_id": "3AF05000", "broker_account_id": "3AF05000", "status": "OPEN", "is_sim": false, "account_type": "INDIVIDUAL", "account_class": "MARGIN" } ] } } }, "description": "User accounts retrieved successfully" }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "security": [ { "OAuth2": [ "account:information" ] } ], "summary": "Get User Accounts", "tags": [ "Accounts" ], "parameters": [] } }, "/v1/config/watchlist/{watchlist_id}": { "delete": { "description": "Delete one of the user's watchlists by its numeric ID.\n\n**Important — last-watchlist rule:** If this is the user's *only remaining* watchlist, the server does not actually delete it. Instead it **resets it to a default empty state** (name set to `\"Default\"`, `symbols` cleared) so the user always has at least one watchlist available in the UI.\n\n**Tip:** The response body returns the affected watchlist — whether it was actually deleted or reset — so you can update your local store without making a follow-up GET request. Compare `name` and `symbols` in the response to decide whether to render the 'reset to default' state.", "operationId": "deleteConfigWatchlistById", "parameters": [ { "description": "The numeric ID of the watchlist to delete. You can get this from a previous list/create/update response (the `id` field in the returned watchlist).", "in": "path", "name": "watchlist_id", "required": true, "schema": { "type": "integer", "format": "int64", "example": 12345 } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Watchlist" }, "examples": { "deleted": { "summary": "Watchlist deleted (user had multiple watchlists)", "value": { "id": 12345, "name": "Tech Stocks", "symbols": [ "AAPL", "GOOGL", "MSFT" ] } }, "resetToDefault": { "summary": "Last remaining watchlist reset to default", "value": { "id": 12345, "name": "Default", "symbols": [] } } } } }, "description": "Watchlist deleted, or reset to default when it was the user's only remaining watchlist. The response body contains the affected watchlist." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "security": [ { "OAuth2": [ "user:management" ] } ], "summary": "Delete Watchlist", "tags": [ "Watchlist" ] } }, "/v1/orders/cancel": { "post": { "tags": [ "Orders" ], "summary": "Cancel an order", "description": "Cancel an existing order by original client order ID. For option cancels, you can provide the option fields directly or send an OSI option symbol in `symbol` and let the backend derive the option instrument fields.", "operationId": "cancelOrder", "requestBody": { "description": "Which order to cancel. Required: `origClOrdId` (the ID returned when the order was placed), `tradingAccountId`, `symbol`. Add `side` and `securityType` to disambiguate; for option cancels also include `putCall`, `strikePrice`, and `maturity`, or send an OSI option symbol in `symbol` and let the backend derive them.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CancelOrdRequest" }, "examples": { "cancelEquity": { "summary": "Cancel Equity Order", "value": { "origClOrdId": "ORDER-123456", "tradingAccountId": "TEST-ACCOUNT-001", "symbol": "AAPL", "side": "BUY", "securityType": "CS" } }, "cancelOption": { "summary": "Cancel Option Order", "value": { "origClOrdId": "ORDER-789012", "tradingAccountId": "TEST-ACCOUNT-001", "symbol": "AAPL", "side": "BUY", "securityType": "OPT", "putCall": "CALL", "strikePrice": "150.00", "maturity": "2025-01-17" } } } } } }, "responses": { "200": { "description": "Cancel request submitted successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CancelOrdResponse" }, "example": { "success": true, "clOrdId": "ORDER-20260115-002", "origClOrdId": "ORDER-20260115-001", "status": "CANCELED", "text": "Cancel request processed" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalServerError" }, "503": { "description": "Broker connection not established", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "504": { "description": "Cancel response timeout", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "OAuth2": [ "order:execution" ] } ], "parameters": [] } }, "/v1/orders/replace": { "post": { "tags": [ "Orders" ], "summary": "Replace an order", "description": "Replace/modify an existing order (change quantity, price, or time in force). **ID cycling:** a successful replace returns a new `clOrdId`. Use that new ID as `origClOrdId` for any further replaces of this order — the previous ID is no longer valid once replaced.\n\nFor single-leg options, you can send the option fields directly, put them inside the single leg, or send an OSI option symbol in `symbol` and let the backend derive the instrument. Multi-leg replaces must pass `legs` explicitly.\n\nPrice precision validation:\n- `LIMIT` validates `price`\n- `STOP` validates `stopPrice`\n- `STOP_LIMIT` validates both\n- Decimal inputs support up to 5 digits after the decimal point.", "operationId": "replaceOrder", "requestBody": { "description": "Which order to modify and what to change. Required: `origClOrdId`, `tradingAccountId`, `symbol`. Then include only the fields you want to update — typically some combination of `qty`, `price`, `stopPrice`, `type`, and `timeInForce`.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReplaceOrdRequest" }, "examples": { "changeQuantity": { "summary": "Change Quantity", "value": { "origClOrdId": "ORDER-123456", "tradingAccountId": "TEST-ACCOUNT-001", "symbol": "AAPL", "side": "BUY", "type": "LIMIT", "qty": "20", "price": "150.00", "timeInForce": "DAY" } }, "changePrice": { "summary": "Change Price", "value": { "origClOrdId": "ORDER-123456", "tradingAccountId": "TEST-ACCOUNT-001", "symbol": "AAPL", "side": "BUY", "type": "LIMIT", "qty": "10", "price": "148.50", "timeInForce": "DAY" } } } } } }, "responses": { "200": { "description": "Replace request submitted successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReplaceOrdResponse" }, "example": { "success": true, "clOrdId": "ORDER-20260115-003", "origClOrdId": "ORDER-20260115-001", "status": "REPLACED", "qty": "200", "price": "175.50", "text": "Replace accepted", "transactTime": "2026-01-15T14:31:00Z" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalServerError" }, "503": { "description": "Broker connection not established", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "504": { "description": "Replace response timeout", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "OAuth2": [ "order:execution" ] } ], "parameters": [] } }, "/v1/indices/groups": { "get": { "tags": [ "Indices" ], "summary": "Get Index Groups", "description": "List all index groups (publishers / index families) currently available. The response is the canonical source — fetch this and cache it locally to populate dropdown menus that drive other indices endpoints, instead of hard-coding the group list in your app.", "operationId": "list_index_groups", "parameters": [], "responses": { "200": { "description": "Successful response with list of index groups", "content": { "application/json": { "schema": { "type": "object", "properties": { "indexGroups": { "type": "array", "description": "Array of available index groups", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "Unique identifier for the index group", "example": "IND_CBOC" }, "description": { "type": "string", "description": "Human-readable description of the index group", "example": "CBOE Data Services CMSI - Crypto Fee" } } } } } }, "example": { "indexGroups": [ { "name": "IND_CBOC", "description": "CBOE Data Services CMSI – Crypto Feed" }, { "name": "IND_CBOCGI", "description": "CBOE Global Indices" }, { "name": "IND_CBOF", "description": "CBOE Data Services CMSI – FTSE" }, { "name": "IND_CBOI", "description": "CBOE Data Services CMSI – iNAV" }, { "name": "IND_CBOM", "description": "CBOE Data Services CSMI" }, { "name": "IND_CBOMSTAR", "description": "CBOE Data Services CSMI - Morningstar" }, { "name": "IND_DJI", "description": "Dow Jones Indices" }, { "name": "IND_GIDS", "description": "Nasdaq Global Index Data Service" }, { "name": "IND_GIF", "description": "NYSE Global Indices" }, { "name": "IND_SPF", "description": "S&P Complete Indices" }, { "name": "INDBVMF", "description": "Bm_Fbovespa S.A. - Bolsa De Valores, Mercadorias E Futuros" }, { "name": "INDXNSE", "description": "National Stock Exchange Of India" }, { "name": "INDXSTU", "description": "Borse Stuttgart" }, { "name": "INDXTSE", "description": "Toronto Stock Exchange" } ] } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "security": [ { "OAuth2": [ "market:supplemental" ] } ] } }, "/v1/indices/bar": { "get": { "tags": [ "Indices" ], "summary": "Get Index Bar Data", "description": "Retrieve OHLC (Open, High, Low, Close) bar data for indices across various timeframes for technical analysis.", "operationId": "get_index_bar", "parameters": [ { "name": "identifier", "in": "query", "required": true, "schema": { "type": "string", "example": "SPX.IND_CBOM" }, "description": "Index identifier to query. For `Symbol`-type identifiers, use the full `.` form (e.g. `SPX.IND_CBOM` for the S&P 500 in the CBOE CSMI group). For other identifier types (CUSIP, ISIN, etc.), set `identifierType` accordingly." }, { "name": "identifierType", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/IndicesIdentifierType" }, "description": "How to interpret the value you sent in `identifier`. Defaults to `Symbol`. See `IndicesIdentifierType` for the full set of accepted values." }, { "name": "endTime", "in": "query", "required": true, "schema": { "type": "string", "example": "12/22/2025 10:30 am" }, "description": "End time for the bar window. Format: `MM/DD/YYYY hh:mm am/pm` in the index's native timezone (e.g. `12/22/2025 10:30 am`)." }, { "name": "precision", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "Minutes", "Hours" ], "example": "Minutes" }, "description": "How long each bar covers. Pair with `period` to set the exact size (e.g. `precision=Minutes`, `period=5` = 5-minute bars). Allowed values:\n- `Minutes` — minute bars (combine with `period` for 1, 5, 15, 30-minute candles).\n- `Hours` — hour bars (combine with `period` for 1, 2, 4-hour candles).\n\nFor daily/weekly/monthly bars use [GET /v1/indices/chart-bars](/api-reference/supplemental/indices-chart-bars) which supports a `Daily` precision." }, { "name": "period", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "example": 1 }, "description": "Multiplier on `precision` to set the bar size. Defaults to `1`. Examples: `precision=Minutes` + `period=5` = 5-minute bars; `precision=Hours` + `period=4` = 4-hour bars." } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "index": { "type": "object", "description": "Index metadata and identification", "properties": { "indexName": { "type": "string", "description": "Full name of the index (e.g., S&P 500, Dow Jones)" }, "symbol": { "type": "string", "description": "Index ticker symbol (e.g., SPX, DJI)" }, "indexGroup": { "type": "string", "description": "Index group classification identifier" }, "valoren": { "type": "string", "description": "Swiss securities identification number (Valoren)" }, "currency": { "type": "string", "description": "Currency in which the index is quoted (e.g., USD, EUR)" } } }, "bar": { "type": "object", "description": "OHLC bar data for the requested time period", "properties": { "startDate": { "type": "string", "description": "Bar start date in MM/DD/YYYY format" }, "startTime": { "type": "string", "description": "Bar start time in HH:MM AM/PM format" }, "endDate": { "type": "string", "description": "Bar end date in MM/DD/YYYY format" }, "endTime": { "type": "string", "description": "Bar end time in HH:MM AM/PM format" }, "utcOffset": { "type": "integer", "description": "UTC time offset in hours (e.g., -5 for EST)" }, "open": { "type": "number", "description": "Opening index value for the bar period" }, "high": { "type": "number", "description": "Highest index value during the bar period" }, "low": { "type": "number", "description": "Lowest index value during the bar period" }, "close": { "type": "number", "description": "Closing index value for the bar period" }, "volume": { "type": "integer", "description": "Trading volume during the bar period (may be 0 for indices)" } } } } }, "example": { "index": { "indexName": "S&P 500", "symbol": "SPX", "indexGroup": "IND_CBOM", "valoren": "998434", "currency": "USD" }, "bar": { "startDate": "12/22/2025", "startTime": "10:29 AM", "endDate": "12/22/2025", "endTime": "10:30 AM", "utcOffset": -5, "open": 6866.15, "high": 6866.74, "low": 6865.69, "close": 6866.33, "volume": 0 } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "security": [ { "OAuth2": [ "market:supplemental" ] } ] } }, "/v1/indices/bars": { "get": { "summary": "Get Index Bars Data", "description": "Retrieve OHLC (Open, High, Low, Close) bar data for multiple market indices in a single request. Returns historical price bars with volume data for batch analysis of index movements.", "tags": [ "Indices" ], "parameters": [ { "name": "identifier", "in": "query", "required": true, "schema": { "type": "string", "example": "SPX.IND_CBOM" }, "description": "Index identifier to query. For `Symbol`-type identifiers, use the full `.` form (e.g. `SPX.IND_CBOM`). For other identifier types, set `identifierType` accordingly." }, { "name": "identifierType", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/IndicesIdentifierType" }, "description": "How to interpret the value you sent in `identifier`. Defaults to `Symbol`. See `IndicesIdentifierType` for the full set of accepted values." }, { "name": "startTime", "in": "query", "required": true, "schema": { "type": "string", "example": "12/22/2025 9:30 am" }, "description": "Start of the bars window. Format: `MM/DD/YYYY hh:mm am/pm` in the index's native timezone (e.g. `12/22/2025 9:30 am`)." }, { "name": "endTime", "in": "query", "required": true, "schema": { "type": "string", "example": "12/22/2025 4:00 pm" }, "description": "End of the bars window. Format: `MM/DD/YYYY hh:mm am/pm` in the index's native timezone (e.g. `12/22/2025 4:00 pm`)." }, { "name": "precision", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "Minutes", "Hours" ], "example": "Minutes" }, "description": "How long each bar covers. Pair with `period` to set the exact size (e.g. `precision=Minutes`, `period=5` = 5-minute bars). Allowed values:\n- `Minutes` — minute bars (combine with `period` for 1, 5, 15, 30-minute candles).\n- `Hours` — hour bars (combine with `period` for 1, 2, 4-hour candles).\n\nFor daily/weekly/monthly bars use [GET /v1/indices/chart-bars](/api-reference/supplemental/indices-chart-bars) which supports a `Daily` precision." }, { "name": "period", "in": "query", "required": false, "schema": { "type": "integer" }, "description": "Multiplier on `precision` to set the bar size. Defaults to `1`. Examples: `precision=Minutes` + `period=5` = 5-minute bars; `precision=Hours` + `period=4` = 4-hour bars." } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "bars": { "type": "array", "items": { "type": "object", "properties": { "startDate": { "type": "string" }, "startTime": { "type": "string" }, "endDate": { "type": "string" }, "endTime": { "type": "string" }, "open": { "type": "number" }, "high": { "type": "number" }, "low": { "type": "number" }, "close": { "type": "number" }, "volume": { "type": "integer" } } } } } }, "examples": { "success": { "value": { "bars": [ { "startDate": "12/22/2025", "startTime": "9:30 AM", "endDate": "12/22/2025", "endTime": "9:31 AM", "open": 6860, "high": 6865, "low": 6858.5, "close": 6863.25, "volume": 0 } ] } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "security": [ { "OAuth2": [ "market:supplemental" ] } ], "operationId": "get_v1_indices_bars" } }, "/v1/indices/by-group": { "get": { "summary": "Get Indices By Group", "description": "Retrieve all market indices belonging to a specific group category. Returns detailed information about indices within groups like Technology, Healthcare, International, or Custom portfolios.", "tags": [ "Indices" ], "parameters": [ { "name": "indexGroup", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/IndexGroup" }, "description": "Index group to retrieve recently-updated members from. Use [GET /v1/indices/groups](/api-reference/supplemental/indices-groups) to discover the live list — see `IndexGroup` for the current published set with plain-English labels." } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "indices": { "type": "array", "items": { "type": "object", "properties": { "indexName": { "type": "string", "description": "Full name of the index" }, "symbol": { "type": "string", "description": "Index symbol" }, "indexGroup": { "type": "string", "description": "Index group identifier" }, "currency": { "type": "string", "description": "Currency code" }, "valoren": { "type": "string", "description": "Swiss securities identification number (Valoren)" } } } } } }, "examples": { "success": { "value": { "indices": [ { "indexName": "S&P 500", "symbol": "SPX", "indexGroup": "IND_CBOM", "currency": "USD", "valoren": "998434" }, { "indexName": "NASDAQ Composite", "symbol": "COMP", "indexGroup": "IND_CBOM", "currency": "USD", "valoren": "1269719" } ] } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "security": [ { "OAuth2": [ "market:supplemental" ] } ], "operationId": "get_v1_indices_by_group" } }, "/v1/calendars/mergers-acquisitions": { "get": { "tags": [ "Calendar" ], "summary": "Get Mergers & Acquisitions", "description": "Retrieve M&A activity including announced deals, merger terms, acquisition prices, and transaction timelines.", "operationId": "get_mergers_and_acquisitions", "parameters": [ { "name": "dateFrom", "in": "query", "required": false, "schema": { "format": "date", "type": "string" }, "example": "2024-01-01", "description": "Start date in YYYY-MM-DD format. Enter the first date to include in the research window." }, { "name": "dateTo", "in": "query", "required": false, "schema": { "format": "date", "type": "string" }, "example": "2024-12-31", "description": "End date in YYYY-MM-DD format. Enter the last date to include in the research window." }, { "name": "tickers", "in": "query", "required": false, "schema": { "type": "string" }, "example": "AAPL,MSFT", "description": "Comma-separated ticker symbols, such as AAPL,MSFT. Use this to request or filter multiple companies in one call." }, { "name": "page", "in": "query", "required": false, "schema": { "minimum": 0, "type": "integer" }, "example": 0, "description": "Zero-based page offset. Enter 0 for the first page of results." }, { "name": "pageSize", "in": "query", "required": false, "schema": { "minimum": 1, "maximum": 1000, "type": "integer" }, "example": 50, "description": "Number of results per page. Use this to control pagination size in list views. (1-1000)" } ], "responses": { "200": { "description": "Successful response with mergers and acquisitions data", "content": { "application/json": { "schema": { "type": "object", "properties": { "mergersAcquisitions": { "type": "array", "description": "Array of merger and acquisition events", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the M&A event" }, "date": { "type": "string", "format": "date", "description": "Date of the M&A event" }, "dateExpected": { "type": "string", "format": "date", "description": "Expected closing date" }, "acquirerTicker": { "type": "string", "description": "Ticker of the acquiring company" }, "acquirerName": { "type": "string", "description": "Name of the acquiring company" }, "acquirerExchange": { "type": "string", "description": "Exchange of the acquiring company" }, "targetTicker": { "type": "string", "description": "Stock ticker symbol of the target company. Enter the exact ticker, such as AAPL." }, "targetName": { "type": "string", "description": "Name of the target company" }, "targetExchange": { "type": "string", "description": "Stock exchange where target is traded" }, "currency": { "type": "string", "description": "Currency of the deal" }, "dealType": { "type": "string", "description": "Type of deal (Acquisition, Merger, etc.)" }, "dealSize": { "type": "string", "description": "Size of the deal in the specified currency" }, "dealPaymentType": { "type": "string", "description": "Payment method (Cash, Stock, Mixed, etc.)" }, "dealStatus": { "type": "string", "description": "Current status of the deal (Completed, Pending, etc.)" }, "importance": { "type": "integer", "description": "Importance rating of the event" }, "notes": { "type": "string", "description": "Additional notes" }, "updated": { "type": "integer", "format": "int64", "description": "Unix timestamp of last update" } } } } } }, "example": { "mergersAcquisitions": [ { "id": "69ef44f637e2c8000176cd80", "date": "2026-04-27", "dateExpected": "2026-H2", "acquirerTicker": "YAAS", "acquirerName": "Youxin Technology", "acquirerExchange": "NASDAQ", "targetTicker": "XOMA", "targetName": "YATOP Group Limited", "targetExchange": "NASDAQ", "currency": "USD", "dealType": "Acquisition", "dealSize": "10800000", "dealPaymentType": "Cash", "dealStatus": "Announced", "importance": 1, "notes": "Youxin Technology Ltd announced that on April 21, 2026, the Company entered into a definitive share acquisition agreement with seven shareholders of YATOP Group Limited to acquire 18% of the equity interests in YATOP Group Limited.", "updated": 1777288524 } ] } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "security": [ { "OAuth2": [ "calendar:information" ] } ] } }, "/v1/indices/chart-bars": { "get": { "tags": [ "Indices" ], "summary": "Get Index Chart Data", "description": "Retrieve historical chart data for indices including price history, volume, and returns for creating index performance charts.", "operationId": "get_chart_bars", "parameters": [ { "name": "identifier", "in": "query", "required": true, "schema": { "type": "string", "example": "SPX.IND_CBOM" }, "description": "Index identifier to query. For `Symbol`-type identifiers, use the full `.` form (e.g. `SPX.IND_CBOM`). For other identifier types, set `identifierType` accordingly." }, { "name": "identifierType", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/IndicesIdentifierType" }, "description": "How to interpret the value you sent in `identifier`. Defaults to `Symbol`. See `IndicesIdentifierType` for the full set of accepted values." }, { "name": "startTime", "in": "query", "required": true, "schema": { "type": "string", "example": "12/15/2025 9:00 am" }, "description": "Start of the chart range, inclusive. Format: `MM/DD/YYYY hh:mm am/pm` in the index's native timezone (e.g. `12/15/2025 9:00 am`)." }, { "name": "endTime", "in": "query", "required": true, "schema": { "type": "string", "example": "12/15/2025 9:30 am" }, "description": "End of the chart range, inclusive. Format: `MM/DD/YYYY hh:mm am/pm` in the index's native timezone (e.g. `12/15/2025 9:30 am`)." }, { "name": "precision", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "Minute", "Hour", "Daily" ], "example": "Minute" }, "description": "How long each chart bar covers. Pair with `period` to set the exact size. Note the singular form (different from `/v1/indices/bar` and `/v1/indices/bars`). Allowed values:\n- `Minute` — minute bars (intraday).\n- `Hour` — hour bars.\n- `Daily` — daily bars (use for multi-month or yearly charts)." }, { "name": "period", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "example": 15 }, "description": "Multiplier on `precision` to set the bar size. Defaults to `1`. Examples: `precision=Minute` + `period=15` = 15-minute bars; `precision=Daily` + `period=1` = daily bars." }, { "name": "adjustmentMethod", "in": "query", "required": false, "schema": { "type": "string" }, "description": "How to adjust historical prices for corporate actions like dividends and splits. Pass the literal value supported by the upstream data provider. Omit to leave prices unadjusted." }, { "name": "includeExtended", "in": "query", "required": false, "schema": { "type": "boolean", "default": false }, "description": "Include pre-market and after-hours sessions in the returned chart bars. Defaults to `false` (regular hours only). Set `true` when you want a continuous extended-session chart." } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "timing": { "type": "string", "description": "Data timing type (RealTime or Delayed)" }, "indexName": { "type": "string", "description": "Full name of the index" }, "symbol": { "type": "string", "description": "Index ticker symbol" }, "indexGroup": { "type": "string", "description": "Index group classification" }, "valoren": { "type": "string", "description": "Swiss securities identification number (Valoren)" }, "currency": { "type": "string", "description": "Currency in which the index is quoted" }, "chartBars": { "type": "array", "description": "Array of historical chart bars", "items": { "type": "object", "properties": { "startDate": { "type": "string", "description": "Bar start date in MM/DD/YYYY format" }, "startTime": { "type": "string", "description": "Bar start time in HH:MM:SS AM/PM format" }, "endDate": { "type": "string", "description": "Bar end date in MM/DD/YYYY format" }, "endTime": { "type": "string", "description": "Bar end time in HH:MM:SS AM/PM format" }, "utcOffset": { "type": "integer", "description": "UTC time offset in hours" }, "open": { "type": "number", "description": "Opening index value for the bar period" }, "high": { "type": "number", "description": "Highest index value during the bar period" }, "low": { "type": "number", "description": "Lowest index value during the bar period" }, "close": { "type": "number", "description": "Closing index value for the bar period" }, "volume": { "type": "integer", "description": "Trading volume during the bar period" }, "trades": { "type": "integer", "description": "Number of trades during the bar period" }, "twap": { "type": "number", "description": "Time-Weighted Average Price for the bar period" }, "vwap": { "type": "number", "description": "Volume-Weighted Average Price for the bar period" }, "currency": { "type": "string", "description": "Currency of the bar data" }, "session": { "type": "string", "description": "Trading session type (Market, PreMarket, PostMarket)" }, "adjustmentRatio": { "type": "integer", "description": "Price adjustment ratio for corporate actions" } } } } } }, "example": { "timing": "RealTime", "indexName": "", "symbol": "", "indexGroup": "", "valoren": "", "currency": "", "chartBars": [ { "startDate": "12/15/2025", "startTime": "9:30:00 AM", "endDate": "12/15/2025", "endTime": "9:45:00 AM", "utcOffset": -5, "open": 6860.19, "high": 6861.59, "low": 6843.83, "close": 6844.19, "volume": 0, "trades": 899, "twap": 6851.9613, "vwap": 6843.83, "currency": "USD", "session": "Market", "adjustmentRatio": 0 }, { "startDate": "12/15/2025", "startTime": "9:45:00 AM", "endDate": "12/15/2025", "endTime": "10:00:00 AM", "utcOffset": -5, "open": 6844.16, "high": 6846.56, "low": 6831.4, "close": 6832.36, "volume": 0, "trades": 900, "twap": 6838.5177, "vwap": 6831.4, "currency": "USD", "session": "Market", "adjustmentRatio": 0 }, { "startDate": "12/15/2025", "startTime": "10:00:00 AM", "endDate": "12/15/2025", "endTime": "10:15:00 AM", "utcOffset": -5, "open": 6833.16, "high": 6834.26, "low": 6820.26, "close": 6822.83, "volume": 0, "trades": 900, "twap": 6826.8695, "vwap": 6820.26, "currency": "USD", "session": "Market", "adjustmentRatio": 0 }, { "startDate": "12/15/2025", "startTime": "10:15:00 AM", "endDate": "12/15/2025", "endTime": "10:30:00 AM", "utcOffset": -5, "open": 6822.78, "high": 6823.05, "low": 6801.49, "close": 6806.81, "volume": 0, "trades": 900, "twap": 6813.8597, "vwap": 6801.49, "currency": "USD", "session": "Market", "adjustmentRatio": 0 }, { "startDate": "12/15/2025", "startTime": "10:30:00 AM", "endDate": "12/15/2025", "endTime": "10:45:00 AM", "utcOffset": -5, "open": 6806.76, "high": 6827.29, "low": 6804.94, "close": 6827.29, "volume": 0, "trades": 900, "twap": 6816.6889, "vwap": 6804.94, "currency": "USD", "session": "Market", "adjustmentRatio": 0 }, { "startDate": "12/15/2025", "startTime": "10:45:00 AM", "endDate": "12/15/2025", "endTime": "11:00:00 AM", "utcOffset": -5, "open": 6827.22, "high": 6830.22, "low": 6816.7, "close": 6820.68, "volume": 0, "trades": 900, "twap": 6823.9963, "vwap": 6816.7, "currency": "USD", "session": "Market", "adjustmentRatio": 0 }, { "startDate": "12/15/2025", "startTime": "11:00:00 AM", "endDate": "12/15/2025", "endTime": "11:15:00 AM", "utcOffset": -5, "open": 6820.63, "high": 6827.44, "low": 6816.14, "close": 6820.21, "volume": 0, "trades": 900, "twap": 6821.8198, "vwap": 6816.14, "currency": "USD", "session": "Market", "adjustmentRatio": 0 }, { "startDate": "12/15/2025", "startTime": "11:15:00 AM", "endDate": "12/15/2025", "endTime": "11:30:00 AM", "utcOffset": -5, "open": 6819.79, "high": 6839.86, "low": 6819.44, "close": 6837.3, "volume": 0, "trades": 900, "twap": 6834.2223, "vwap": 6819.44, "currency": "USD", "session": "Market", "adjustmentRatio": 0 }, { "startDate": "12/15/2025", "startTime": "11:30:00 AM", "endDate": "12/15/2025", "endTime": "11:45:00 AM", "utcOffset": -5, "open": 6837.34, "high": 6838.18, "low": 6813.99, "close": 6814.58, "volume": 0, "trades": 900, "twap": 6822.1946, "vwap": 6813.99, "currency": "USD", "session": "Market", "adjustmentRatio": 0 }, { "startDate": "12/15/2025", "startTime": "11:45:00 AM", "endDate": "12/15/2025", "endTime": "12:00:00 PM", "utcOffset": -5, "open": 6814.57, "high": 6826.3, "low": 6810.98, "close": 6818, "volume": 0, "trades": 900, "twap": 6817.5184, "vwap": 6810.98, "currency": "USD", "session": "Market", "adjustmentRatio": 0 }, { "startDate": "12/15/2025", "startTime": "12:00:00 PM", "endDate": "12/15/2025", "endTime": "12:15:00 PM", "utcOffset": -5, "open": 6818.1, "high": 6822.06, "low": 6815.23, "close": 6817.63, "volume": 0, "trades": 900, "twap": 6818.8814, "vwap": 6815.23, "currency": "USD", "session": "Market", "adjustmentRatio": 0 }, { "startDate": "12/15/2025", "startTime": "12:15:00 PM", "endDate": "12/15/2025", "endTime": "12:30:00 PM", "utcOffset": -5, "open": 6817.6, "high": 6819.74, "low": 6811.53, "close": 6815.21, "volume": 0, "trades": 900, "twap": 6815.6719, "vwap": 6811.53, "currency": "USD", "session": "Market", "adjustmentRatio": 0 }, { "startDate": "12/15/2025", "startTime": "12:30:00 PM", "endDate": "12/15/2025", "endTime": "12:45:00 PM", "utcOffset": -5, "open": 6815.36, "high": 6823.27, "low": 6810.33, "close": 6820.97, "volume": 0, "trades": 900, "twap": 6816.3734, "vwap": 6810.33, "currency": "USD", "session": "Market", "adjustmentRatio": 0 }, { "startDate": "12/15/2025", "startTime": "12:45:00 PM", "endDate": "12/15/2025", "endTime": "1:00:00 PM", "utcOffset": -5, "open": 6821.01, "high": 6822.93, "low": 6803.53, "close": 6814.43, "volume": 0, "trades": 900, "twap": 6811.7483, "vwap": 6803.53, "currency": "USD", "session": "Market", "adjustmentRatio": 0 }, { "startDate": "12/15/2025", "startTime": "1:00:00 PM", "endDate": "12/15/2025", "endTime": "1:15:00 PM", "utcOffset": -5, "open": 6814.25, "high": 6819.77, "low": 6809.4, "close": 6819.12, "volume": 0, "trades": 900, "twap": 6816.0944, "vwap": 6809.4, "currency": "USD", "session": "Market", "adjustmentRatio": 0 }, { "startDate": "12/15/2025", "startTime": "1:15:00 PM", "endDate": "12/15/2025", "endTime": "1:30:00 PM", "utcOffset": -5, "open": 6819.1, "high": 6820.86, "low": 6804.38, "close": 6809.05, "volume": 0, "trades": 900, "twap": 6811.9329, "vwap": 6804.38, "currency": "USD", "session": "Market", "adjustmentRatio": 0 }, { "startDate": "12/15/2025", "startTime": "1:30:00 PM", "endDate": "12/15/2025", "endTime": "1:45:00 PM", "utcOffset": -5, "open": 6809.05, "high": 6812.86, "low": 6805.85, "close": 6811.84, "volume": 0, "trades": 900, "twap": 6809.5621, "vwap": 6805.85, "currency": "USD", "session": "Market", "adjustmentRatio": 0 }, { "startDate": "12/15/2025", "startTime": "1:45:00 PM", "endDate": "12/15/2025", "endTime": "2:00:00 PM", "utcOffset": -5, "open": 6811.79, "high": 6823.17, "low": 6811.44, "close": 6819.96, "volume": 0, "trades": 900, "twap": 6816.8972, "vwap": 6811.44, "currency": "USD", "session": "Market", "adjustmentRatio": 0 }, { "startDate": "12/15/2025", "startTime": "2:00:00 PM", "endDate": "12/15/2025", "endTime": "2:15:00 PM", "utcOffset": -5, "open": 6819.77, "high": 6824.29, "low": 6817.3, "close": 6817.31, "volume": 0, "trades": 900, "twap": 6820.8777, "vwap": 6817.3, "currency": "USD", "session": "Market", "adjustmentRatio": 0 }, { "startDate": "12/15/2025", "startTime": "2:15:00 PM", "endDate": "12/15/2025", "endTime": "2:30:00 PM", "utcOffset": -5, "open": 6817.15, "high": 6820.63, "low": 6814.21, "close": 6817.42, "volume": 0, "trades": 900, "twap": 6817.1158, "vwap": 6814.21, "currency": "USD", "session": "Market", "adjustmentRatio": 0 }, { "startDate": "12/15/2025", "startTime": "2:30:00 PM", "endDate": "12/15/2025", "endTime": "2:45:00 PM", "utcOffset": -5, "open": 6817.48, "high": 6819.85, "low": 6814.44, "close": 6814.78, "volume": 0, "trades": 900, "twap": 6816.7213, "vwap": 6814.44, "currency": "USD", "session": "Market", "adjustmentRatio": 0 }, { "startDate": "12/15/2025", "startTime": "2:45:00 PM", "endDate": "12/15/2025", "endTime": "3:00:00 PM", "utcOffset": -5, "open": 6815.12, "high": 6826.61, "low": 6813.65, "close": 6825.98, "volume": 0, "trades": 900, "twap": 6818.3141, "vwap": 6813.65, "currency": "USD", "session": "Market", "adjustmentRatio": 0 }, { "startDate": "12/15/2025", "startTime": "3:00:00 PM", "endDate": "12/15/2025", "endTime": "3:15:00 PM", "utcOffset": -5, "open": 6826.02, "high": 6826.46, "low": 6819.6, "close": 6822.27, "volume": 0, "trades": 900, "twap": 6823.727, "vwap": 6819.6, "currency": "USD", "session": "Market", "adjustmentRatio": 0 }, { "startDate": "12/15/2025", "startTime": "3:15:00 PM", "endDate": "12/15/2025", "endTime": "3:30:00 PM", "utcOffset": -5, "open": 6822.1, "high": 6824.95, "low": 6816.35, "close": 6819.83, "volume": 0, "trades": 900, "twap": 6820.0834, "vwap": 6816.35, "currency": "USD", "session": "Market", "adjustmentRatio": 0 }, { "startDate": "12/15/2025", "startTime": "3:30:00 PM", "endDate": "12/15/2025", "endTime": "3:45:00 PM", "utcOffset": -5, "open": 6819.8, "high": 6822.13, "low": 6814.62, "close": 6815.78, "volume": 0, "trades": 900, "twap": 6817.6248, "vwap": 6814.62, "currency": "USD", "session": "Market", "adjustmentRatio": 0 }, { "startDate": "12/15/2025", "startTime": "3:45:00 PM", "endDate": "12/15/2025", "endTime": "4:00:00 PM", "utcOffset": -5, "open": 6815.92, "high": 6824.84, "low": 6815.28, "close": 6816.34, "volume": 0, "trades": 900, "twap": 6819.7096, "vwap": 6815.28, "currency": "USD", "session": "Market", "adjustmentRatio": 0 }, { "startDate": "12/15/2025", "startTime": "4:00:00 PM", "endDate": "12/15/2025", "endTime": "4:15:00 PM", "utcOffset": -5, "open": 6816.11, "high": 6816.54, "low": 6816.11, "close": 6816.51, "volume": 0, "trades": 900, "twap": 6816.5103, "vwap": 6816.11, "currency": "USD", "session": "Market", "adjustmentRatio": 0 }, { "startDate": "12/15/2025", "startTime": "4:15:00 PM", "endDate": "12/15/2025", "endTime": "4:30:00 PM", "utcOffset": -5, "open": 6816.51, "high": 6816.51, "low": 6816.51, "close": 6816.51, "volume": 0, "trades": 301, "twap": 6816.51, "vwap": 6816.51, "currency": "USD", "session": "Market", "adjustmentRatio": 0 }, { "startDate": "12/15/2025", "startTime": "4:30:00 PM", "endDate": "12/15/2025", "endTime": "4:45:00 PM", "utcOffset": -5, "open": 6816.51, "high": 6816.51, "low": 6816.51, "close": 6816.51, "volume": 0, "trades": 1, "twap": 6816.51, "vwap": 6816.51, "currency": "USD", "session": "Market", "adjustmentRatio": 0 } ] } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "security": [ { "OAuth2": [ "market:supplemental" ] } ] } }, "/v1/indices/list": { "get": { "tags": [ "Indices" ], "summary": "Get Index List", "description": "Retrieve comprehensive list of available indices including major market indices, sector indices, and international benchmarks.", "operationId": "list_indices", "parameters": [ { "name": "indexGroup", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/IndexGroup" }, "description": "Index group whose members you want to list (paginated). Use [GET /v1/indices/groups](/api-reference/supplemental/indices-groups) to discover the live list of groups — see `IndexGroup` for the current published set with plain-English labels." }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 1000, "example": 100 }, "description": "Number of results per page. Use this to control pagination size in list views. (default: 100, max: 1000)" }, { "name": "nextPage", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Pagination token for the next page. Omit it on the first request, then send the returned token to continue paging." } ], "responses": { "200": { "description": "Successful response with list of indices", "content": { "application/json": { "schema": { "type": "object", "properties": { "indices": { "type": "array", "description": "Array of indices in the specified index group", "items": { "type": "object", "properties": { "indexName": { "type": "string", "description": "Index name", "example": "S&P 500" }, "symbol": { "type": "string", "description": "Index symbol identifier", "example": "SPX" }, "indexGroup": { "type": "string", "description": "Index group identifier", "example": "IND_CBOM" }, "currency": { "type": "string", "description": "Currency of the index", "example": "USD" } } } } } }, "example": { "indices": [ { "indexName": "S&P 500", "symbol": "SPX", "indexGroup": "IND_CBOM", "currency": "USD" }, { "indexName": "NASDAQ Composite", "symbol": "COMP", "indexGroup": "IND_CBOM", "currency": "USD" } ] } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "security": [ { "OAuth2": [ "market:supplemental" ] } ] } }, "/v1/logos/sync": { "get": { "tags": [ "Logos" ], "summary": "Sync Company Logos", "description": "Synchronize and retrieve the latest company logos ensuring brand assets are up-to-date across all platforms.", "operationId": "sync_logos", "parameters": [ { "name": "fields", "in": "query", "required": true, "schema": { "type": "string", "example": "logo_light,logo_dark,mark_light,mark_dark" }, "description": "Comma-separated list of logo asset fields to return. Common values:\n- `logo_light` — full logo for light backgrounds.\n- `logo_dark` — full logo for dark backgrounds.\n- `mark_light` — square/icon mark for light backgrounds.\n- `mark_dark` — square/icon mark for dark backgrounds.\n\nOther provider-defined fields may also be supported — pass any field name the upstream image catalog exposes." }, { "name": "updatedSince", "in": "query", "required": false, "schema": { "type": "integer", "format": "int64", "minimum": 0 }, "description": "Only return logos updated since this Unix timestamp" }, { "name": "compositeAuto", "in": "query", "required": false, "schema": { "type": "boolean", "default": false }, "description": "Whether to auto-generate composite logo marks. Use true when you need fallback visuals for symbols without a standard logo." }, { "name": "compositeRadius", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "maximum": 50 }, "description": "Corner radius for generated composite logos. Enter a value from 0 to 50 to match your UI style." }, { "name": "scale", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Image scale for returned logo URLs. Use higher scale values for high-density displays." }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "example": 0 }, "description": "Zero-based page offset. Enter 0 for the first page of results." }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 1000, "example": 10 }, "description": "Number of results per page. Use this to control pagination size in list views. (1-1000)" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "files": { "type": "object", "properties": { "logoLight": { "type": "string" }, "logoDark": { "type": "string" }, "logoVectorLight": { "type": "string" }, "logoVectorDark": { "type": "string" }, "markLight": { "type": "string" }, "markDark": { "type": "string" }, "markVectorLight": { "type": "string" }, "markVectorDark": { "type": "string" }, "markCompositeLight": { "type": "string" }, "markCompositeDark": { "type": "string" } } }, "colors": { "type": "object", "additionalProperties": true, "description": "Key-value map; may be empty. Keys vary by record." }, "securities": { "type": "array", "items": { "type": "object", "properties": { "symbol": { "type": "string" }, "name": { "type": "string" }, "cik": { "type": "string" }, "exchange": { "type": "string", "description": "Exchange code where the data originates. Format depends on the upstream data source and may use MIC, ISO 10383, or a vendor-specific code." }, "cusip": { "type": "string" }, "isin": { "type": "string" } } } } } } }, "page": { "type": "integer" }, "pageSize": { "type": "integer" }, "hasMore": { "type": "boolean" } } }, "example": { "ok": true, "data": [ { "id": "86aefe49-3887-4fcc-a31d-45f424cbdfe4", "createdAt": "2025-12-23T18:03:57.93218Z", "updatedAt": "2025-12-23T18:03:57.93218Z", "files": { "logoLight": "https://api.aries.com/api/v1/logos/image/api/v2/logos/file/image/BBG01JFKBBW4/logo_light__2a0b491e883b5f74bc46de09a0dbc176.png?x-bz-cred=sb~3p2MXEdYfTHFG2P9rItaehAxU1ffpKKIoAD_zUbnCB41Np3XpbXToKHwXHl5Oew4PHqZcWn1xRbDw_kRZitxXQLnOik1r76i3jEyGVzQRv6S60kjw3CBfumPerJ2U7gn2-jO5JcxhkA%3D&x-bz-exp=1766642658&x-bz-signature=9e0191111300cdc51c8bd791a21d1c84f528325e5c1913261314c4a791ab936a", "logoDark": "https://api.aries.com/api/v1/logos/image/api/v2/logos/file/image/BBG01JFKBBW4/logo_dark__39aeab02b803b01f39d39edce7adabad.png?x-bz-cred=sb~3p2MXEdYfTHFG2P9rItaehAxU1ffpKKIoAD_zUbnCB41Np3XpbXToKHwXHl5Oew4PHqZcWn1xRbDw_kRZitxXQLnOik1r76i3jEyGVzQRv6S60kjw3CBfumPerJ2U7gn2-jO5JcxhkA%3D&x-bz-exp=1766642658&x-bz-signature=5f8a4b38d1bbc6ebf08a7d0a3b70c14502a8674a26a39227a40857b0ed0d48fb", "logoVectorLight": "https://api.aries.com/api/v1/logos/image/api/v2/logos/file/image/BBG01JFKBBW4/logo_vector_light__36cb15b2a48b0f04aab6ec1fc9e0b67c.svg?x-bz-cred=sb~3p2MXEdYfTHFG2P9rItaehAxU1ffpKKIoAD_zUbnCB41Np3XpbXToKHwXHl5Oew4PHqZcWn1xRbDw_kRZitxXQLnOik1r76i3jEyGVzQRv6S60kjw3CBfumPerJ2U7gn2-jO5JcxhkA%3D&x-bz-exp=1766642658&x-bz-signature=eb2f840bb5c0efe13a87a76c6e02b4ee3279b2c522f21fbdefe0f1041b6de19c", "logoVectorDark": "https://api.aries.com/api/v1/logos/image/api/v2/logos/file/image/BBG01JFKBBW4/logo_vector_dark__3df6a82dbef079dc349e3d26a784435b.svg?x-bz-cred=sb~3p2MXEdYfTHFG2P9rItaehAxU1ffpKKIoAD_zUbnCB41Np3XpbXToKHwXHl5Oew4PHqZcWn1xRbDw_kRZitxXQLnOik1r76i3jEyGVzQRv6S60kjw3CBfumPerJ2U7gn2-jO5JcxhkA%3D&x-bz-exp=1766642658&x-bz-signature=ca9a1dfc942907b6f4c3572eed94f978c9333b9b635781af1c71fc3effef08ac", "markLight": "https://api.aries.com/api/v1/logos/image/api/v2/logos/file/image/BBG01JFKBBW4/mark_light__f1d3a5ea9ad84f7e347fe648b57933d4.png?x-bz-cred=sb~3p2MXEdYfTHFG2P9rItaehAxU1ffpKKIoAD_zUbnCB41Np3XpbXToKHwXHl5Oew4PHqZcWn1xRbDw_kRZitxXQLnOik1r76i3jEyGVzQRv6S60kjw3CBfumPerJ2U7gn2-jO5JcxhkA%3D&x-bz-exp=1766642658&x-bz-signature=9ff2ae7c66a409d169ec7f9dea793350d7561a6d7be99d27ab853a59d675a2cf", "markDark": "https://api.aries.com/api/v1/logos/image/api/v2/logos/file/image/BBG01JFKBBW4/mark_dark__ccb53062b2314846e0706867445ea6ba.png?x-bz-cred=sb~3p2MXEdYfTHFG2P9rItaehAxU1ffpKKIoAD_zUbnCB41Np3XpbXToKHwXHl5Oew4PHqZcWn1xRbDw_kRZitxXQLnOik1r76i3jEyGVzQRv6S60kjw3CBfumPerJ2U7gn2-jO5JcxhkA%3D&x-bz-exp=1766642658&x-bz-signature=135fe71916cff2c95a89b314c139518c9e80f4705f695ed56374915c6a3b9b26", "markVectorLight": "https://api.aries.com/api/v1/logos/image/api/v2/logos/file/image/BBG01JFKBBW4/mark_vector_light__569f47582181aed5fbdba22afa4cd60b.svg?x-bz-cred=sb~3p2MXEdYfTHFG2P9rItaehAxU1ffpKKIoAD_zUbnCB41Np3XpbXToKHwXHl5Oew4PHqZcWn1xRbDw_kRZitxXQLnOik1r76i3jEyGVzQRv6S60kjw3CBfumPerJ2U7gn2-jO5JcxhkA%3D&x-bz-exp=1766642658&x-bz-signature=6a446e680e9ac2bcba9914d822d4f7bd7de5b7d337ae166ba7e838316dcc6a7e", "markVectorDark": "https://api.aries.com/api/v1/logos/image/api/v2/logos/file/image/BBG01JFKBBW4/mark_vector_dark__66db8bcc1d10bd8d7dc3f6a4585d0045.svg?x-bz-cred=sb~3p2MXEdYfTHFG2P9rItaehAxU1ffpKKIoAD_zUbnCB41Np3XpbXToKHwXHl5Oew4PHqZcWn1xRbDw_kRZitxXQLnOik1r76i3jEyGVzQRv6S60kjw3CBfumPerJ2U7gn2-jO5JcxhkA%3D&x-bz-exp=1766642658&x-bz-signature=ce88bea4593bed218cc78c406c0dcf3741b891fff875958fe74d3db46331f19d", "markCompositeLight": "https://api.aries.com/api/v1/logos/image/api/v2/logos/file/image/BBG01JFKBBW4/mark_composite_light__c85748fb076c4fb45be5df72ffa32875.png?x-bz-cred=sb~3p2MXEdYfTHFG2P9rItaehAxU1ffpKKIoAD_zUbnCB41Np3XpbXToKHwXHl5Oew4PHqZcWn1xRbDw_kRZitxXQLnOik1r76i3jEyGVzQRv6S60kjw3CBfumPerJ2U7gn2-jO5JcxhkA%3D&x-bz-exp=1766642658&x-bz-signature=98e76efff369a148e25877dc2ae7a4de75b3c864823f9b9a45e2b96cc380e874", "markCompositeDark": "https://api.aries.com/api/v1/logos/image/api/v2/logos/file/image/BBG01JFKBBW4/mark_composite_dark__8fd71d48d36514075c21de198b119770.png?x-bz-cred=sb~3p2MXEdYfTHFG2P9rItaehAxU1ffpKKIoAD_zUbnCB41Np3XpbXToKHwXHl5Oew4PHqZcWn1xRbDw_kRZitxXQLnOik1r76i3jEyGVzQRv6S60kjw3CBfumPerJ2U7gn2-jO5JcxhkA%3D&x-bz-exp=1766642658&x-bz-signature=e1512cfa3435e4f40ef12a58c0a9b69d4f2e7c2d87695efc04486c00e446c56c" }, "colors": {}, "securities": [ { "symbol": "GGM", "name": "GGM MACRO ALIGNMENT ETF", "cik": "1551949", "exchange": "NYSE", "cusip": "66538F157", "isin": "US66538F1571" } ] }, { "id": "58dfcd02-0ab6-4988-b258-354b61710189", "createdAt": "2024-02-23T11:36:56.921864Z", "updatedAt": "2025-12-23T17:11:41.683521Z", "files": { "logoLight": "https://api.aries.com/api/v1/logos/image/api/v2/logos/file/image/CA2267472025/logo_light__703d1f4dd69eb488b3f8dbe29317fc85.png?x-bz-cred=sb~3p2MXEdYfTHFG2P9rItaehAxU1ffpKKIoAD_zUbnCB41Np3XpbXToKHwXHl5Oew4PHqZcWn1xRbDw_kRZitxXQLnOik1r76i3jEyGVzQRv6S60kjw3CBfumPerJ2U7gn2-jO5JcxhkA%3D&x-bz-exp=1766642658&x-bz-signature=0f36b3a97013f4a3b79810849ea1b577382f8f4d247c64d7d423e6633ae433b2", "logoDark": "https://api.aries.com/api/v1/logos/image/api/v2/logos/file/image/CA2267472025/logo_dark__1183b378331f6093a1c7f53418dceac1.png?x-bz-cred=sb~3p2MXEdYfTHFG2P9rItaehAxU1ffpKKIoAD_zUbnCB41Np3XpbXToKHwXHl5Oew4PHqZcWn1xRbDw_kRZitxXQLnOik1r76i3jEyGVzQRv6S60kjw3CBfumPerJ2U7gn2-jO5JcxhkA%3D&x-bz-exp=1766642658&x-bz-signature=5c02ac75d6f24e0192395e803a4c91148f5c73114baa7c7c2eec8248bad566b5", "logoVectorLight": "https://api.aries.com/api/v1/logos/image/api/v2/logos/file/image/CA2267472025/logo_vector_light__a53857d2428f595af2b6575e82a68d2a.svg?x-bz-cred=sb~3p2MXEdYfTHFG2P9rItaehAxU1ffpKKIoAD_zUbnCB41Np3XpbXToKHwXHl5Oew4PHqZcWn1xRbDw_kRZitxXQLnOik1r76i3jEyGVzQRv6S60kjw3CBfumPerJ2U7gn2-jO5JcxhkA%3D&x-bz-exp=1766642658&x-bz-signature=14eb8190e5ab6d9fd5d8aba9db82bed143338688638f41e1f8c651c91a86e31d", "logoVectorDark": "https://api.aries.com/api/v1/logos/image/api/v2/logos/file/image/CA2267472025/logo_vector_dark__dea8485fa0035ecb5210bf2cb4f46759.svg?x-bz-cred=sb~3p2MXEdYfTHFG2P9rItaehAxU1ffpKKIoAD_zUbnCB41Np3XpbXToKHwXHl5Oew4PHqZcWn1xRbDw_kRZitxXQLnOik1r76i3jEyGVzQRv6S60kjw3CBfumPerJ2U7gn2-jO5JcxhkA%3D&x-bz-exp=1766642658&x-bz-signature=f4f73f5a871461b4746328e43aee2778290c60304da075dd2e44dab907f9f1ee", "markLight": "https://api.aries.com/api/v1/logos/image/api/v2/logos/file/image/BBG001S66701/mark_light__5e65bfb41b3d50d176b9ab266ac8c8aa.png?x-bz-cred=sb~3p2MXEdYfTHFG2P9rItaehAxU1ffpKKIoAD_zUbnCB41Np3XpbXToKHwXHl5Oew4PHqZcWn1xRbDw_kRZitxXQLnOik1r76i3jEyGVzQRv6S60kjw3CBfumPerJ2U7gn2-jO5JcxhkA%3D&x-bz-exp=1766642658&x-bz-signature=c2d98bebfde1191536a6a8b2d72a9c86f5b133dfee711f0ec0e7b46d4c49ec1a", "markDark": "https://api.aries.com/api/v1/logos/image/api/v2/logos/file/image/BBG001S66701/mark_dark__3bd49ffa823802c97171b096d69b9a19.png?x-bz-cred=sb~3p2MXEdYfTHFG2P9rItaehAxU1ffpKKIoAD_zUbnCB41Np3XpbXToKHwXHl5Oew4PHqZcWn1xRbDw_kRZitxXQLnOik1r76i3jEyGVzQRv6S60kjw3CBfumPerJ2U7gn2-jO5JcxhkA%3D&x-bz-exp=1766642658&x-bz-signature=a72eddf4f0e0a1ed71727f44c5c93a2095d3f6a17474a4307f6454785621bbbd", "markVectorLight": "https://api.aries.com/api/v1/logos/image/api/v2/logos/file/image/BBG001S66701/mark_vector_light__703a80c498b46e67410525aa480cbe03.svg?x-bz-cred=sb~3p2MXEdYfTHFG2P9rItaehAxU1ffpKKIoAD_zUbnCB41Np3XpbXToKHwXHl5Oew4PHqZcWn1xRbDw_kRZitxXQLnOik1r76i3jEyGVzQRv6S60kjw3CBfumPerJ2U7gn2-jO5JcxhkA%3D&x-bz-exp=1766642658&x-bz-signature=974df19abaaffa5440890b76a2478d439bd6ca7951845e4bebdedc4ad3ae5d34", "markVectorDark": "https://api.aries.com/api/v1/logos/image/api/v2/logos/file/image/BBG001S66701/mark_vector_dark__99455b5124314cf38ad6a57d0db5ae9a.svg?x-bz-cred=sb~3p2MXEdYfTHFG2P9rItaehAxU1ffpKKIoAD_zUbnCB41Np3XpbXToKHwXHl5Oew4PHqZcWn1xRbDw_kRZitxXQLnOik1r76i3jEyGVzQRv6S60kjw3CBfumPerJ2U7gn2-jO5JcxhkA%3D&x-bz-exp=1766642658&x-bz-signature=19b16b69d93e6106ec6ac1ed8e71a4e4eb4c84f35e607d49cb0a6ab5212cd072", "markCompositeLight": "https://api.aries.com/api/v1/logos/image/api/v2/logos/file/image/BBG001S66701/mark_composite_light__0baf2af5566a2d4570d756fd0b03dc4b.png?x-bz-cred=sb~3p2MXEdYfTHFG2P9rItaehAxU1ffpKKIoAD_zUbnCB41Np3XpbXToKHwXHl5Oew4PHqZcWn1xRbDw_kRZitxXQLnOik1r76i3jEyGVzQRv6S60kjw3CBfumPerJ2U7gn2-jO5JcxhkA%3D&x-bz-exp=1766642658&x-bz-signature=b389698ec6d83a8bc0dc4bda844042e86a54357d3f8b7fd6c1a0b9329071b74d", "markCompositeDark": "https://api.aries.com/api/v1/logos/image/api/v2/logos/file/image/BBG001S66701/mark_composite_dark__b93481d85ffe04b6aba0ed4f5f9d6c84.png?x-bz-cred=sb~3p2MXEdYfTHFG2P9rItaehAxU1ffpKKIoAD_zUbnCB41Np3XpbXToKHwXHl5Oew4PHqZcWn1xRbDw_kRZitxXQLnOik1r76i3jEyGVzQRv6S60kjw3CBfumPerJ2U7gn2-jO5JcxhkA%3D&x-bz-exp=1766642658&x-bz-signature=365aa84d51c75598f2b57760c0da1c17f9b3ab9d01c1b35272146927487dd686" }, "colors": {}, "securities": [ { "symbol": "CEQ", "name": "CRITERIUM ENERGY LTD", "cik": "N/A", "exchange": "XATS", "cusip": "226747202", "isin": "CA2267472025" }, { "symbol": "CEQ", "name": "CRITERIUM ENERGY LTD", "cik": "N/A", "exchange": "NEOD", "cusip": "226747202", "isin": "CA2267472025" }, { "symbol": "CEQ", "name": "CRITERIUM ENERGY LTD", "cik": "N/A", "exchange": "NEOE", "cusip": "226747202", "isin": "CA2267472025" }, { "symbol": "CEQ", "name": "CRITERIUM ENERGY LTD", "cik": "N/A", "exchange": "OMGA", "cusip": "226747202", "isin": "CA2267472025" }, { "symbol": "CEQ", "name": "CRITERIUM ENERGY LTD", "cik": "N/A", "exchange": "XTSX", "cusip": "226747202", "isin": "CA2267472025" } ] } ], "page": 0, "pageSize": 0, "hasMore": false } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "security": [ { "OAuth2": [ "market:supplemental" ] } ] } }, "/v1/indices/realtime/values": { "get": { "summary": "Get Realtime Indices Values", "description": "Retrieve real-time values for multiple market indices simultaneously. Returns current index levels, percentage changes, and last update timestamps for a batch of indices in a single request.", "tags": [ "Indices" ], "parameters": [ { "name": "identifiers", "in": "query", "required": true, "schema": { "type": "string" }, "description": "One or more index identifiers to fetch real-time values for, comma-separated. For `Symbol`-type identifiers, use the full `.` form (e.g. `SPX.IND_CBOM,COMP.IND_CBOM,DJI.IND_DJI`). All identifiers in one request must be the same type (set via `identifierType`)." }, { "name": "identifierType", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/IndicesIdentifierType" }, "description": "How to interpret each value in `identifiers`. Defaults to `Symbol`. See `IndicesIdentifierType` for the full set of accepted values. All identifiers in one request must be the same type." } ], "responses": { "200": { "description": "Successful response. Each item mirrors the single-index realtime shape: identifier, index metadata, and a value object with OHLC, 52-week range, and change fields.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IndicesRealtimeValuesResponse" }, "examples": { "success": { "value": { "items": [ { "identifier": "SPX.IND_CBOM", "identifierType": "Symbol", "index": { "indexName": "S&P 500", "symbol": "SPX", "indexGroup": "IND_CBOM", "valoren": "998434", "currency": "USD" }, "value": { "high52Weeks": 6978.6, "low52Weeks": 4982.77, "date": "3/23/2026", "time": "5:11:38 PM", "utcOffset": -4, "volume": 0, "open": 6574.96, "high": 6651.62, "low": 6565.55, "last": 6581, "close": 6581, "changeFromOpen": 6.04, "percentChangeFromOpen": 0.0919, "previousClose": 6506.48, "previousCloseDate": "3/20/2026", "changeFromPreviousClose": 74.52, "percentChangeFromPreviousClose": 1.1453 } } ] } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "security": [ { "OAuth2": [ "market:supplemental" ] } ], "operationId": "get_v1_indices_realtime_values" } }, "/v1/indices/search": { "get": { "tags": [ "Indices" ], "summary": "Search Indices", "description": "Search for market indices by name, symbol, or keyword to find specific benchmark indices and sector trackers.", "operationId": "search_indices_by_name", "parameters": [ { "name": "indexName", "in": "query", "required": true, "schema": { "type": "string", "example": "S&P 500" }, "description": "Full or partial index name to search for. Case-insensitive substring match against the index display name (e.g. `S&P 500`, `Dow`, `NASDAQ`). Returns matching indices with their `symbol`, `indexGroup`, and `currency`." } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "indices": { "type": "array", "description": "Array of matching indices", "items": { "type": "object", "properties": { "indexName": { "type": "string", "description": "Full name of the index" }, "symbol": { "type": "string", "description": "Index ticker symbol" }, "indexGroup": { "type": "string", "description": "Index group classification identifier" }, "valoren": { "type": "string", "description": "Swiss securities identification number (Valoren)" }, "currency": { "type": "string", "description": "Currency in which the index is quoted" } } } } } }, "example": { "indices": [ { "indexName": "S&P 500", "symbol": "SP500", "indexGroup": "IND_SPF", "valoren": "998434", "currency": "USD" }, { "indexName": "NEXT FUNDS S&P 500 Semiconductors & Semiconductor Equipment (Industry Group) 35% Capped Index Exchan", "symbol": "346A-JP.IV", "indexGroup": "IND_GIF", "valoren": "0", "currency": "USD" } ] } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "security": [ { "OAuth2": [ "market:supplemental" ] } ] } }, "/v1/logos/search": { "get": { "tags": [ "Logos" ], "summary": "Search Company Logos", "description": "Search for company logos and brand assets by ticker symbol or company name for use in financial applications and dashboards.", "operationId": "search_logos", "parameters": [ { "name": "searchKeys", "in": "query", "required": true, "schema": { "type": "string", "example": "AAPL,MSFT" }, "description": "One or more values to look up, comma-separated. The format depends on `searchKeysType`. For example, with `searchKeysType=symbol` send `AAPL,MSFT`; with `searchKeysType=cik` send `0000320193,0000789019`." }, { "name": "searchKeysType", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "firm_id", "firm" ], "example": "symbol" }, "description": "Tells the API how to interpret the value you send in `searchKeys`. Allowed values:\n- `firm_id` — the value is a firm/company internal ID.\n- `firm` — the value is the firm/company name." }, { "name": "fields", "in": "query", "required": true, "schema": { "type": "string", "example": "logo_light,logo_dark,mark_light,mark_dark" }, "description": "Comma-separated list of logo asset fields to return. Common values:\n- `logo_light` — full logo for light backgrounds.\n- `logo_dark` — full logo for dark backgrounds.\n- `mark_light` — square/icon mark for light backgrounds.\n- `mark_dark` — square/icon mark for dark backgrounds.\n\nOther provider-defined fields may also be supported — pass any field name the upstream image catalog exposes." }, { "name": "compositeAuto", "in": "query", "required": false, "schema": { "type": "boolean", "default": false }, "description": "Whether to auto-generate composite logo marks. Use true when you need fallback visuals for symbols without a standard logo." }, { "name": "compositeRadius", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "maximum": 50 }, "description": "Corner radius for generated composite logos. Enter a value from 0 to 50 to match your UI style." }, { "name": "scale", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Image scale for returned logo URLs. Use higher scale values for high-density displays." } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "description": "Request success status" }, "data": { "type": "array", "description": "Array of logo data matching the search query", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the logo record" }, "searchKey": { "type": "string", "description": "Search key used to identify the company (e.g., NASDAQ:TSLA)" }, "createdAt": { "type": "string", "description": "Timestamp when the logo was first added (ISO 8601 format)" }, "updatedAt": { "type": "string", "description": "Timestamp when the logo was last updated (ISO 8601 format)" }, "files": { "type": "object", "description": "Available logo file variants", "properties": { "logoLight": { "type": "string", "description": "URL to full logo optimized for light backgrounds (PNG)" }, "logoDark": { "type": "string", "description": "URL to full logo optimized for dark backgrounds (PNG)" }, "markLight": { "type": "string", "description": "URL to logo mark/icon optimized for light backgrounds (PNG)" }, "markDark": { "type": "string", "description": "URL to logo mark/icon optimized for dark backgrounds (PNG)" } } }, "colors": { "type": "object", "additionalProperties": true, "description": "Brand color palette (if available)" } } } } } }, "example": { "ok": true, "data": [ { "id": "efc3943a-ddac-4f59-a2cc-47a67583068b", "searchKey": "NASDAQ:TSLA", "createdAt": "2022-05-18T05:19:45.008547Z", "updatedAt": "2025-02-05T09:43:14.303261Z", "files": { "logoLight": "https://api.aries.com/api/v1/logos/image/api/v2/logos/file/image/1318605/logo_light__6895726d0ff148e46c238f91d033e72a.png?x-bz-cred=sb~7nRcPgi4qeJIyQFeeqQwwzQ9oIGzG3im3lzP69O9AaadrloJyrPceYU7vkYcj42dLlYMa00mErg1WDMBdfkPTm9ck4GIgibYFyameIVXguRJja5C-m-9rImZvUA5xKDPMxw0XUbIhJ0%3D&x-bz-exp=1766661741&x-bz-security-isin=&x-bz-security-symbol=NASDAQ%3ATSLA&x-bz-signature=f45530843c3672e927e8208a531453471605c079be21376089b475c83afcbb39", "logoDark": "https://api.aries.com/api/v1/logos/image/api/v2/logos/file/image/1318605/logo_dark__53646042d4c8b507c7eddb70110ee334.png?x-bz-cred=sb~7nRcPgi4qeJIyQFeeqQwwzQ9oIGzG3im3lzP69O9AaadrloJyrPceYU7vkYcj42dLlYMa00mErg1WDMBdfkPTm9ck4GIgibYFyameIVXguRJja5C-m-9rImZvUA5xKDPMxw0XUbIhJ0%3D&x-bz-exp=1766661741&x-bz-security-isin=&x-bz-security-symbol=NASDAQ%3ATSLA&x-bz-signature=d303f6c3b54333d35b03cd6cac0ced99f677dc71593fd5ab9c1b5e864c9e8ae2", "markLight": "https://api.aries.com/api/v1/logos/image/api/v2/logos/file/image/1318605/mark_light__9f4c5c14204006285b479f83bf2c6daf.png?x-bz-cred=sb~7nRcPgi4qeJIyQFeeqQwwzQ9oIGzG3im3lzP69O9AaadrloJyrPceYU7vkYcj42dLlYMa00mErg1WDMBdfkPTm9ck4GIgibYFyameIVXguRJja5C-m-9rImZvUA5xKDPMxw0XUbIhJ0%3D&x-bz-exp=1766661741&x-bz-security-isin=&x-bz-security-symbol=NASDAQ%3ATSLA&x-bz-signature=0699a7851f90ce879177633853bd9ba194d68840017dffbe5d0171b8c2c7acd0", "markDark": "https://api.aries.com/api/v1/logos/image/api/v2/logos/file/image/1318605/mark_dark__842b58b3522329f19bc66ab6b5f3ce2a.png?x-bz-cred=sb~7nRcPgi4qeJIyQFeeqQwwzQ9oIGzG3im3lzP69O9AaadrloJyrPceYU7vkYcj42dLlYMa00mErg1WDMBdfkPTm9ck4GIgibYFyameIVXguRJja5C-m-9rImZvUA5xKDPMxw0XUbIhJ0%3D&x-bz-exp=1766661741&x-bz-security-isin=&x-bz-security-symbol=NASDAQ%3ATSLA&x-bz-signature=9191a7568754f5327ee41d87671af7618a2b6dd79526f870af005ac7cecf575c" }, "colors": {} } ] } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "security": [ { "OAuth2": [ "market:supplemental" ] } ] } }, "/v1/corporate-actions/spinoffs": { "get": { "tags": [ "Corporate Actions" ], "summary": "Get Corporate Spinoffs", "description": "Retrieve information about corporate spinoffs including separation dates, distribution ratios, and details of the newly independent entities.", "operationId": "get_spinoffs", "parameters": [ { "name": "identifier", "in": "query", "required": true, "schema": { "type": "string", "example": "AAPL" }, "description": "Identifier value for the company you're querying. The format depends on `identifierType`:\n- `Symbol` — exchange ticker (e.g. `AAPL`).\n- `CUSIP` — 9-character U.S./Canadian identifier (e.g. `037833100`).\n- `ISIN` — 12-character international identifier (e.g. `US0378331005`).\n- `SEDOL` — 7-character UK identifier.\n- `Valoren` — Swiss security identifier.\n- `FIGI` — Bloomberg Financial Instrument Global Identifier.\n- `CompositeFIGI` — country-level composite FIGI.\n\nMust match the kind selected in `identifierType`." }, { "name": "identifierType", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/TenderOfferIdentifierType" }, "description": "Tells the API how to interpret `identifier`. See `TenderOfferIdentifierType` for the full set of supported values and what each one means." }, { "name": "startDate", "in": "query", "required": true, "schema": { "type": "string", "format": "date", "example": "2020-01-01" }, "description": "Start of the spin-off announcement window, inclusive. Format: `YYYY-MM-DD` (e.g. `2020-01-01`)." }, { "name": "endDate", "in": "query", "required": true, "schema": { "type": "string", "format": "date", "example": "2020-12-31" }, "description": "End of the spin-off announcement window, inclusive. Format: `YYYY-MM-DD` (e.g. `2020-12-31`)." } ], "responses": { "200": { "description": "Successful response with spinoffs data", "content": { "application/json": { "schema": { "type": "object", "properties": { "spinoffs": { "type": "array", "description": "Array of corporate spinoff events", "items": { "type": "object", "properties": { "exDate": { "type": "string", "format": "date", "description": "Ex-date when the stock trades without spinoff rights (YYYY-MM-DD format)" }, "paymentDate": { "type": "string", "format": "date", "description": "Date when spun-off shares are distributed to shareholders (YYYY-MM-DD format)" }, "recordDate": { "type": "string", "format": "date", "description": "Date determining which shareholders receive the spinoff (YYYY-MM-DD format)" }, "declaredDate": { "type": "string", "format": "date", "description": "Date when the spinoff was announced (YYYY-MM-DD format)" }, "ratio": { "type": "string", "description": "Distribution ratio (e.g., 1:1 means one share of new company for each share of parent)" }, "fromSymbol": { "type": "string", "description": "Ticker symbol of the parent company" }, "fromCompanyName": { "type": "string", "description": "Name of the parent company" }, "toSymbol": { "type": "string", "description": "Ticker symbol of the spun-off company" }, "toCompanyName": { "type": "string", "description": "Name of the spun-off company" }, "description": { "type": "string", "description": "Description of the spinoff transaction" } } } } } }, "example": { "spinoffs": [ { "exDate": "2020-10-15", "paymentDate": "2020-10-15", "recordDate": "2020-10-14", "declaredDate": "2020-09-01", "ratio": "1:1", "fromSymbol": "ILZ.XFRA", "fromCompanyName": "Ilztal AG", "toSymbol": "NEWCO", "toCompanyName": "New Company Inc", "description": "Spinoff of subsidiary operations" } ] } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "security": [ { "OAuth2": [ "market:supplemental" ] } ] } }, "/v1/economy/inflation": { "get": { "summary": "Get Latest Inflation Data", "description": "Retrieve historical Consumer Price Index (CPI) and Personal Consumption Expenditures (PCE) inflation metrics including core inflation rates and spending data with flexible date filtering.", "parameters": [ { "name": "date", "in": "query", "required": false, "schema": { "type": "string", "format": "date", "example": "2024-01-15" }, "description": "Exact date in YYYY-MM-DD format. Use this when you want one specific calendar day." }, { "name": "dates", "in": "query", "required": false, "schema": { "type": "string", "example": "2024-01-15,2024-01-16" }, "description": "Comma-separated list of dates in YYYY-MM-DD format. Use this when you want several specific dates in one request." }, { "name": "dateFrom", "in": "query", "required": false, "schema": { "type": "string", "format": "date", "example": "2024-01-01" }, "description": "Start-date filter. Returns records on or after this date." }, { "name": "dateTo", "in": "query", "required": false, "schema": { "type": "string", "format": "date", "example": "2024-01-31" }, "description": "End-date filter. Returns records on or before this date." }, { "name": "dateAfter", "in": "query", "required": false, "schema": { "type": "string", "format": "date", "example": "2024-01-01" }, "description": "After-date filter. Returns records after this date, excluding the date itself." }, { "name": "dateBefore", "in": "query", "required": false, "schema": { "type": "string", "format": "date", "example": "2024-01-31" }, "description": "Before-date filter. Returns records before this date, excluding the date itself." }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "example": 100 }, "description": "Maximum number of results to return. Use smaller values for UI pages and larger values for exports within API limits." }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "string" }, "description": "A comma-separated list of sort columns. For each column, append `.asc` or `.desc` to specify direction. Defaults to `date.asc` when not specified." }, { "name": "next", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Pagination cursor from the previous response. Omit it on the first request, then send the returned cursor to fetch the next page. for next page" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "results": { "type": "array", "items": { "type": "object", "properties": { "date": { "type": "string", "description": "Reference date (YYYY-MM-DD)" }, "cpi": { "type": "number", "description": "Consumer Price Index" }, "cpiCore": { "type": "number", "description": "Core CPI (excluding food and energy)" }, "cpiYearOverYear": { "type": "number", "description": "CPI year-over-year change" }, "pce": { "type": "number", "description": "Personal Consumption Expenditures" }, "pceCore": { "type": "number", "description": "Core PCE" }, "pceSpending": { "type": "number", "description": "PCE spending" } } } }, "status": { "type": "string", "description": "Status string from the upstream data provider — typically `OK` for a successful response. Treat any other value as an error indicator alongside the HTTP status code." }, "requestId": { "type": "string" }, "nextUrl": { "type": "string", "description": "URL for next page of results" } } }, "examples": { "success": { "value": { "results": [ { "date": "2025-09-01", "cpi": 324.368, "cpiCore": 330.542, "pce": 127.625, "pceCore": 126.954, "pceSpending": 21152.2 }, { "date": "2024-11-01", "cpi": 316.449, "cpiCore": 322.619, "cpiYearOverYear": 2.74938, "pce": 124.637, "pceCore": 123.962, "pceSpending": 20313.6 } ], "status": "OK", "requestId": "6f5e44c7321c4947a7702654d2d3e0fa", "nextUrl": "https://api.aries.com/v1/economy/inflation?cursor=..." } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "tags": [ "Economy" ], "security": [ { "OAuth2": [ "market:supplemental" ] } ], "operationId": "get_v1_economy_inflation" } }, "/v1/calendars/conference-calls": { "get": { "summary": "Get Conference Calls", "description": "Retrieve upcoming and past earnings conference call schedules including dates, times, and dial-in information for management discussions.", "parameters": [ { "name": "dateFrom", "in": "query", "required": false, "schema": { "type": "string", "format": "date", "example": "2024-01-15" }, "description": "Start date in YYYY-MM-DD format. Enter the first date to include in the research window." }, { "name": "dateTo", "in": "query", "required": false, "schema": { "type": "string", "format": "date", "example": "2024-01-19" }, "description": "End date in YYYY-MM-DD format. Enter the last date to include in the research window." }, { "name": "tickers", "in": "query", "required": false, "schema": { "type": "string", "example": "AAPL,MSFT,GOOGL" }, "description": "Comma-separated list of ticker symbols (max 50)" }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "maximum": 100000, "example": 0 }, "description": "Page number for pagination (0-indexed, max 100000)" }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 1000, "example": 100 }, "description": "Number of results per page. Use this to control pagination size in list views. Enter a value from 1 to 1000 depending on how much data your UI can display." } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "conferenceCalls": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the conference call" }, "date": { "type": "string", "description": "Conference call date in YYYY-MM-DD format" }, "time": { "type": "string", "description": "Conference call time in HH:MM:SS format" }, "name": { "type": "string", "description": "Company name" }, "exchange": { "type": "string", "description": "Exchange code where the data originates. Format depends on the upstream data source and may use MIC, ISO 10383, or a vendor-specific code." }, "ticker": { "type": "string", "description": "Stock ticker symbol, such as AAPL. Use the exact ticker for the company you want to research." }, "startTime": { "type": "string", "description": "Human-readable start time with timezone" }, "webcastUrl": { "type": "string", "description": "URL for live webcast of the conference call" }, "importance": { "type": "integer", "description": "Importance rating of the event (1-5, where 5 is most important)" }, "updated": { "type": "integer", "format": "int64", "description": "Unix timestamp when the record was last updated" }, "phoneNum": { "type": "string", "description": "Domestic dial-in phone number" }, "internationalNum": { "type": "string", "description": "International dial-in phone number" }, "reservationNum": { "type": "string", "description": "Reservation number for the conference call" }, "accessCode": { "type": "string", "description": "Access code for the conference call" }, "notes": { "type": "string", "description": "Additional notes about the conference call" } } } } } }, "examples": { "success": { "value": { "conferenceCalls": [ { "id": "123456", "date": "2024-01-16", "time": "17:00:00", "name": "Apple Inc.", "exchange": "NASDAQ", "ticker": "AAPL", "startTime": "5:00 PM ET", "phoneNum": "1-800-123-4567", "internationalNum": "+1-212-123-4567", "reservationNum": "", "accessCode": "987654", "webcastUrl": "https://investor.apple.com/earnings", "importance": 5, "notes": "Q1 FY2024 Earnings Call", "updated": 1705401600 } ] } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "tags": [ "Calendar" ], "security": [ { "OAuth2": [ "calendar:information" ] } ], "operationId": "get_v1_calendars_conference_calls" } }, "/v1/options/unusual_activity/{symbol}": { "get": { "tags": [ "Options" ], "summary": "Get Options Unusual Activity by Symbol", "description": "Retrieve options unusual activity for a specific underlying symbol (e.g. AAPL, TSLA). Returns options unusual activity data such as unusual volume and block trades. **Required scope:** options:information", "operationId": "getOptionsUnusualActivity", "parameters": [ { "name": "symbol", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Underlying stock symbol (e.g. AAPL, TSLA)." } ], "responses": { "200": { "description": "Options unusual activity: object with trades array. Each trade has symbol, timestamp, type (e.g. block), total_value, total_size, average_price, contract, ask_at_execution, bid_at_execution, sentiment, underlying_price_at_execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OptionsUnusualActivityResponse" }, "example": { "trades": [ { "symbol": "AAPL", "timestamp": "2026-02-25T20:55:00.1041000+00:00", "type": "block", "total_value": 143000.0019, "total_size": 200, "average_price": 7.15, "contract": "AAPL__260306P00280000", "ask_at_execution": 7.15, "bid_at_execution": 6.95, "sentiment": "bearish", "underlying_price_at_execution": 274.59 } ], "next_page": "https://api.aries.com/v1/options/unusual_activity/AAPL?next_page=eyJwYWdlIjoyfQ==" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "security": [ { "OAuth2": [ "options:information" ] } ] } }, "/v1/options/{symbol}/expiry-dates": { "get": { "summary": "Get Options Expiry Dates", "description": "Retrieve all available expiration dates for options contracts of a specific underlying symbol. Returns a list of dates when options for the specified ticker expire.", "parameters": [ { "name": "symbol", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The underlying stock symbol (e.g., AAPL, TSLA, SPY)" } ], "responses": { "200": { "description": "Successful response. Returns symbol and list of expiry dates in YYYY-MM-DD format.", "content": { "application/json": { "schema": { "type": "object", "properties": { "symbol": { "type": "string", "description": "Underlying symbol" }, "expiryDates": { "type": "array", "items": { "type": "string", "format": "date" }, "description": "List of expiration dates in YYYY-MM-DD format" } } }, "examples": { "success": { "value": { "symbol": "AAPL", "expiryDates": [ "2025-01-17", "2025-01-24", "2025-01-31", "2025-02-21" ] } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "tags": [ "Options" ], "security": [ { "OAuth2": [ "options:information" ] } ], "operationId": "get_v1_options_by_symbol_expiry_dates" } }, "/v1/options/{symbol}/contracts/{expiryDate}": { "get": { "summary": "Get Options Contract Symbols", "description": "Retrieve all option contract symbols (OCC symbols) for a specific underlying ticker and expiration date. Returns the complete list of available call and put contracts with their strike prices.", "parameters": [ { "name": "symbol", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The underlying stock symbol (e.g., AAPL, TSLA, SPY)" }, { "name": "expiryDate", "in": "path", "required": true, "schema": { "type": "string", "format": "date" }, "description": "The expiration date in YYYY-MM-DD format" } ], "responses": { "200": { "description": "Successful response. Returns symbol, expiryDate, and separate calls and puts arrays; each item has symbol (OCC ticker) and strikePrice.", "content": { "application/json": { "schema": { "type": "object", "properties": { "symbol": { "type": "string", "description": "Underlying symbol" }, "expiryDate": { "type": "string", "format": "date", "description": "Expiration date YYYY-MM-DD" }, "calls": { "type": "array", "items": { "type": "object", "properties": { "symbol": { "type": "string", "description": "OCC option ticker symbol" }, "strikePrice": { "type": "number", "description": "Strike price" } } } }, "puts": { "type": "array", "items": { "type": "object", "properties": { "symbol": { "type": "string", "description": "OCC option ticker symbol" }, "strikePrice": { "type": "number", "description": "Strike price" } } } } } }, "examples": { "success": { "value": { "symbol": "AAPL", "expiryDate": "2025-01-17", "calls": [ { "symbol": "O:AAPL250117C00150000", "strikePrice": 150 } ], "puts": [ { "symbol": "O:AAPL250117P00150000", "strikePrice": 150 } ] } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "tags": [ "Options" ], "security": [ { "OAuth2": [ "options:information" ] } ], "operationId": "get_v1_options_by_symbol_contracts_by_expiryDate" } }, "/v1/options/activity": { "get": { "summary": "Get Options Activity", "description": "Retrieve unusual options activity including large block trades, high volume contracts, and significant changes in open interest.", "parameters": [ { "name": "dateFrom", "in": "query", "required": false, "schema": { "type": "string", "format": "date" }, "description": "Start date for filtering options activity in YYYY-MM-DD format" }, { "name": "dateTo", "in": "query", "required": false, "schema": { "type": "string", "format": "date" }, "description": "End date for filtering options activity in YYYY-MM-DD format" }, { "name": "tickers", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Comma-separated list of ticker symbols to filter results" }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0 }, "description": "Page number for pagination (zero-based)" }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 1000 }, "description": "Number of results per page. Use this to control pagination size in list views. (default: 100, max: 1000)" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "activities": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the options activity record" }, "date": { "type": "string", "description": "Trade date in YYYY-MM-DD format" }, "time": { "type": "string", "description": "Trade execution time in HH:MM:SS format" }, "ticker": { "type": "string", "description": "Underlying stock ticker symbol" }, "exchange": { "type": "string", "description": "Exchange code where the data originates. Format depends on the upstream data source and may use MIC, ISO 10383, or a vendor-specific code." }, "description": { "type": "string", "description": "Brief description of the options activity" }, "descriptionExtended": { "type": "string", "description": "Detailed description with full trade context" }, "updated": { "type": "integer", "description": "Unix timestamp when the record was last updated" }, "sentiment": { "type": "string", "description": "Market sentiment indicator (BULLISH, BEARISH, NEUTRAL)" }, "aggressorInd": { "type": "string", "description": "Aggressor indicator showing buyer/seller aggressiveness" }, "optionSymbol": { "type": "string", "description": "OCC option symbol identifier" }, "underlyingType": { "type": "string", "description": "Type of underlying security (STOCK, ETF, INDEX)" }, "underlyingPrice": { "type": "string", "description": "Current price of the underlying security" }, "costBasis": { "type": "string", "description": "Total cost of the options position" }, "putCall": { "type": "string", "description": "Option type (PUT or CALL)", "enum": [ "PUT", "CALL", "P", "C" ] }, "strikePrice": { "type": "string", "description": "Strike price of the option contract" }, "price": { "type": "string", "description": "Execution price per contract" }, "size": { "type": "string", "description": "Number of contracts traded" }, "dateExpiration": { "type": "string", "description": "Option expiration date in YYYY-MM-DD format" }, "optionActivityType": { "type": "string", "description": "Type of activity (SWEEP, BLOCK, LARGE, UNUSUAL)" }, "tradeCount": { "type": "string", "description": "Number of individual trades in this activity" }, "openInterest": { "type": "string", "description": "Total open interest for this option contract" }, "volume": { "type": "string", "description": "Total volume traded for the day" }, "bid": { "type": "string", "description": "Current bid price" }, "ask": { "type": "string", "description": "Current ask price" }, "midpoint": { "type": "string", "description": "Midpoint between bid and ask prices" }, "executionEstimate": { "type": "string", "description": "Estimated execution location (AT_BID, AT_ASK, AT_MID)" } } } } } }, "examples": { "success": { "value": { "activities": [ { "id": "67745ec4c88d4e00015ce121", "date": "2024-12-31", "time": "16:14:43", "ticker": "SPY", "exchange": "ARCA", "description": "SPDR S&P 500 Option Alert: Jan 2 $591 Calls Sweep (5) near the Bid: 488 vs 2017 OI", "descriptionExtended": "SPDR S&P 500 Option Alert: Jan 2 $591 Calls Sweep (5) near the Bid: 488 @ $0.54 vs 2017 OI; Ref=$586.4", "updated": 1735679684, "sentiment": "BEARISH", "aggressorInd": "0.0", "optionSymbol": "SPY250102C00591000", "underlyingType": "ETF", "underlyingPrice": "586.4", "costBasis": "26352.000000000004", "putCall": "CALL", "strikePrice": "591.00", "price": "0.54", "size": "488", "dateExpiration": "2025-01-02", "optionActivityType": "SWEEP", "tradeCount": "5", "openInterest": "2017", "volume": "37933", "bid": "0.54", "ask": "0.55", "midpoint": "0.545", "executionEstimate": "AT_BID" } ] } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "tags": [ "Options" ], "security": [ { "OAuth2": [ "options:information" ] } ], "operationId": "get_v1_options_activity" } }, "/v1/economy/inflation-expectations": { "get": { "summary": "Get Latest Inflation Expectations", "description": "Retrieve historical inflation expectations data from financial markets and surveys to gauge future inflation trends with flexible date filtering.", "parameters": [ { "name": "date", "in": "query", "required": false, "schema": { "type": "string", "format": "date", "example": "2024-01-15" }, "description": "Exact date in YYYY-MM-DD format. Use this when you want one specific calendar day." }, { "name": "dates", "in": "query", "required": false, "schema": { "type": "string", "example": "2024-01-15,2024-01-16" }, "description": "Comma-separated list of dates in YYYY-MM-DD format. Use this when you want several specific dates in one request." }, { "name": "dateFrom", "in": "query", "required": false, "schema": { "type": "string", "format": "date", "example": "2024-01-01" }, "description": "Start-date filter. Returns records on or after this date." }, { "name": "dateTo", "in": "query", "required": false, "schema": { "type": "string", "format": "date", "example": "2024-01-31" }, "description": "End-date filter. Returns records on or before this date." }, { "name": "dateAfter", "in": "query", "required": false, "schema": { "type": "string", "format": "date", "example": "2024-01-01" }, "description": "After-date filter. Returns records after this date, excluding the date itself." }, { "name": "dateBefore", "in": "query", "required": false, "schema": { "type": "string", "format": "date", "example": "2024-01-31" }, "description": "Before-date filter. Returns records before this date, excluding the date itself." }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "example": 100 }, "description": "Maximum number of results to return. Use smaller values for UI pages and larger values for exports within API limits." }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "string" }, "description": "A comma-separated list of sort columns. For each column, append `.asc` or `.desc` to specify direction. Defaults to `date.asc` when not specified." }, { "name": "next", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Pagination cursor from the previous response. Omit it on the first request, then send the returned cursor to fetch the next page. for next page" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "results": { "type": "array", "items": { "type": "object", "properties": { "date": { "type": "string" }, "forwardYears5To10": { "type": "number" }, "market10Year": { "type": "number" }, "market5Year": { "type": "number" }, "model10Year": { "type": "number" }, "model1Year": { "type": "number" }, "model30Year": { "type": "number" }, "model5Year": { "type": "number" } } } }, "status": { "type": "string", "description": "Status string from the upstream data provider — typically `OK` for a successful response. Treat any other value as an error indicator alongside the HTTP status code." }, "requestId": { "type": "string" }, "nextUrl": { "type": "string", "description": "URL for next page of results" } } }, "examples": { "success": { "value": { "results": [ { "date": "2025-11-01", "forwardYears5To10": 2.18, "market10Year": 2.27, "market5Year": 2.35, "model10Year": 2.3071296, "model1Year": 2.703875, "model30Year": 2.431894, "model5Year": 2.3309433 } ], "status": "OK", "requestId": "c02d532304a9443ab43b2e4b691c8706", "nextUrl": "https://api.aries.com/v1/economy/inflation-expectations?cursor=..." } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "tags": [ "Economy" ], "security": [ { "OAuth2": [ "market:supplemental" ] } ], "operationId": "get_v1_economy_inflation_expectations" } }, "/v1/economy/treasury-yields": { "get": { "summary": "Get Latest Treasury Yields", "description": "Retrieve historical U.S. Treasury yields across different maturities including short-term bills and long-term bonds with flexible date filtering.", "parameters": [ { "name": "date", "in": "query", "required": false, "schema": { "type": "string", "format": "date", "example": "2024-01-15" }, "description": "Exact date in YYYY-MM-DD format. Use this when you want one specific calendar day." }, { "name": "dates", "in": "query", "required": false, "schema": { "type": "string", "example": "2024-01-15,2024-01-16" }, "description": "Comma-separated list of dates in YYYY-MM-DD format. Use this when you want several specific dates in one request." }, { "name": "dateFrom", "in": "query", "required": false, "schema": { "type": "string", "format": "date", "example": "2024-01-01" }, "description": "Start-date filter. Returns records on or after this date." }, { "name": "dateTo", "in": "query", "required": false, "schema": { "type": "string", "format": "date", "example": "2024-01-31" }, "description": "End-date filter. Returns records on or before this date." }, { "name": "dateAfter", "in": "query", "required": false, "schema": { "type": "string", "format": "date", "example": "2024-01-01" }, "description": "After-date filter. Returns records after this date, excluding the date itself." }, { "name": "dateBefore", "in": "query", "required": false, "schema": { "type": "string", "format": "date", "example": "2024-01-31" }, "description": "Before-date filter. Returns records before this date, excluding the date itself." }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "example": 100 }, "description": "Maximum number of results to return. Use smaller values for UI pages and larger values for exports within API limits." }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "string" }, "description": "A comma-separated list of sort columns. For each column, append `.asc` or `.desc` to specify direction. Massive documents this family with date-based sorting; use provider-supported column names in the text box." }, { "name": "next", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Pagination cursor from the previous response. Omit it on the first request, then send the returned cursor to fetch the next page. for next page" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "results": { "type": "array", "items": { "type": "object", "properties": { "date": { "type": "string", "description": "Reference date (YYYY-MM-DD)" }, "yield1Month": { "type": "number" }, "yield3Month": { "type": "number" }, "yield6Month": { "type": "number" }, "yield1Year": { "type": "number" }, "yield2Year": { "type": "number" }, "yield3Year": { "type": "number" }, "yield5Year": { "type": "number" }, "yield7Year": { "type": "number" }, "yield10Year": { "type": "number" }, "yield20Year": { "type": "number" }, "yield30Year": { "type": "number" } } } }, "status": { "type": "string", "description": "Status string from the upstream data provider — typically `OK` for a successful response. Treat any other value as an error indicator alongside the HTTP status code." }, "requestId": { "type": "string" }, "nextUrl": { "type": "string", "description": "URL for next page of results" } } }, "examples": { "success": { "value": { "results": [ { "date": "2025-12-22", "yield1Month": 3.72, "yield3Month": 3.64, "yield1Year": 3.53, "yield2Year": 3.44, "yield5Year": 3.71, "yield10Year": 4.17, "yield30Year": 4.84 } ], "status": "OK", "requestId": "0cacd52605954a20afa995624faa46b9", "nextUrl": "https://api.aries.com/v1/economy/treasury-yields?cursor=..." } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "tags": [ "Economy" ], "security": [ { "OAuth2": [ "market:supplemental" ] } ], "operationId": "get_v1_economy_treasury_yields" } }, "/v1/financials/short-volume": { "get": { "summary": "Get Short Volume Data", "description": "Retrieve daily short volume data showing the number of shares sold short and overall short selling activity. `ticker` accepts a single symbol only. Use `tickersAnyOf` for multiple symbols. If `ticker` contains multiple comma-separated values, the API returns 400: \"Multiple tickers are not supported. Please provide a single ticker.\" If both `ticker` and `tickersAnyOf` are set, the API returns 400: \"Cannot specify both ticker and tickersAnyOf. Use ticker for a single symbol or tickersAnyOf for multiple.\"", "parameters": [ { "name": "ticker", "in": "query", "required": false, "schema": { "type": "string", "example": "AAPL" }, "description": "Single ticker symbol filter. Enter one ticker such as AAPL to narrow results to one company." }, { "name": "tickersAnyOf", "in": "query", "required": false, "schema": { "type": "string", "example": "AAPL,MSFT,GOOG" }, "description": "Comma-separated list of ticker symbols." }, { "name": "tickerAfter", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Ticker pagination lower bound. Returns symbols alphabetically after this ticker, excluding the ticker itself." }, { "name": "tickerFrom", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Ticker greater than or equal (inclusive)" }, { "name": "tickerBefore", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Ticker pagination upper bound. Returns symbols alphabetically before this ticker, excluding the ticker itself." }, { "name": "tickerTo", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Ticker less than or equal (inclusive)" }, { "name": "date", "in": "query", "required": false, "schema": { "type": "string", "format": "date" }, "description": "Exact date in YYYY-MM-DD format. Use this when you want one specific calendar day." }, { "name": "dates", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Comma-separated list of dates in YYYY-MM-DD format. Use this when you want several specific dates in one request." }, { "name": "dateAfter", "in": "query", "required": false, "schema": { "type": "string", "format": "date" }, "description": "After-date filter. Returns records after this date, excluding the date itself." }, { "name": "dateFrom", "in": "query", "required": false, "schema": { "type": "string", "format": "date" }, "description": "Start-date filter. Returns records on or after this date." }, { "name": "dateBefore", "in": "query", "required": false, "schema": { "type": "string", "format": "date" }, "description": "Before-date filter. Returns records before this date, excluding the date itself." }, { "name": "dateTo", "in": "query", "required": false, "schema": { "type": "string", "format": "date" }, "description": "End-date filter. Returns records on or before this date." }, { "name": "shortVolumeRatio", "in": "query", "required": false, "schema": { "type": "number", "format": "double" }, "description": "Exact short-volume ratio filter. Use it when you need records matching one specific ratio value." }, { "name": "shortVolumeRatioList", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Comma-separated list of short volume ratios" }, { "name": "shortVolumeRatioAbove", "in": "query", "required": false, "schema": { "type": "number", "format": "double" }, "description": "Short volume ratio greater than (exclusive)" }, { "name": "shortVolumeRatioMin", "in": "query", "required": false, "schema": { "type": "number", "format": "double" }, "description": "Short volume ratio greater than or equal (inclusive)" }, { "name": "shortVolumeRatioBelow", "in": "query", "required": false, "schema": { "type": "number", "format": "double" }, "description": "Short volume ratio less than (exclusive)" }, { "name": "shortVolumeRatioMax", "in": "query", "required": false, "schema": { "type": "number", "format": "double" }, "description": "Short volume ratio less than or equal (inclusive)" }, { "name": "totalVolume", "in": "query", "required": false, "schema": { "type": "integer", "format": "int64" }, "description": "Exact total-volume filter. Use it when you need records matching one specific volume value." }, { "name": "totalVolumeList", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Comma-separated list of total volumes" }, { "name": "totalVolumeAbove", "in": "query", "required": false, "schema": { "type": "integer", "format": "int64" }, "description": "Total volume greater than (exclusive)" }, { "name": "totalVolumeMin", "in": "query", "required": false, "schema": { "type": "integer", "format": "int64" }, "description": "Total volume greater than or equal (inclusive)" }, { "name": "totalVolumeBelow", "in": "query", "required": false, "schema": { "type": "integer", "format": "int64" }, "description": "Total-volume upper-bound filter. Returns records below this value, excluding the value itself." }, { "name": "totalVolumeMax", "in": "query", "required": false, "schema": { "type": "integer", "format": "int64" }, "description": "Total volume less than or equal (inclusive)" }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1 }, "description": "Maximum number of results to return. Use smaller values for UI pages and larger values for exports within API limits." }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "string" }, "description": "A comma-separated list of sort columns. For each column, append `.asc` or `.desc` to specify direction. Defaults to `ticker.asc` when not specified." }, { "name": "next", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Pagination cursor from the previous response. Omit it on the first request, then send the returned cursor to fetch the next page." } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "results": { "type": "array", "items": { "type": "object", "properties": { "ticker": { "type": "string" }, "date": { "type": "string" }, "shortVolume": { "type": "integer" }, "shortVolumeRatio": { "type": "number" }, "totalVolume": { "type": "integer" }, "exemptVolume": { "type": "integer" }, "nonExemptVolume": { "type": "integer" }, "adfShortVolume": { "type": "integer" }, "adfShortVolumeExempt": { "type": "integer" }, "nasdaqCarteretShortVolume": { "type": "integer" }, "nasdaqCarteretShortVolumeExempt": { "type": "integer" }, "nasdaqChicagoShortVolume": { "type": "integer" }, "nasdaqChicagoShortVolumeExempt": { "type": "integer" }, "nyseShortVolume": { "type": "integer" }, "nyseShortVolumeExempt": { "type": "integer" } } } }, "status": { "type": "string", "description": "Status string from the upstream data provider — typically `OK` for a successful response. Treat any other value as an error indicator alongside the HTTP status code." }, "requestId": { "type": "string" }, "nextUrl": { "type": "string" } } }, "examples": { "success": { "value": { "results": [ { "ticker": "AAPL", "date": "2024-02-06", "shortVolume": 5683713, "shortVolumeRatio": 34.95, "totalVolume": 16264662, "exemptVolume": 67840, "nonExemptVolume": 5615873, "adfShortVolume": 0, "adfShortVolumeExempt": 0, "nasdaqCarteretShortVolume": 5298900, "nasdaqCarteretShortVolumeExempt": 63532, "nasdaqChicagoShortVolume": 28784, "nasdaqChicagoShortVolumeExempt": 0, "nyseShortVolume": 356029, "nyseShortVolumeExempt": 4308 } ], "status": "OK", "requestId": "c701bead81e94e7186f6042474b117d8", "nextUrl": "https://api.aries.com/v1/financials/short-volume?cursor=..." } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "tags": [ "Financials" ], "security": [ { "OAuth2": [ "market:supplemental" ] } ], "operationId": "get_v1_financials_short_volume" } }, "/v1/financials/ratios": { "get": { "summary": "Get Financial Ratios", "description": "Retrieve comprehensive financial ratios including liquidity, profitability, leverage, and efficiency metrics for fundamental analysis. `ticker` accepts a single symbol only. Use `tickersAnyOf` for multiple symbols. If `ticker` contains multiple comma-separated values, the API returns 400: \"Multiple tickers are not supported. Please provide a single ticker.\" If both `ticker` and `tickersAnyOf` are set, the API returns 400: \"Cannot specify both ticker and tickersAnyOf. Use ticker for a single symbol or tickersAnyOf for multiple.\"", "parameters": [ { "name": "ticker", "in": "query", "required": false, "schema": { "type": "string", "example": "AAPL" }, "description": "Single ticker symbol filter. Enter one ticker such as AAPL to narrow results to one company." }, { "name": "tickersAnyOf", "in": "query", "required": false, "schema": { "type": "string", "example": "AAPL,MSFT,GOOG" }, "description": "Comma-separated list of ticker symbols." }, { "name": "tickerAfter", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Ticker pagination lower bound. Returns symbols alphabetically after this ticker, excluding the ticker itself." }, { "name": "tickerFrom", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Ticker greater than or equal (inclusive)" }, { "name": "tickerBefore", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Ticker pagination upper bound. Returns symbols alphabetically before this ticker, excluding the ticker itself." }, { "name": "tickerTo", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Ticker less than or equal (inclusive)" }, { "name": "cik", "in": "query", "required": false, "schema": { "type": "string" }, "description": "CIK company identifier from the SEC. Use this when filtering by SEC registrant instead of ticker." }, { "name": "ciks", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Comma-separated SEC CIK identifiers. Use this to filter several registrants in one request." }, { "name": "cikAfter", "in": "query", "required": false, "schema": { "type": "string" }, "description": "CIK pagination lower bound. Returns records with CIK values greater than this value, excluding the value itself." }, { "name": "cikFrom", "in": "query", "required": false, "schema": { "type": "string" }, "description": "CIK greater than or equal (inclusive)" }, { "name": "cikBefore", "in": "query", "required": false, "schema": { "type": "string" }, "description": "CIK pagination upper bound. Returns records with CIK values less than this value, excluding the value itself." }, { "name": "cikTo", "in": "query", "required": false, "schema": { "type": "string" }, "description": "CIK upper-bound filter. Returns records with CIK values less than or equal to this value." }, { "name": "price", "in": "query", "required": false, "schema": { "type": "number", "format": "double" }, "description": "Exact price filter. Use it when you need records matching one specific price value." }, { "name": "priceAbove", "in": "query", "required": false, "schema": { "type": "number", "format": "double" }, "description": "Price lower-bound filter. Returns records above this value, excluding the value itself." }, { "name": "priceMin", "in": "query", "required": false, "schema": { "type": "number", "format": "double" }, "description": "Price greater than or equal (inclusive)" }, { "name": "priceBelow", "in": "query", "required": false, "schema": { "type": "number", "format": "double" }, "description": "Price upper-bound filter. Returns records below this value, excluding the value itself." }, { "name": "priceMax", "in": "query", "required": false, "schema": { "type": "number", "format": "double" }, "description": "Price less than or equal (inclusive)" }, { "name": "averageVolume", "in": "query", "required": false, "schema": { "type": "number", "format": "double" }, "description": "Exact average-volume filter. Use it when screening for one specific average volume value." }, { "name": "averageVolumeAbove", "in": "query", "required": false, "schema": { "type": "number", "format": "double" }, "description": "Average volume greater than (exclusive)" }, { "name": "averageVolumeMin", "in": "query", "required": false, "schema": { "type": "number", "format": "double" }, "description": "Average volume greater than or equal (inclusive)" }, { "name": "averageVolumeBelow", "in": "query", "required": false, "schema": { "type": "number", "format": "double" }, "description": "Average volume less than (exclusive)" }, { "name": "averageVolumeMax", "in": "query", "required": false, "schema": { "type": "number", "format": "double" }, "description": "Average volume less than or equal (inclusive)" }, { "name": "marketCap", "in": "query", "required": false, "schema": { "type": "number", "format": "double" }, "description": "Exact market-cap filter. Use it when screening for one specific company size value." }, { "name": "marketCapAbove", "in": "query", "required": false, "schema": { "type": "number", "format": "double" }, "description": "Market cap greater than (exclusive)" }, { "name": "marketCapMin", "in": "query", "required": false, "schema": { "type": "number", "format": "double" }, "description": "Market cap greater than or equal (inclusive)" }, { "name": "marketCapBelow", "in": "query", "required": false, "schema": { "type": "number", "format": "double" }, "description": "Market-cap upper-bound filter. Returns companies below this value, excluding the value itself." }, { "name": "marketCapMax", "in": "query", "required": false, "schema": { "type": "number", "format": "double" }, "description": "Market cap less than or equal (inclusive)" }, { "name": "eps", "in": "query", "required": false, "schema": { "type": "number", "format": "double" }, "description": "Exact earnings-per-share filter. Use it when screening for one EPS value." }, { "name": "epsAbove", "in": "query", "required": false, "schema": { "type": "number", "format": "double" }, "description": "EPS lower-bound filter. Returns companies with EPS above this value, excluding the value itself." }, { "name": "epsMin", "in": "query", "required": false, "schema": { "type": "number", "format": "double" }, "description": "EPS greater than or equal (inclusive)" }, { "name": "epsBelow", "in": "query", "required": false, "schema": { "type": "number", "format": "double" }, "description": "EPS upper-bound filter. Returns companies with EPS below this value, excluding the value itself." }, { "name": "epsMax", "in": "query", "required": false, "schema": { "type": "number", "format": "double" }, "description": "EPS upper-bound filter. Returns companies with EPS less than or equal to this value." }, { "name": "peRatio", "in": "query", "required": false, "schema": { "type": "number", "format": "double" }, "description": "Exact price-to-earnings ratio filter. Use it when screening for one valuation value." }, { "name": "peRatioAbove", "in": "query", "required": false, "schema": { "type": "number", "format": "double" }, "description": "P/E ratio lower-bound filter. Returns companies above this valuation, excluding the value itself." }, { "name": "peRatioMin", "in": "query", "required": false, "schema": { "type": "number", "format": "double" }, "description": "P/E ratio greater than or equal (inclusive)" }, { "name": "peRatioBelow", "in": "query", "required": false, "schema": { "type": "number", "format": "double" }, "description": "P/E ratio upper-bound filter. Returns companies below this valuation, excluding the value itself." }, { "name": "peRatioMax", "in": "query", "required": false, "schema": { "type": "number", "format": "double" }, "description": "P/E ratio less than or equal (inclusive)" }, { "name": "pbRatio", "in": "query", "required": false, "schema": { "type": "number", "format": "double" }, "description": "Exact price-to-book ratio filter. Use it when screening for one valuation value." }, { "name": "pbRatioAbove", "in": "query", "required": false, "schema": { "type": "number", "format": "double" }, "description": "P/B ratio lower-bound filter. Returns companies above this valuation, excluding the value itself." }, { "name": "pbRatioMin", "in": "query", "required": false, "schema": { "type": "number", "format": "double" }, "description": "P/B ratio greater than or equal (inclusive)" }, { "name": "pbRatioBelow", "in": "query", "required": false, "schema": { "type": "number", "format": "double" }, "description": "P/B ratio upper-bound filter. Returns companies below this valuation, excluding the value itself." }, { "name": "pbRatioMax", "in": "query", "required": false, "schema": { "type": "number", "format": "double" }, "description": "P/B ratio less than or equal (inclusive)" }, { "name": "psRatio", "in": "query", "required": false, "schema": { "type": "number", "format": "double" }, "description": "Exact price-to-sales ratio filter. Use it when screening for one valuation value." }, { "name": "psRatioAbove", "in": "query", "required": false, "schema": { "type": "number", "format": "double" }, "description": "P/S ratio lower-bound filter. Returns companies above this valuation, excluding the value itself." }, { "name": "psRatioMin", "in": "query", "required": false, "schema": { "type": "number", "format": "double" }, "description": "P/S ratio greater than or equal (inclusive)" }, { "name": "psRatioBelow", "in": "query", "required": false, "schema": { "type": "number", "format": "double" }, "description": "P/S ratio upper-bound filter. Returns companies below this valuation, excluding the value itself." }, { "name": "psRatioMax", "in": "query", "required": false, "schema": { "type": "number", "format": "double" }, "description": "P/S ratio less than or equal (inclusive)" }, { "name": "pcfRatio", "in": "query", "required": false, "schema": { "type": "number", "format": "double" }, "description": "Exact price-to-cash-flow ratio filter. Use it when screening for one valuation value." }, { "name": "pcfRatioAbove", "in": "query", "required": false, "schema": { "type": "number", "format": "double" }, "description": "P/CF ratio greater than (exclusive)" }, { "name": "pcfRatioMin", "in": "query", "required": false, "schema": { "type": "number", "format": "double" }, "description": "P/CF ratio greater than or equal (inclusive)" }, { "name": "pcfRatioBelow", "in": "query", "required": false, "schema": { "type": "number", "format": "double" }, "description": "P/CF ratio upper-bound filter. Returns companies below this valuation, excluding the value itself." }, { "name": "pcfRatioMax", "in": "query", "required": false, "schema": { "type": "number", "format": "double" }, "description": "P/CF ratio less than or equal (inclusive)" }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1 }, "description": "Maximum number of results to return. Use smaller values for UI pages and larger values for exports within API limits." }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "string" }, "description": "A comma-separated list of sort columns. For each column, append `.asc` or `.desc` to specify direction. Defaults to `ticker.asc` when not specified." }, { "name": "next", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Pagination cursor from the previous response. Omit it on the first request, then send the returned cursor to fetch the next page." } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "results": { "type": "array", "items": { "type": "object", "properties": { "ticker": { "type": "string" }, "cik": { "type": "string" }, "date": { "type": "string" }, "price": { "type": "number" }, "averageVolume": { "type": "integer" }, "marketCap": { "type": "integer" }, "earningsPerShare": { "type": "number" }, "priceToEarnings": { "type": "number" }, "priceToBook": { "type": "number" }, "priceToSales": { "type": "number" }, "priceToCashFlow": { "type": "number" }, "priceToFreeCashFlow": { "type": "number" }, "dividendYield": { "type": "number" }, "returnOnAssets": { "type": "number" }, "returnOnEquity": { "type": "number" }, "debtToEquity": { "type": "number" }, "current": { "type": "number" }, "quick": { "type": "number" }, "cash": { "type": "number" }, "evToSales": { "type": "number" }, "evToEbitda": { "type": "number" }, "enterpriseValue": { "type": "integer" }, "freeCashFlow": { "type": "integer" } } } }, "status": { "type": "string", "description": "Status string from the upstream data provider — typically `OK` for a successful response. Treat any other value as an error indicator alongside the HTTP status code." }, "requestId": { "type": "string" } } }, "examples": { "success": { "value": { "results": [ { "ticker": "AAPL", "cik": "0000320193", "date": "2025-12-24", "price": 273.81, "averageVolume": 45872477, "marketCap": 4045913214930, "earningsPerShare": 7.58, "priceToEarnings": 36.12, "priceToBook": 54.87, "priceToSales": 9.72, "priceToCashFlow": 36.29, "priceToFreeCashFlow": 40.96, "dividendYield": 0.0038, "returnOnAssets": 0.3118, "returnOnEquity": 1.5191, "debtToEquity": 1.34, "current": 0.89, "quick": 0.86, "cash": 0.22, "evToSales": 9.87, "evToEbitda": 28.38, "enterpriseValue": 4108636214930, "freeCashFlow": 98767000000 } ], "status": "OK", "requestId": "1fd04d305f74456cb3b304b705572a2c" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "tags": [ "Financials" ], "security": [ { "OAuth2": [ "market:supplemental" ] } ], "operationId": "get_v1_financials_ratios" } }, "/v1/financials/short-interest": { "get": { "summary": "Get Short Interest Data", "description": "Retrieve short interest statistics including short volume, short ratio, and days to cover for assessing bearish sentiment. `ticker` accepts a single symbol only. Use `tickersAnyOf` for multiple symbols. If `ticker` contains multiple comma-separated values, the API returns 400: \"Multiple tickers are not supported. Please provide a single ticker.\" If both `ticker` and `tickersAnyOf` are set, the API returns 400: \"Cannot specify both ticker and tickersAnyOf. Use ticker for a single symbol or tickersAnyOf for multiple.\"", "parameters": [ { "name": "ticker", "in": "query", "required": false, "schema": { "type": "string", "example": "AAPL" }, "description": "Single ticker symbol filter. Enter one ticker such as AAPL to narrow results to one company." }, { "name": "tickersAnyOf", "in": "query", "required": false, "schema": { "type": "string", "example": "AAPL,MSFT,GOOG" }, "description": "Comma-separated list of ticker symbols." }, { "name": "tickerAfter", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Ticker pagination lower bound. Returns symbols alphabetically after this ticker, excluding the ticker itself." }, { "name": "tickerFrom", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Ticker greater than or equal (inclusive)" }, { "name": "tickerBefore", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Ticker pagination upper bound. Returns symbols alphabetically before this ticker, excluding the ticker itself." }, { "name": "tickerTo", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Ticker less than or equal (inclusive)" }, { "name": "daysToCover", "in": "query", "required": false, "schema": { "type": "number", "format": "double" }, "description": "Exact days-to-cover filter for short interest. Use it when screening for one short-squeeze risk value." }, { "name": "daysToCoverList", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Comma-separated list of days to cover" }, { "name": "daysToCoverAbove", "in": "query", "required": false, "schema": { "type": "number", "format": "double" }, "description": "Days to cover greater than (exclusive)" }, { "name": "daysToCoverMin", "in": "query", "required": false, "schema": { "type": "number", "format": "double" }, "description": "Days to cover greater than or equal (inclusive)" }, { "name": "daysToCoverBelow", "in": "query", "required": false, "schema": { "type": "number", "format": "double" }, "description": "Days to cover less than (exclusive)" }, { "name": "daysToCoverMax", "in": "query", "required": false, "schema": { "type": "number", "format": "double" }, "description": "Days to cover less than or equal (inclusive)" }, { "name": "settlementDate", "in": "query", "required": false, "schema": { "type": "string", "format": "date" }, "description": "Settlement date in YYYY-MM-DD format. Use it to filter short-interest records by reporting settlement date." }, { "name": "settlementDates", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Comma-separated list of settlement dates" }, { "name": "settlementDateAfter", "in": "query", "required": false, "schema": { "type": "string", "format": "date" }, "description": "Settlement-date lower-bound filter. Returns records after this date, excluding the date itself." }, { "name": "settlementDateFrom", "in": "query", "required": false, "schema": { "type": "string", "format": "date" }, "description": "Settlement-date start filter. Returns records on or after this date." }, { "name": "settlementDateBefore", "in": "query", "required": false, "schema": { "type": "string", "format": "date" }, "description": "Settlement-date upper-bound filter. Returns records before this date, excluding the date itself." }, { "name": "settlementDateTo", "in": "query", "required": false, "schema": { "type": "string", "format": "date" }, "description": "Settlement-date end filter. Returns records on or before this date." }, { "name": "avgDailyVolume", "in": "query", "required": false, "schema": { "type": "integer", "format": "int64" }, "description": "Exact average-daily-volume filter. Use it when screening for one specific liquidity value." }, { "name": "avgDailyVolumeList", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Comma-separated list of average daily volumes" }, { "name": "avgDailyVolumeAbove", "in": "query", "required": false, "schema": { "type": "integer", "format": "int64" }, "description": "Average daily volume greater than (exclusive)" }, { "name": "avgDailyVolumeMin", "in": "query", "required": false, "schema": { "type": "integer", "format": "int64" }, "description": "Average daily volume greater than or equal (inclusive)" }, { "name": "avgDailyVolumeBelow", "in": "query", "required": false, "schema": { "type": "integer", "format": "int64" }, "description": "Average daily volume less than (exclusive)" }, { "name": "avgDailyVolumeMax", "in": "query", "required": false, "schema": { "type": "integer", "format": "int64" }, "description": "Average daily volume less than or equal (inclusive)" }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1 }, "description": "Maximum number of results to return. Use smaller values for UI pages and larger values for exports within API limits." }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "string" }, "description": "A comma-separated list of sort columns. For each column, append `.asc` or `.desc` to specify direction. Defaults to `ticker.asc` when not specified." }, { "name": "next", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Pagination cursor from the previous response. Omit it on the first request, then send the returned cursor to fetch the next page." } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "results": { "type": "array", "items": { "type": "object", "properties": { "ticker": { "type": "string" }, "settlementDate": { "type": "string" }, "shortInterest": { "type": "integer" }, "avgDailyVolume": { "type": "integer" }, "daysToCover": { "type": "number" } } } }, "status": { "type": "string", "description": "Status string from the upstream data provider — typically `OK` for a successful response. Treat any other value as an error indicator alongside the HTTP status code." }, "requestId": { "type": "string" }, "nextUrl": { "type": "string", "description": "URL for next page of results" } } }, "examples": { "success": { "value": { "results": [ { "ticker": "AAPL", "settlementDate": "2017-12-29", "shortInterest": 45746430, "avgDailyVolume": 23901107, "daysToCover": 1.91 } ], "status": "OK", "requestId": "7a867902c54d496b8239089f103b0fa8", "nextUrl": "https://api.aries.com/v1/financials/short-interest?cursor=..." } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "tags": [ "Financials" ], "security": [ { "OAuth2": [ "market:supplemental" ] } ], "operationId": "get_v1_financials_short_interest" } }, "/v1/signals/bull-bear": { "get": { "operationId": "getBullBearAnalysis", "summary": "Get Bull & Bear Analysis", "description": "Retrieve bullish and bearish investment cases including fundamental arguments, technical signals, and analyst opinions for balanced perspective.", "parameters": [ { "name": "symbols", "in": "query", "required": true, "schema": { "type": "string", "example": "AAPL,MSFT" }, "description": "Comma-separated list of ticker symbols" }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 0 }, "description": "Page number for pagination (0-based)" }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 200, "default": 100 }, "description": "Number of results per page. Use this to control pagination size in list views. (1-200)" } ], "responses": { "200": { "description": "Bull and bear cases.", "content": { "application/json": { "schema": { "type": "object", "properties": { "bullBearCases": { "type": "array", "description": "Array of bull and bear investment cases for securities", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the bull/bear case analysis" }, "ticker": { "type": "string", "description": "Stock ticker symbol, such as AAPL. Use the exact ticker for the company you want to research." }, "bullCase": { "type": "string", "description": "Bullish investment thesis describing positive factors and growth opportunities" }, "bearCase": { "type": "string", "description": "Bearish investment thesis describing risks and potential challenges" }, "securities": { "type": "array", "description": "Array of securities associated with this ticker", "items": { "type": "object", "properties": { "cik": { "type": "string", "description": "SEC Central Index Key" }, "exchange": { "type": "string", "description": "Exchange code where the data originates. Format depends on the upstream data source and may use MIC, ISO 10383, or a vendor-specific code." }, "isin": { "type": "string", "description": "International Securities Identification Number" }, "name": { "type": "string", "description": "Company name" }, "symbol": { "type": "string", "description": "Stock ticker symbol, such as AAPL. Use the exact ticker for the company you want to research." } } } }, "updated": { "type": "integer", "description": "Unix timestamp when the analysis was last updated" } } } } } }, "examples": { "success": { "value": { "bullBearCases": [ { "id": "69489ba01f09b06edf352b9a", "ticker": "AAPL", "bullCase": "Apple's financial performance shows robust growth, with F4Q25 sales increasing by 8% to $102.5 billion, closely aligning with estimates and reflecting strong iPhone sales anticipated to grow by double digits year-over-year in F1Q26. The services segment also displayed impressive performance, growing 15% year-over-year, which positively influences overall gross margin as the company shifts its focus toward a higher-margin services mix. Additionally, projections for sales growth of 10% to 12% for the upcoming quarter are bolstered by a strong demand for iPhone 17, particularly in the recovering Chinese market, alongside substantial investments in AI and product development indicated by a 19% increase in operating expenses.", "bearCase": "Apple's sales in China experienced a decline of 3.6% year-over-year, signaling potential challenges in one of its key markets. The company's consolidated gross margin guidance for the first fiscal quarter of 2026 remains flat year-over-year at the high end of 47%, which, coupled with higher operating expenses, may strain profitability. Concerns over iPhone sales performance and the possibility of a slowdown in growth further contribute to a negative outlook on the company's stock valuation.", "securities": [ { "cik": "0000320193", "exchange": "NASDAQ Global Select Consolidated", "isin": "US0378331005", "name": "APPLE INC", "symbol": "AAPL" } ], "updated": 1766366112 } ] } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "tags": [ "Signals" ], "security": [ { "OAuth2": [ "market:supplemental" ] } ] } }, "/v1/options/previous-day": { "get": { "summary": "Get Previous Day Option Data", "description": "Retrieve the previous trading day's OHLC bar (open, high, low, close), volume, volume-weighted average price (VWAP), bar timestamp, and trade count for a single option contract. Useful for change-vs-yesterday comparisons, daily charts, and volatility/volume baselines.", "parameters": [ { "name": "ticker", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Option contract identifier in OCC/OSI format. The 21-character form is `ROOT + YYMMDD + C/P + strike-in-cents` (e.g. `AAPL251219C00150000` = AAPL Dec-19-2025 $150 Call). The optional `O:` prefix is accepted and stripped (so `O:AAPL251219C00150000` works too)." } ], "responses": { "200": { "description": "Previous-day bar for the requested option contract.", "content": { "application/json": { "schema": { "type": "object", "required": [ "ticker", "open", "high", "low", "close", "volume" ], "properties": { "ticker": { "type": "string", "description": "Canonical OCC/OSI option symbol the data is for (always returned in uppercase, without the `O:` prefix even if you sent one)." }, "open": { "type": "number", "description": "Opening trade price of the contract during the previous regular trading session, in U.S. dollars per contract." }, "high": { "type": "number", "description": "Highest trade price reached during the previous regular trading session, in U.S. dollars per contract." }, "low": { "type": "number", "description": "Lowest trade price reached during the previous regular trading session, in U.S. dollars per contract." }, "close": { "type": "number", "description": "Closing trade price of the contract at the end of the previous regular trading session, in U.S. dollars per contract." }, "volume": { "type": "number", "description": "Total number of contracts that traded during the previous regular trading session. Higher volume usually means tighter bid/ask spreads and easier fills." }, "volumeWeighted": { "type": "number", "description": "Volume-Weighted Average Price (VWAP) for the previous session — the average trade price weighted by contract size. Useful as a 'fair' reference price for the day. Omitted if the upstream source did not provide it." }, "timestamp": { "type": "integer", "format": "int64", "description": "When the bar applies to, as a Unix timestamp in **milliseconds** (UTC). Omitted if the upstream source did not provide it." }, "transactionCount": { "type": "integer", "format": "int64", "description": "Number of individual trade prints that made up the previous session's bar. (Each transaction can be many contracts — see `volume` for total contract count.) Omitted if the upstream source did not provide it." } } }, "examples": { "success": { "summary": "Typical response (all fields populated)", "value": { "ticker": "AAPL251219C00150000", "open": 13.5, "high": 15.25, "low": 13.2, "close": 13.75, "volume": 25430, "volumeWeighted": 14.18, "timestamp": 1734652800000, "transactionCount": 1842 } }, "minimal": { "summary": "Minimal response (optional fields omitted by upstream)", "value": { "ticker": "AAPL251219C00150000", "open": 13.5, "high": 15.25, "low": 13.2, "close": 13.75, "volume": 25430 } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "tags": [ "Options" ], "security": [ { "OAuth2": [ "options:information" ] } ], "operationId": "get_v1_options_previous_day" } }, "/v1/options/open-close": { "get": { "summary": "Get Option Open/Close Data", "description": "Retrieve option contract opening and closing prices with intraday trading ranges for specific option contracts.", "parameters": [ { "name": "ticker", "in": "query", "required": true, "schema": { "type": "string" }, "description": "OCC option ticker symbol (e.g., O:AAPL251219C00150000)" }, { "name": "date", "in": "query", "required": true, "schema": { "type": "string", "format": "date" }, "description": "Date in YYYY-MM-DD format. Enter the specific calendar date you want to query." } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ticker": { "type": "string", "description": "OCC option ticker symbol" }, "date": { "type": "string", "description": "Trade date in YYYY-MM-DD format" }, "open": { "type": "number", "description": "Opening price for the trading session" }, "high": { "type": "number", "description": "Highest price reached during the trading session" }, "low": { "type": "number", "description": "Lowest price reached during the trading session" }, "close": { "type": "number", "description": "Closing price for the trading session" }, "volume": { "type": "number", "description": "Total number of contracts traded during the session" }, "afterHours": { "type": "number", "description": "Last traded price in after-hours session" }, "preMarket": { "type": "number", "description": "Last traded price in pre-market session" } } }, "examples": { "success": { "value": { "ticker": "O:AAPL251219C00150000", "date": "2024-12-16", "open": 107.34, "high": 107.34, "low": 107.34, "close": 107.34, "volume": 2, "afterHours": 107.34, "preMarket": 107.34 } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "tags": [ "Options" ], "security": [ { "OAuth2": [ "options:information" ] } ], "operationId": "get_v1_options_open_close" } }, "/v1/corporate-actions/tender-offers": { "get": { "summary": "Get Tender Offers", "description": "Retrieve information about tender offers including offer prices, expiration dates, and terms for acquiring company shares.", "parameters": [ { "name": "identifier", "in": "query", "required": true, "schema": { "type": "string", "example": "AAPL" }, "description": "Identifier value for the company you're querying. The format depends on `identifierType`:\n- `Symbol` — exchange ticker (e.g. `AAPL`).\n- `CUSIP` — 9-character U.S./Canadian identifier (e.g. `037833100`).\n- `ISIN` — 12-character international identifier (e.g. `US0378331005`).\n- `SEDOL` — 7-character UK identifier.\n- `Valoren` — Swiss security identifier.\n- `FIGI` — Bloomberg Financial Instrument Global Identifier.\n- `CompositeFIGI` — country-level composite FIGI.\n\nMust match the kind selected in `identifierType`." }, { "name": "identifierType", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/TenderOfferIdentifierType" }, "description": "Tells the API how to interpret `identifier`. See `TenderOfferIdentifierType` for the full set of supported values and what each one means." }, { "name": "startDate", "in": "query", "required": true, "schema": { "type": "string", "format": "date", "example": "2024-01-01" }, "description": "Start of the tender-offer announcement window, inclusive. Format: `YYYY-MM-DD` (e.g. `2024-01-01`)." }, { "name": "endDate", "in": "query", "required": true, "schema": { "type": "string", "format": "date", "example": "2024-12-31" }, "description": "End of the tender-offer announcement window, inclusive. Format: `YYYY-MM-DD` (e.g. `2024-12-31`)." } ], "responses": { "200": { "description": "Tender offers data.", "content": { "application/json": { "schema": { "type": "object", "properties": { "tenderOffers": { "type": "array", "items": { "type": "object", "properties": { "expirationDate": { "type": "string" }, "identifier": { "type": "string" }, "offerId": { "type": "string" }, "offerPrice": { "type": "number" }, "status": { "type": "string", "description": "Status string from the upstream data provider — typically `OK` for a successful response. Treat any other value as an error indicator alongside the HTTP status code." }, "termsSummary": { "type": "string" } }, "description": "Tender offer record" } } } }, "example": { "tenderOffers": [ { "offerId": "to-1001", "identifier": "AAPL", "offerPrice": 185.5, "expirationDate": "2026-03-01", "status": "open", "termsSummary": "Demo tender offer terms." } ] } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "tags": [ "Corporate Actions" ], "security": [ { "OAuth2": [ "market:supplemental" ] } ], "operationId": "get_v1_corporate_actions_tender_offers" } }, "/v1/market/status": { "get": { "summary": "Get Market Status", "description": "Retrieve current market status indicating whether exchanges are open, closed, or in pre-market/after-hours trading sessions.", "parameters": [ { "name": "exchange", "in": "query", "required": true, "description": "exchange code (case-insensitive). Select from the Try it dropdown or use any value from the supported exchange list in the API reference page.", "schema": { "$ref": "#/components/schemas/ExchangeCode" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MarketStatus" }, "examples": { "default": { "value": { "exchange": "US", "timezone": "America/New_York", "isOpen": false, "session": "", "timestamp": 1765526940 } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimitExceeded" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "security": [ { "OAuth2": [ "market:supplemental" ] } ], "tags": [ "Market" ], "operationId": "get_v1_market_status" } }, "/v1/market/holiday": { "get": { "summary": "Get Market Holidays", "description": "Retrieve market holiday schedules showing dates when exchanges are closed for official holidays and early close days.", "parameters": [ { "name": "exchange", "in": "query", "required": true, "description": "exchange code (case-insensitive). Select from the Try it dropdown or use any value from the supported exchange list in the API reference page.", "schema": { "$ref": "#/components/schemas/ExchangeCode" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MarketHolidayResponse" }, "examples": { "default": { "value": { "holidays": [ { "eventName": "Christmas Day", "atDate": "2026-12-25", "tradingHour": "" }, { "eventName": "Christmas Day", "atDate": "2026-12-24", "tradingHour": "09:30-13:00" } ] } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimitExceeded" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "security": [ { "OAuth2": [ "market:supplemental" ] } ], "tags": [ "Market" ], "operationId": "get_v1_market_holiday" } }, "/v1/company/profile": { "get": { "summary": "Get Company Profile", "description": "Retrieve comprehensive company information including business description, industry classification, headquarters location, and key identifiers. At least one of symbol, ISIN, or CUSIP must be provided. If all three are omitted, the API returns 400 Bad Request. Response includes masked logo URL for privacy.", "parameters": [ { "name": "symbol", "in": "query", "description": "Stock ticker symbol, such as AAPL. Optional if ISIN or CUSIP is provided. If symbol, isin, and cusip are all omitted, the API returns 400 Bad Request.", "required": false, "schema": { "type": "string", "example": "AAPL" } }, { "name": "isin", "in": "query", "description": "International Securities Identification Number. Optional if symbol or CUSIP is provided. If symbol, isin, and cusip are all omitted, the API returns 400 Bad Request.", "required": false, "schema": { "type": "string", "example": "US0378331005" } }, { "name": "cusip", "in": "query", "description": "Committee on Uniform Securities Identification Procedures code. Optional if symbol or ISIN is provided. If symbol, isin, and cusip are all omitted, the API returns 400 Bad Request.", "required": false, "schema": { "type": "string", "example": "037833100" } } ], "responses": { "200": { "description": "Company profile retrieved successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyProfile" }, "examples": { "default": { "value": { "address": "One Apple Park Way", "alias": "Apple Computer Inc, Apple Computer", "city": "Cupertino", "country": "US", "currency": "USD", "cusip": "037833100", "description": "Apple Inc. designs, manufactures, and markets smartphones, personal computers, tablets, wearables, and accessories worldwide.", "employeeTotal": 161000, "estimateCurrency": "USD", "exchange": "NASDAQ NMS - GLOBAL MARKET", "sector": "Technology", "ggroup": "Technology Hardware & Equipment", "gind": "Technology Hardware, Storage & Peripherals", "gsector": "Information Technology", "gsubind": "Technology Hardware, Storage & Peripherals", "ipo": "1980-12-12", "irUrl": "https://investor.apple.com/", "isin": "US0378331005", "lei": "HWUPKR0MPOU8FGXBT394", "logo": "https://api.aries.com/v1/logos/image/a/path", "marketCapCurrency": "USD", "marketCapitalization": 4108269.25, "naics": "334220", "naicsNationalIndustry": "Radio and Television Broadcasting and Wireless Communications Equipment Manufacturing", "naicsSector": "Manufacturing", "naicsSubsector": "Computer and Electronic Product Manufacturing", "name": "Apple Inc", "phone": "14089961010", "sedol": "2046251", "shareOutstanding": 14776.349609375, "state": "CA", "ticker": "AAPL", "weburl": "https://www.apple.com/" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "security": [ { "OAuth2": [ "market:supplemental" ] } ], "tags": [ "Company" ], "operationId": "get_v1_company_profile" } }, "/v1/company/executive": { "get": { "summary": "Get Company Executives", "description": "Retrieve information about company executives and key management personnel including names, titles, compensation, and tenure.", "parameters": [ { "name": "symbol", "in": "query", "required": true, "schema": { "type": "string", "example": "AAPL" }, "description": "Stock ticker symbol to research, such as AAPL." } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyExecutiveResponse" }, "examples": { "default": { "value": { "executives": [ { "age": 64, "compensation": 74294811, "currency": "USD", "name": "Mr. Timothy Cook", "position": "Mr. Timothy Cook", "sex": "male", "since": "1998" } ] } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "security": [ { "OAuth2": [ "market:supplemental" ] } ], "tags": [ "Company" ], "operationId": "get_v1_company_executive" } }, "/v1/company/peers": { "get": { "summary": "Get Company Peers", "description": "Retrieve a list of peer companies within the same industry or sector that are comparable in size and business model.", "parameters": [ { "name": "symbol", "in": "query", "required": true, "schema": { "type": "string", "example": "AAPL" }, "description": "Stock ticker symbol to research, such as AAPL." } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyPeersResponse" }, "examples": { "default": { "value": { "peers": [ "AAPL", "DELL", "WDC", "SNDK", "HPE", "PSTG", "HPQ", "NTAP", "SMCI", "IONQ", "QUBT", "CMPO" ] } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "security": [ { "OAuth2": [ "market:supplemental" ] } ], "tags": [ "Company" ], "operationId": "get_v1_company_peers" } }, "/v1/company/metrics": { "get": { "summary": "Get Company Financial Metrics", "description": "Retrieve key financial metrics and ratios including market capitalization, P/E ratio, dividend yield, profit margins, and return on equity.", "parameters": [ { "name": "symbol", "in": "query", "required": true, "schema": { "type": "string", "example": "AAPL" }, "description": "Stock ticker symbol to research, such as AAPL." }, { "name": "metric", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "all" ], "example": "all" }, "description": "Which metric group to return. Currently only `all` is supported — it returns every available metric for the symbol." } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BasicFinancials" }, "examples": { "default": { "value": { "series": { "annual": { "currentRatio": [ { "period": "2019-09-28", "v": 1.5401 }, { "period": "2018-09-29", "v": 1.1329 } ], "salesPerShare": [ { "period": "2019-09-28", "v": 55.9645 }, { "period": "2018-09-29", "v": 53.1178 } ], "netMargin": [ { "period": "2019-09-28", "v": 0.2124 }, { "period": "2018-09-29", "v": 0.2241 } ] } }, "metric": { "10DayAverageTradingVolume": 32.50147, "52WeekHigh": 310.43, "52WeekLow": 149.22, "52WeekLowDate": "2019-01-14", "52WeekPriceReturnDaily": 101.96334, "beta": 1.2989 }, "metricType": "all", "symbol": "AAPL" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "security": [ { "OAuth2": [ "market:supplemental" ] } ], "tags": [ "Company" ], "operationId": "get_v1_company_metrics" } }, "/v1/ownership/data": { "get": { "summary": "Get Company Ownership Data", "description": "Retrieve detailed ownership structure showing percentage stakes held by institutional investors, insiders, and retail shareholders.", "parameters": [ { "name": "symbol", "in": "query", "description": "Stock symbol, such as AAPL. Use it to narrow results to one company.", "required": true, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "Optional maximum number of results to return. Use it to keep ownership lists small for UI views.", "required": false, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Ownership data.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OwnershipDataResponse" }, "examples": { "default": { "value": { "data": [ { "name": "The Vanguard Group, Inc.", "share": 1409216610, "change": 14962890, "filingDate": "2025-06-30", "source": "", "percentOfShares": 0 } ] } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "security": [ { "OAuth2": [ "market:supplemental" ] } ], "tags": [ "Ownership" ], "operationId": "get_v1_ownership_data" } }, "/v1/ownership/fund": { "get": { "summary": "Get Fund Ownership Data", "description": "Retrieve mutual fund and ETF ownership data showing which funds hold positions in a specific security and their holding amounts.", "parameters": [ { "name": "symbol", "in": "query", "description": "Stock symbol, such as AAPL. Use it to narrow results to one company.", "required": true, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "Optional maximum number of results to return. Use it to keep ownership lists small for UI views.", "required": false, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Fund ownership data.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OwnershipDataResponse" }, "examples": { "default": { "value": { "data": [ { "name": "Vanguard Total Stock Market Index Fund", "share": 466994523, "change": -2711875, "filingDate": "2025-09-30", "source": "", "percentOfShares": 0 } ] } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "security": [ { "OAuth2": [ "market:supplemental" ] } ], "tags": [ "Ownership" ], "operationId": "get_v1_ownership_fund" } }, "/v1/ownership/insider-transactions": { "get": { "summary": "Get Insider Transactions", "description": "Retrieve insider trading activity including purchases, sales, and option exercises by company executives, directors, and major shareholders.", "parameters": [ { "name": "symbol", "in": "query", "description": "Stock symbol, such as AAPL. Use it to narrow results to one company.", "required": true, "schema": { "type": "string" } }, { "name": "from", "in": "query", "description": "Optional start date in YYYY-MM-DD format. Use it to begin the research window.", "required": false, "schema": { "type": "string" } }, { "name": "to", "in": "query", "description": "Optional end date in YYYY-MM-DD format. Use it to end the research window.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Insider transactions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InsiderTransactionsResponse" }, "examples": { "default": { "value": { "transactions": [ { "symbol": "AAPL", "name": "BELL JAMES A", "share": 38527, "change": 1852, "filingDate": "2024-02-05", "transactionDate": "2024-02-01", "transactionCode": "M", "transactionPrice": 0 } ] } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "security": [ { "OAuth2": [ "market:supplemental" ] } ], "tags": [ "Ownership" ], "operationId": "get_v1_ownership_insider_transactions" } }, "/v1/institutional/portfolio": { "get": { "summary": "Get Institutional Portfolio", "description": "Retrieve portfolio holdings for institutional investors including hedge funds, mutual funds, and pension funds based on SEC Form 13F filings.", "parameters": [ { "name": "cik", "in": "query", "required": true, "schema": { "type": "string", "example": "0001067983" }, "description": "Central Index Key (CIK) of the institution." }, { "name": "from", "in": "query", "required": true, "schema": { "type": "string", "format": "date", "example": "2024-01-01" }, "description": "Start date in YYYY-MM-DD format. Enter the first date to include in the research window." }, { "name": "to", "in": "query", "required": true, "schema": { "type": "string", "format": "date", "example": "2024-12-31" }, "description": "End date in YYYY-MM-DD format. Enter the last date to include in the research window." } ], "responses": { "200": { "description": "Institutional portfolio holdings.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InstitutionalPortfolioResponse" }, "examples": { "default": { "value": { "holdings": [ { "symbol": "IFRX", "cusip": "N44821101", "name": "INFLARX NV", "share": 0, "change": -73860, "value": 0, "putCall": "" } ] } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "security": [ { "OAuth2": [ "market:supplemental" ] } ], "tags": [ "Ownership" ], "operationId": "get_v1_institutional_portfolio" } }, "/v1/institutional/ownership": { "get": { "summary": "Get Institutional Ownership", "description": "Retrieve institutional ownership data showing the percentage of shares held by institutional investors and changes over time.", "parameters": [ { "name": "cusip", "in": "query", "required": true, "schema": { "type": "string", "example": "023135106" }, "description": "CUSIP security identifier for the security you want institutional ownership for." }, { "name": "from", "in": "query", "required": true, "schema": { "type": "string", "format": "date", "example": "2024-01-01" }, "description": "Start date in YYYY-MM-DD format. Enter the first date to include in the research window." }, { "name": "to", "in": "query", "required": true, "schema": { "type": "string", "format": "date", "example": "2024-12-31" }, "description": "End date in YYYY-MM-DD format. Enter the last date to include in the research window." }, { "name": "symbol", "in": "query", "required": false, "schema": { "type": "string", "example": "TSLA" }, "description": "Optional stock ticker symbol filter, such as AAPL. Use it to narrow results to one company." } ], "responses": { "200": { "description": "Institutional ownership data.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InstitutionalOwnershipResponse" }, "examples": { "default": { "value": { "data": [ { "symbol": "TSLA", "cusip": "023135106", "name": "Worth Asset Management, LLC", "share": 1743, "change": -57, "value": 197000, "putCall": "" } ] } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "security": [ { "OAuth2": [ "market:supplemental" ] } ], "tags": [ "Ownership" ], "operationId": "get_v1_institutional_ownership" } }, "/v1/financials/reported": { "get": { "summary": "Get Reported Financials", "description": "Retrieve as-reported financial data from company filings. At least one of `symbol`, `cik`, or `accessNumber` is required. Optional filters: `freq`, `from`, and `to`.", "parameters": [ { "name": "symbol", "in": "query", "description": "Stock symbol, such as AAPL. Use it to narrow results to one company. Required when both `cik` and `accessNumber` are omitted.", "required": false, "schema": { "type": "string" } }, { "name": "cik", "in": "query", "description": "SEC CIK. Optional when `symbol` or `accessNumber` is provided.", "required": false, "schema": { "type": "string" } }, { "name": "accessNumber", "in": "query", "description": "SEC access number. Optional when `symbol` or `cik` is provided.", "required": false, "schema": { "type": "string" } }, { "name": "freq", "in": "query", "description": "Optional reporting frequency filter. Use it to limit results to annual or quarterly reports.", "required": false, "schema": { "$ref": "#/components/schemas/ReportingFrequency" } }, { "name": "from", "in": "query", "description": "Optional start date in YYYY-MM-DD format. Use it to begin the research window.", "required": false, "schema": { "format": "date", "type": "string" } }, { "name": "to", "in": "query", "description": "Optional end date in YYYY-MM-DD format. Use it to end the research window.", "required": false, "schema": { "format": "date", "type": "string" } } ], "responses": { "200": { "description": "Reported financials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FinancialsReportedResponse" }, "examples": { "default": { "value": { "data": { "cik": "320193", "data": [ { "acceptedDate": "2025-05-02 06:00:46", "accessNumber": "0000320193-25-000057", "cik": "320193", "endDate": "2025-03-29 00:00:00", "filedDate": "2025-05-02 00:00:00", "form": "10-Q", "quarter": 2, "report": { "bs": [ { "concept": "us-gaap_ComprehensiveIncomeNetOfTax", "label": "Total comprehensive income", "unit": "usd", "value": 61919000000 } ] }, "startDate": "2024-09-29 00:00:00", "symbol": "AAPL", "year": 2025 } ], "symbol": "AAPL" } } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "security": [ { "OAuth2": [ "market:supplemental" ] } ], "tags": [ "Financials" ], "operationId": "get_v1_financials_reported" } }, "/v1/financials/statements": { "get": { "summary": "Get Financial Statements", "description": "Retrieve standardized financial statements (income, balance sheet, cash flow). **symbol**, **statement**, and **freq** are required.", "parameters": [ { "name": "symbol", "in": "query", "description": "Stock symbol, such as AAPL. Use it to choose the company you want to research.", "required": true, "schema": { "type": "string" } }, { "name": "statement", "in": "query", "description": "Financial statement type to return. Choose the statement category your analysis needs.", "required": true, "schema": { "$ref": "#/components/schemas/FinancialStatementType" } }, { "name": "freq", "in": "query", "description": "Reporting frequency to return. Use annual or quarterly based on your analysis view.", "required": true, "schema": { "$ref": "#/components/schemas/ReportingFrequency" } }, { "name": "preliminary", "in": "query", "description": "Include preliminary data (optional boolean).", "required": false, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Financial statements data.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FinancialsStatementsResponse" }, "examples": { "default": { "value": { "data": { "financials": [ { "costOfGoodsSold": 505.765, "dilutedAverageSharesOutstanding": 13410.208, "dilutedEPS": 0.01, "ebit": 129.639, "grossIncome": 477.004, "interestIncomeExpense": 0, "netIncome": 76.714, "netIncomeAfterTaxes": 76.714, "nonRecurringItems": 0, "period": "1983-09-30", "pretaxIncome": 146.122, "provisionforIncomeTaxes": 69.408, "researchDevelopment": 60.04, "revenue": 982.769, "sgaExpense": 287.325, "totalOperatingExpense": 347.365, "totalOtherIncomeExpenseNet": 16.483, "year": 1983 } ], "symbol": "AAPL" } } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "security": [ { "OAuth2": [ "market:supplemental" ] } ], "tags": [ "Financials" ], "operationId": "get_v1_financials_statements" } }, "/v1/financials/revenue-breakdown": { "get": { "summary": "Get Revenue Breakdown", "description": "Retrieve revenue segmentation by product, geography, or business unit. Provide at least one of `symbol` or `cik`.", "parameters": [ { "name": "symbol", "in": "query", "description": "Stock ticker symbol to research, such as AAPL. Required when `cik` is omitted.", "required": false, "schema": { "type": "string", "example": "AAPL" } }, { "name": "cik", "in": "query", "description": "SEC CIK. Optional when `symbol` is provided.", "required": false, "schema": { "type": "string", "example": "320193" } } ], "responses": { "200": { "description": "Revenue breakdown data.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FinancialsRevenueBreakdownResponse" }, "examples": { "default": { "value": { "data": { "cik": "320193", "data": [ { "accessNumber": "0000320193-25-000079", "breakdown": { "concept": "us-gaap_RevenueFromContractWithCustomerExcludingAssessedTax", "endDate": "2025-09-27", "revenueBreakdown": [ { "axis": "srt_ProductOrServiceAxis", "data": [ { "label": "Services", "member": "us-gaap_ServiceMember", "percentage": 26.22975242754607, "unit": "usd", "value": 109158000000 } ] }, { "axis": "srt_ConsolidationItemsAxis", "data": [ { "label": "Operating segments", "member": "us-gaap_OperatingSegmentsMember", "percentage": 8.09686635701087, "unit": "usd", "value": 33696000000 } ] }, { "axis": "srt_StatementGeographicalAxis", "data": [ { "label": "U.S.", "member": "country_US", "percentage": 36.473864682178295, "unit": "usd", "value": 151790000000 } ] } ], "startDate": "2024-09-29", "unit": "usd", "value": 416161000000 } }, { "accessNumber": "0001193125-10-162840", "breakdown": { "concept": "us-gaap:SalesRevenueNet", "endDate": "2010-06-26", "revenueBreakdown": [ { "axis": "us-gaap:SegmentReportingInformationBySegmentAxis", "data": [ { "label": "Europe [Member]", "member": "aapl:EuropeMember", "percentage": 29.486208279488434, "unit": "usd", "value": 13234000000 } ], "label": "Segment Reporting Information, by Segment [Axis]" } ], "startDate": "2009-09-27", "unit": "usd", "value": 44882000000 } } ], "symbol": "AAPL" } } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "security": [ { "OAuth2": [ "market:supplemental" ] } ], "tags": [ "Financials" ], "operationId": "get_v1_financials_revenue_breakdown" } }, "/v1/financials/cash-flow-statements": { "get": { "operationId": "getCashFlowStatements", "summary": "Get Cash Flow Statements", "description": "Retrieve SEC cash flow statement rows per filing period. Filter by CIK, tickers, filing or period dates, fiscal year/quarter, timeframe, and pagination. Same query shape as income statements.", "parameters": [ { "name": "cik", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Exact SEC CIK company identifier. Use this when you need one specific SEC registrant." }, { "name": "ciks", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Comma-separated CIKs (maps to cik.any_of)" }, { "name": "cikAfter", "in": "query", "required": false, "schema": { "type": "string" }, "description": "CIK pagination lower bound. Returns records with CIK values greater than this value, excluding the value itself." }, { "name": "cikFrom", "in": "query", "required": false, "schema": { "type": "string" }, "description": "CIK greater than or equal (inclusive)" }, { "name": "cikBefore", "in": "query", "required": false, "schema": { "type": "string" }, "description": "CIK pagination upper bound. Returns records with CIK values less than this value, excluding the value itself." }, { "name": "cikTo", "in": "query", "required": false, "schema": { "type": "string" }, "description": "CIK upper-bound filter. Returns records with CIK values less than or equal to this value." }, { "name": "periodEnd", "in": "query", "required": false, "schema": { "type": "string", "format": "date" }, "description": "Exact fiscal period-end date filter. Use it to return statements for one reporting period." }, { "name": "periodEndAfter", "in": "query", "required": false, "schema": { "type": "string", "format": "date" }, "description": "Fiscal period-end lower-bound filter. Returns records after this date, excluding the date itself." }, { "name": "periodEndFrom", "in": "query", "required": false, "schema": { "type": "string", "format": "date" }, "description": "Fiscal period-end start filter. Returns records on or after this date." }, { "name": "periodEndBefore", "in": "query", "required": false, "schema": { "type": "string", "format": "date" }, "description": "Fiscal period-end upper-bound filter. Returns records before this date, excluding the date itself." }, { "name": "periodEndTo", "in": "query", "required": false, "schema": { "type": "string", "format": "date" }, "description": "Fiscal period-end end filter. Returns records on or before this date." }, { "name": "filingDate", "in": "query", "required": false, "schema": { "type": "string", "format": "date" }, "description": "Exact filing date filter. Use it to return filings submitted on one specific date." }, { "name": "filingDateAfter", "in": "query", "required": false, "schema": { "type": "string", "format": "date" }, "description": "Filing-date lower-bound filter. Returns records after this date, excluding the date itself." }, { "name": "filingDateFrom", "in": "query", "required": false, "schema": { "type": "string", "format": "date" }, "description": "Filing-date start filter. Returns records on or after this date." }, { "name": "filingDateBefore", "in": "query", "required": false, "schema": { "type": "string", "format": "date" }, "description": "Filing-date upper-bound filter. Returns records before this date, excluding the date itself." }, { "name": "filingDateTo", "in": "query", "required": false, "schema": { "type": "string", "format": "date" }, "description": "Filing-date end filter. Returns records on or before this date." }, { "name": "tickers", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Ticker symbol filter. Enter a ticker such as AAPL to narrow results to one company." }, { "name": "tickersAllOf", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Ticker all-of filter. Return records that include all listed tickers." }, { "name": "tickersAnyOf", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Ticker any-of filter. Return records that include at least one listed ticker." }, { "name": "fiscalYear", "in": "query", "required": false, "schema": { "type": "number", "format": "double" }, "description": "Exact fiscal year filter. Use it to return statements for one reporting year." }, { "name": "fiscalYearAbove", "in": "query", "required": false, "schema": { "type": "number", "format": "double" }, "description": "Fiscal year greater than (exclusive)" }, { "name": "fiscalYearMin", "in": "query", "required": false, "schema": { "type": "number", "format": "double" }, "description": "Fiscal year greater than or equal (inclusive)" }, { "name": "fiscalYearBelow", "in": "query", "required": false, "schema": { "type": "number", "format": "double" }, "description": "Fiscal-year upper-bound filter. Returns records before this fiscal year, excluding the year itself." }, { "name": "fiscalYearMax", "in": "query", "required": false, "schema": { "type": "number", "format": "double" }, "description": "Fiscal year less than or equal (inclusive)" }, { "name": "fiscalQuarter", "in": "query", "required": false, "schema": { "type": "number", "format": "double" }, "description": "Exact fiscal quarter filter. Use values such as 1, 2, 3, or 4 when supported." }, { "name": "fiscalQuarterAbove", "in": "query", "required": false, "schema": { "type": "number", "format": "double" }, "description": "Fiscal quarter greater than (exclusive)" }, { "name": "fiscalQuarterMin", "in": "query", "required": false, "schema": { "type": "number", "format": "double" }, "description": "Fiscal quarter greater than or equal (inclusive)" }, { "name": "fiscalQuarterBelow", "in": "query", "required": false, "schema": { "type": "number", "format": "double" }, "description": "Fiscal quarter less than (exclusive)" }, { "name": "fiscalQuarterMax", "in": "query", "required": false, "schema": { "type": "number", "format": "double" }, "description": "Fiscal quarter less than or equal (inclusive)" }, { "name": "timeframe", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Reporting timeframe (e.g. quarterly, annual)" }, { "name": "timeframeAnyOf", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Timeframe any-of filter. Return records that match at least one listed timeframe." }, { "name": "timeframeAfter", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Timeframe lower-bound filter. Returns records after this timeframe, excluding the value itself." }, { "name": "timeframeFrom", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Timeframe greater than or equal (inclusive)" }, { "name": "timeframeBefore", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Timeframe upper-bound filter. Returns records before this timeframe, excluding the value itself." }, { "name": "timeframeTo", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Timeframe less than or equal (inclusive)" }, { "name": "maxTicker", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Exact maximum ticker value from the statement record. Use only for provider-specific filtering." }, { "name": "maxTickerAnyOf", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Max ticker any-of filter. Return records matching at least one listed maxTicker value." }, { "name": "maxTickerAfter", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Max ticker greater than (exclusive)" }, { "name": "maxTickerFrom", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Max ticker greater than or equal (inclusive)" }, { "name": "maxTickerBefore", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Max ticker upper-bound filter. Returns records before this value, excluding the value itself." }, { "name": "maxTickerTo", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Max ticker less than or equal (inclusive)" }, { "name": "minTicker", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Exact minimum ticker value from the statement record. Use only for provider-specific filtering." }, { "name": "minTickerAnyOf", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Min ticker any-of filter. Return records matching at least one listed minTicker value." }, { "name": "minTickerAfter", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Min ticker greater than (exclusive)" }, { "name": "minTickerFrom", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Min ticker greater than or equal (inclusive)" }, { "name": "minTickerBefore", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Min ticker upper-bound filter. Returns records before this value, excluding the value itself." }, { "name": "minTickerTo", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Min ticker less than or equal (inclusive)" }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1 }, "description": "Maximum number of results per page. Use smaller values for UI pages and larger values for exports within API limits." }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "string" }, "description": "A comma-separated list of sort columns. For each column, append `.asc` or `.desc` to specify direction. Defaults to `period_end.asc` when not specified." }, { "name": "next", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Pagination cursor from the previous response. Omit it on the first request, then send the returned cursor to fetch the next page." } ], "responses": { "200": { "description": "Successful response with one or more SEC cash flow rows, status, request id, and optional nextUrl for pagination.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CashFlowStatementsResponse" }, "examples": { "default": { "value": { "results": [ { "cashFromOperatingActivitiesContinuingOperations": 5781000000, "changeInCashAndEquivalents": 2346000000, "changeInOtherOperatingAssetsAndLiabilitiesNet": 1564000000, "cik": "0000320193", "depreciationDepletionAndAmortization": 209000000, "dividends": 0, "filingDate": "2011-01-19", "fiscalQuarter": 1, "fiscalYear": 2010, "longTermDebtIssuancesRepayments": 0, "netCashFromFinancingActivities": 523000000, "netCashFromFinancingActivitiesContinuingOperations": 523000000, "netCashFromInvestingActivities": -3958000000, "netCashFromInvestingActivitiesContinuingOperations": -3958000000, "netCashFromOperatingActivities": 5781000000, "netIncome": 3378000000, "otherFinancingActivities": 523000000, "otherInvestingActivities": -3582000000, "otherOperatingActivities": 630000000, "periodEnd": "2009-12-26", "purchaseOfPropertyPlantAndEquipment": -376000000, "tickers": [ "AAPL" ], "timeframe": "quarterly" } ], "status": "OK", "requestId": "d9ebd27856db41dc8f24f8118f9cada0", "nextUrl": "https://api.aries.com/v1/financials/cash-flow-statements?limit=5&next=ASYPBEFBUEwCAgABAQABAQUAAgEJ-zp0AQ8KMDAwMDMyMDE5Mw%3D%3D&tickersAnyOf=AAPL" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "security": [ { "OAuth2": [ "market:supplemental" ] } ], "tags": [ "Financials" ] } }, "/v1/financials/income-statements": { "get": { "operationId": "getIncomeStatements", "summary": "Get Income Statements", "description": "Retrieve SEC income statement rows per filing period. Filter by CIK, tickers, filing or period dates, fiscal year/quarter, timeframe, and pagination. Same query shape as cash flow statements.", "parameters": [ { "name": "cik", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Exact SEC CIK company identifier. Use this when you need one specific SEC registrant." }, { "name": "ciks", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Comma-separated CIKs (maps to cik.any_of)" }, { "name": "cikAfter", "in": "query", "required": false, "schema": { "type": "string" }, "description": "CIK pagination lower bound. Returns records with CIK values greater than this value, excluding the value itself." }, { "name": "cikFrom", "in": "query", "required": false, "schema": { "type": "string" }, "description": "CIK greater than or equal (inclusive)" }, { "name": "cikBefore", "in": "query", "required": false, "schema": { "type": "string" }, "description": "CIK pagination upper bound. Returns records with CIK values less than this value, excluding the value itself." }, { "name": "cikTo", "in": "query", "required": false, "schema": { "type": "string" }, "description": "CIK upper-bound filter. Returns records with CIK values less than or equal to this value." }, { "name": "periodEnd", "in": "query", "required": false, "schema": { "type": "string", "format": "date" }, "description": "Exact fiscal period-end date filter. Use it to return statements for one reporting period." }, { "name": "periodEndAfter", "in": "query", "required": false, "schema": { "type": "string", "format": "date" }, "description": "Fiscal period-end lower-bound filter. Returns records after this date, excluding the date itself." }, { "name": "periodEndFrom", "in": "query", "required": false, "schema": { "type": "string", "format": "date" }, "description": "Fiscal period-end start filter. Returns records on or after this date." }, { "name": "periodEndBefore", "in": "query", "required": false, "schema": { "type": "string", "format": "date" }, "description": "Fiscal period-end upper-bound filter. Returns records before this date, excluding the date itself." }, { "name": "periodEndTo", "in": "query", "required": false, "schema": { "type": "string", "format": "date" }, "description": "Fiscal period-end end filter. Returns records on or before this date." }, { "name": "filingDate", "in": "query", "required": false, "schema": { "type": "string", "format": "date" }, "description": "Exact filing date filter. Use it to return filings submitted on one specific date." }, { "name": "filingDateAfter", "in": "query", "required": false, "schema": { "type": "string", "format": "date" }, "description": "Filing-date lower-bound filter. Returns records after this date, excluding the date itself." }, { "name": "filingDateFrom", "in": "query", "required": false, "schema": { "type": "string", "format": "date" }, "description": "Filing-date start filter. Returns records on or after this date." }, { "name": "filingDateBefore", "in": "query", "required": false, "schema": { "type": "string", "format": "date" }, "description": "Filing-date upper-bound filter. Returns records before this date, excluding the date itself." }, { "name": "filingDateTo", "in": "query", "required": false, "schema": { "type": "string", "format": "date" }, "description": "Filing-date end filter. Returns records on or before this date." }, { "name": "tickers", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Ticker symbol filter. Enter a ticker such as AAPL to narrow results to one company." }, { "name": "tickersAllOf", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Ticker all-of filter. Return records that include all listed tickers." }, { "name": "tickersAnyOf", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Ticker any-of filter. Return records that include at least one listed ticker." }, { "name": "fiscalYear", "in": "query", "required": false, "schema": { "type": "number", "format": "double" }, "description": "Exact fiscal year filter. Use it to return statements for one reporting year." }, { "name": "fiscalYearAbove", "in": "query", "required": false, "schema": { "type": "number", "format": "double" }, "description": "Fiscal year greater than (exclusive)" }, { "name": "fiscalYearMin", "in": "query", "required": false, "schema": { "type": "number", "format": "double" }, "description": "Fiscal year greater than or equal (inclusive)" }, { "name": "fiscalYearBelow", "in": "query", "required": false, "schema": { "type": "number", "format": "double" }, "description": "Fiscal-year upper-bound filter. Returns records before this fiscal year, excluding the year itself." }, { "name": "fiscalYearMax", "in": "query", "required": false, "schema": { "type": "number", "format": "double" }, "description": "Fiscal year less than or equal (inclusive)" }, { "name": "fiscalQuarter", "in": "query", "required": false, "schema": { "type": "number", "format": "double" }, "description": "Exact fiscal quarter filter. Use values such as 1, 2, 3, or 4 when supported." }, { "name": "fiscalQuarterAbove", "in": "query", "required": false, "schema": { "type": "number", "format": "double" }, "description": "Fiscal quarter greater than (exclusive)" }, { "name": "fiscalQuarterMin", "in": "query", "required": false, "schema": { "type": "number", "format": "double" }, "description": "Fiscal quarter greater than or equal (inclusive)" }, { "name": "fiscalQuarterBelow", "in": "query", "required": false, "schema": { "type": "number", "format": "double" }, "description": "Fiscal quarter less than (exclusive)" }, { "name": "fiscalQuarterMax", "in": "query", "required": false, "schema": { "type": "number", "format": "double" }, "description": "Fiscal quarter less than or equal (inclusive)" }, { "name": "timeframe", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Reporting timeframe (e.g. quarterly, annual)" }, { "name": "timeframeAnyOf", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Timeframe any-of filter. Return records that match at least one listed timeframe." }, { "name": "timeframeAfter", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Timeframe lower-bound filter. Returns records after this timeframe, excluding the value itself." }, { "name": "timeframeFrom", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Timeframe greater than or equal (inclusive)" }, { "name": "timeframeBefore", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Timeframe upper-bound filter. Returns records before this timeframe, excluding the value itself." }, { "name": "timeframeTo", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Timeframe less than or equal (inclusive)" }, { "name": "maxTicker", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Exact maximum ticker value from the statement record. Use only for provider-specific filtering." }, { "name": "maxTickerAnyOf", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Max ticker any-of filter. Return records matching at least one listed maxTicker value." }, { "name": "maxTickerAfter", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Max ticker greater than (exclusive)" }, { "name": "maxTickerFrom", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Max ticker greater than or equal (inclusive)" }, { "name": "maxTickerBefore", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Max ticker upper-bound filter. Returns records before this value, excluding the value itself." }, { "name": "maxTickerTo", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Max ticker less than or equal (inclusive)" }, { "name": "minTicker", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Exact minimum ticker value from the statement record. Use only for provider-specific filtering." }, { "name": "minTickerAnyOf", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Min ticker any-of filter. Return records matching at least one listed minTicker value." }, { "name": "minTickerAfter", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Min ticker greater than (exclusive)" }, { "name": "minTickerFrom", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Min ticker greater than or equal (inclusive)" }, { "name": "minTickerBefore", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Min ticker upper-bound filter. Returns records before this value, excluding the value itself." }, { "name": "minTickerTo", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Min ticker less than or equal (inclusive)" }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1 }, "description": "Maximum number of results per page. Use smaller values for UI pages and larger values for exports within API limits." }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "string" }, "description": "A comma-separated list of sort columns. For each column, append `.asc` or `.desc` to specify direction. Defaults to `period_end.asc` when not specified." }, { "name": "next", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Pagination cursor from the previous response. Omit it on the first request, then send the returned cursor to fetch the next page." } ], "responses": { "200": { "description": "Successful response with one or more SEC income statement rows, status, request id, and optional nextUrl for pagination.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IncomeStatementsResponse" }, "examples": { "default": { "value": { "results": [ { "basicEarningsPerShare": 0.13, "basicSharesOutstanding": 25299176000, "cik": "0000320193", "consolidatedNetIncomeLoss": 3378000000, "costOfRevenue": 9272000000, "dilutedEarningsPerShare": 0.13, "dilutedSharesOutstanding": 25753924000, "ebitda": 4934000000, "filingDate": "2011-01-19", "fiscalQuarter": 1, "fiscalYear": 2010, "grossProfit": 6411000000, "incomeBeforeIncomeTaxes": 4758000000, "incomeTaxes": 1380000000, "netIncomeLossAttributableCommonShareholders": 3378000000, "operatingIncome": 4725000000, "otherIncomeExpense": 33000000, "otherOperatingExpenses": 0, "periodEnd": "2009-12-26", "researchDevelopment": 398000000, "revenue": 15683000000, "sellingGeneralAdministrative": 1288000000, "tickers": [ "AAPL" ], "timeframe": "quarterly", "totalOperatingExpenses": 1686000000, "totalOtherIncomeExpense": 33000000 } ], "status": "OK", "requestId": "87fbffe186684ff1a4297e43d17fa8f7", "nextUrl": "https://api.aries.com/v1/financials/income-statements?limit=5&next=AiYPBEFBUEwpDwlxdWFydGVybHkCAgABAQABAQUAAgEJ-_B0AQ8KMDAwMDMyMDE5Mw%3D%3D&tickersAnyOf=AAPL&timeframe=quarterly" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "security": [ { "OAuth2": [ "market:supplemental" ] } ], "tags": [ "Financials" ] } }, "/v1/filings/sec": { "get": { "summary": "Get SEC Filings", "description": "Retrieve Securities and Exchange Commission (SEC) filings including 10-K annual reports, 10-Q quarterly reports, 8-K current reports, and proxy statements.", "parameters": [ { "name": "symbol", "in": "query", "required": false, "schema": { "type": "string", "example": "AAPL" }, "description": "Stock symbol (optional if cik provided)" }, { "name": "cik", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Central Index Key (optional if symbol provided)" }, { "name": "accessNumber", "in": "query", "required": false, "schema": { "type": "string" }, "description": "SEC access number to filter by specific filing" }, { "name": "form", "in": "query", "required": false, "schema": { "type": "string", "example": "10-K" }, "description": "Form type (e.g. 10-K, 10-Q, 8-K, DEF 14A)" }, { "name": "from", "in": "query", "required": false, "schema": { "type": "string", "format": "date" }, "description": "Start date in YYYY-MM-DD format. Enter the first date to include in the research window." }, { "name": "to", "in": "query", "required": false, "schema": { "type": "string", "format": "date" }, "description": "End date in YYYY-MM-DD format. Enter the last date to include in the research window." } ], "responses": { "200": { "description": "SEC filings.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecFilingsResponse" }, "examples": { "default": { "value": { "filings": [ { "accessNumber": "0001308179-24-000010", "symbol": "AAPL", "cik": "320193", "form": "DEF 14A", "filedDate": "2024-01-11 00:00:00", "acceptedDate": "2024-01-11 16:30:29", "reportUrl": "https://www.sec.gov/Archives/edgar/data/320193/000130817924000010/laapl2024_def14a.htm", "filingUrl": "https://www.sec.gov/Archives/edgar/data/320193/000130817924000010/0001308179-24-000010-index.html" } ] } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "security": [ { "OAuth2": [ "market:supplemental" ] } ], "tags": [ "Filings" ], "operationId": "get_v1_filings_sec" } }, "/v1/filings/similarity-index": { "get": { "summary": "Get Filings Similarity Index", "description": "Retrieve similarity scores comparing current SEC filings to previous filings to identify significant changes in disclosures and risk factors. Provide either `symbol` or `cik`: `symbol` is required when `cik` is omitted, and `cik` is required when `symbol` is omitted. `freq` is optional.", "parameters": [ { "name": "symbol", "in": "query", "required": false, "schema": { "type": "string", "example": "MSFT" }, "description": "Stock symbol, such as AAPL. Use it to narrow results to one company. Required when `cik` is not provided." }, { "name": "cik", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Central Index Key. Required when `symbol` is not provided." }, { "name": "freq", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/ReportingFrequency" }, "description": "Reporting frequency filter. Use annual or quarterly when you want only one reporting cadence." } ], "responses": { "200": { "description": "Filings similarity index.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FilingsSimilarityIndexResponse" }, "examples": { "default": { "value": { "data": { "cik": "789019", "similarity": [ { "acceptedDate": "1994-02-14 00:00:00", "accessNumber": "0000950109-94-000252", "cik": "789019", "filedDate": "1994-02-14 00:00:00", "filingUrl": "https://www.sec.gov/Archives/edgar/data/789019/000095010994000252/0000950109-94-000252-index.html", "form": "10-Q", "item1": 0, "item1a": 0, "item2": 0, "item7": 0, "item7a": 0, "reportUrl": "https://www.sec.gov/Archives/edgar/data/789019/000095010994000252/0000950109-94-000252.txt" } ], "symbol": "MSFT" } } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "security": [ { "OAuth2": [ "market:supplemental" ] } ], "tags": [ "Filings" ], "operationId": "get_v1_filings_similarity_index" } }, "/v1/corporate-actions/ipo-calendar": { "get": { "summary": "Get IPO Calendar", "description": "Retrieve upcoming and recent initial public offerings (IPOs) including offering dates, price ranges, share counts, and underwriters.", "parameters": [ { "name": "from", "in": "query", "required": true, "schema": { "type": "string", "format": "date", "example": "2024-01-01" }, "description": "Start date in YYYY-MM-DD format. Enter the first date to include in the research window." }, { "name": "to", "in": "query", "required": true, "schema": { "type": "string", "format": "date", "example": "2024-12-31" }, "description": "End date in YYYY-MM-DD format. Enter the last date to include in the research window." } ], "responses": { "200": { "description": "IPO calendar.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IpoCalendarResponse" }, "examples": { "default": { "value": { "ipos": [ { "symbol": "ESPAU", "name": "Expectation Acquisition Corp", "date": "2024-07-16", "exchange": "", "priceFrom": 0, "priceTo": 0, "totalSharesValue": 69000000, "status": "filed" } ] } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "security": [ { "OAuth2": [ "market:supplemental" ] } ], "tags": [ "Corporate Actions" ], "operationId": "get_v1_corporate_actions_ipo_calendar" } }, "/v1/corporate-actions/dividends": { "get": { "summary": "Get Dividend History", "description": "Retrieve historical dividend payments including declaration dates, ex-dividend dates, payment dates, and dividend amounts per share. `ticker` accepts a single symbol only. Use `tickersAnyOf` for multiple symbols. If `ticker` contains multiple comma-separated values, the API returns 400: \"Multiple tickers are not supported. Please provide a single ticker.\" If both `ticker` and `tickersAnyOf` are set, the API returns 400: \"Cannot specify both ticker and tickersAnyOf. Use ticker for a single symbol or tickersAnyOf for multiple.\"", "parameters": [ { "name": "ticker", "in": "query", "description": "Single ticker symbol only, such as AAPL. Do not send a comma-separated list here; if you need multiple symbols, use `tickersAnyOf` instead.", "required": false, "schema": { "type": "string", "example": "AAPL" } }, { "name": "tickersAnyOf", "in": "query", "description": "Comma-separated list of ticker symbols.", "required": false, "schema": { "type": "string", "example": "AAPL,MSFT,GOOG" } }, { "name": "tickerFrom", "in": "query", "description": "Filter tickers >= this value (inclusive)", "required": false, "schema": { "type": "string", "example": "A" } }, { "name": "tickerAfter", "in": "query", "description": "Filter tickers > this value (exclusive)", "required": false, "schema": { "type": "string", "example": "A" } }, { "name": "tickerTo", "in": "query", "description": "Filter tickers <= this value (inclusive)", "required": false, "schema": { "type": "string", "example": "Z" } }, { "name": "tickerBefore", "in": "query", "description": "Filter tickers < this value (exclusive)", "required": false, "schema": { "type": "string", "example": "Z" } }, { "name": "exDividendDate", "in": "query", "description": "Exact ex-dividend date in YYYY-MM-DD format", "required": false, "schema": { "type": "string", "format": "date", "example": "2024-08-11" } }, { "name": "exDividendDateFrom", "in": "query", "description": "Ex-dividend start-date filter. Returns dividends with ex-dividend dates on or after this date.", "required": false, "schema": { "type": "string", "format": "date", "example": "2024-01-01" } }, { "name": "exDividendDateAfter", "in": "query", "description": "Ex-dividend after-date filter. Returns dividends after this date, excluding the date itself.", "required": false, "schema": { "type": "string", "format": "date", "example": "2024-01-01" } }, { "name": "exDividendDateTo", "in": "query", "description": "Ex-dividend end-date filter. Returns dividends with ex-dividend dates on or before this date.", "required": false, "schema": { "type": "string", "format": "date", "example": "2024-12-31" } }, { "name": "exDividendDateBefore", "in": "query", "description": "Ex-dividend before-date filter. Returns dividends before this date, excluding the date itself.", "required": false, "schema": { "type": "string", "format": "date", "example": "2024-12-31" } }, { "name": "frequency", "in": "query", "description": "Exact frequency (0=irregular, 1=annual, 4=quarterly, 12=monthly)", "required": false, "schema": { "type": "integer", "example": 4 } }, { "name": "frequencyMin", "in": "query", "description": "Dividend frequency lower-bound filter. Returns records with frequency greater than or equal to this value.", "required": false, "schema": { "type": "integer", "example": 1 } }, { "name": "frequencyAbove", "in": "query", "description": "Dividend frequency lower-bound filter. Returns records above this value, excluding the value itself.", "required": false, "schema": { "type": "integer", "example": 0 } }, { "name": "frequencyMax", "in": "query", "description": "Dividend frequency upper-bound filter. Returns records with frequency less than or equal to this value.", "required": false, "schema": { "type": "integer", "example": 12 } }, { "name": "frequencyBelow", "in": "query", "description": "Dividend frequency upper-bound filter. Returns records below this value, excluding the value itself.", "required": false, "schema": { "type": "integer", "example": 13 } }, { "name": "distributionType", "in": "query", "description": "Exact type: recurring, special, supplemental, irregular, unknown", "required": false, "schema": { "type": "string", "enum": [ "recurring", "special", "supplemental", "irregular", "unknown" ], "example": "recurring" } }, { "name": "distributionTypes", "in": "query", "description": "Comma-separated list of distribution types", "required": false, "schema": { "type": "string", "example": "recurring,special" } }, { "name": "limit", "in": "query", "description": "Maximum number of results to return. Use smaller values for UI pages and larger values for exports within API limits. (1-5000)", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 5000, "example": 100 } }, { "name": "sort", "in": "query", "description": "A comma-separated list of sort columns. For each column, append `.asc` or `.desc` to specify direction. Defaults to `ticker.asc` when not specified. Examples: `ticker.asc`, `ex_dividend_date.desc`, or `ticker.asc,ex_dividend_date.desc`.", "required": false, "schema": { "type": "string" } }, { "name": "next", "in": "query", "description": "Opaque pagination cursor returned by a previous response. Omit on the first request, then pass the `next_page` (or equivalent) value from each response to walk through subsequent pages.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Dividends data.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DividendsResponse" }, "examples": { "default": { "value": { "results": [ { "ticker": "AAPL", "cashAmount": 0.26, "exDividendDate": "2025-11-10", "payDate": "2025-11-13", "recordDate": "2025-11-10", "frequency": 4, "distributionType": "recurring" } ], "status": "OK", "requestId": "abdd5e0f749621028802750474bc45cc", "nextUrl": "https://api.aries.com/v1/corporate-actions/dividends?next=..." } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "security": [ { "OAuth2": [ "market:supplemental" ] } ], "tags": [ "Corporate Actions" ], "operationId": "get_v1_corporate_actions_dividends" } }, "/v1/stock/price-target": { "get": { "summary": "Get Analyst Price Targets", "description": "Retrieve analyst price targets including consensus estimates, high/low targets, and individual analyst projections for stock valuation.", "parameters": [ { "name": "symbol", "in": "query", "required": true, "schema": { "type": "string", "example": "AAPL" }, "description": "Stock ticker to query. Send the plain uppercase symbol exactly as you'd type it on a brokerage screen, e.g. `AAPL`, `MSFT`, `TSLA`." } ], "responses": { "200": { "description": "Analyst price targets.", "content": { "application/json": { "schema": { "type": "object", "properties": { "lastUpdated": { "type": "string" }, "symbol": { "type": "string" }, "targetHigh": { "type": "number" }, "targetLow": { "type": "number" }, "targetMean": { "type": "number" }, "targetMedian": { "type": "number" }, "numberAnalysts": { "type": "integer" } } }, "examples": { "default": { "value": { "lastUpdated": "2025-12-03 00:00:00", "symbol": "AAPL", "targetHigh": 341.25, "targetLow": 217.15, "targetMean": 286.45, "targetMedian": 286.61, "numberAnalysts": 48 } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "security": [ { "OAuth2": [ "market:supplemental" ] } ], "tags": [ "Stock Estimates" ], "operationId": "get_v1_stock_price_target" } }, "/v1/stock/upgrade-downgrade": { "get": { "summary": "Get Analyst Upgrades & Downgrades", "description": "Retrieve analyst rating changes including upgrades, downgrades, and reiterations from investment banks and research firms.", "parameters": [ { "name": "symbol", "in": "query", "required": false, "description": "Stock ticker to filter by. Send the plain uppercase symbol (e.g. `AAPL`). Omit to return data across all symbols.", "schema": { "type": "string" } }, { "name": "from", "in": "query", "required": false, "schema": { "type": "string", "format": "date", "example": "2024-01-01" }, "description": "Start of the date window, inclusive. Format: `YYYY-MM-DD` (e.g. `2024-01-01`). Omit to read from the earliest available data." }, { "name": "to", "in": "query", "required": false, "schema": { "type": "string", "format": "date", "example": "2024-12-31" }, "description": "End of the date window, inclusive. Format: `YYYY-MM-DD` (e.g. `2024-12-31`). Omit to read up to today." } ], "responses": { "200": { "description": "Analyst upgrades and downgrades.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "symbol": { "type": "string" }, "gradeTime": { "type": "integer" }, "company": { "type": "string" }, "fromGrade": { "type": "string" }, "toGrade": { "type": "string" }, "action": { "type": "string" } } } } } }, "examples": { "default": { "value": { "data": [ { "symbol": "AAPL", "gradeTime": 1765238400, "company": "Citigroup", "fromGrade": "Buy", "toGrade": "Buy", "action": "main" }, { "symbol": "AAPL", "gradeTime": 1765065600, "company": "Goldman Sachs", "fromGrade": "Neutral", "toGrade": "Buy", "action": "upgrade" }, { "symbol": "AAPL", "gradeTime": 1764547200, "company": "Morgan Stanley", "fromGrade": "Overweight", "toGrade": "Overweight", "action": "main" } ] } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "security": [ { "OAuth2": [ "market:supplemental" ] } ], "tags": [ "Stock Estimates" ], "operationId": "get_v1_stock_upgrade_downgrade" } }, "/v1/stock/revenue-estimate": { "get": { "summary": "Get Revenue Estimates", "description": "Retrieve analyst revenue estimates including quarterly and annual projections with consensus forecasts and estimate revisions.", "parameters": [ { "name": "symbol", "in": "query", "required": true, "schema": { "type": "string", "example": "AAPL" }, "description": "Stock ticker to query. Send the plain uppercase symbol exactly as you'd type it on a brokerage screen, e.g. `AAPL`, `MSFT`, `TSLA`." }, { "name": "freq", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/ReportingFrequency" }, "description": "(Optional) Frequency: annual, quarterly" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "revenueEstimates": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "revenueAvg": { "type": "integer" }, "revenueHigh": { "type": "integer" }, "revenueLow": { "type": "integer" }, "numberAnalysts": { "type": "integer" }, "period": { "type": "string" }, "year": { "type": "integer" }, "quarter": { "type": "integer" } } } }, "symbol": { "type": "string" }, "freq": { "$ref": "#/components/schemas/ReportingFrequency" } } } } }, "examples": { "default": { "value": { "revenueEstimates": { "data": [ { "revenueAvg": 136963997696, "revenueHigh": 143836995584, "revenueLow": 13001984, "numberAnalysts": 25, "period": "2027-09-30", "year": 2027, "quarter": 4 }, { "revenueAvg": 100541997056, "revenueHigh": 103684997120, "revenueLow": 97506000000, "numberAnalysts": 25, "period": "2027-06-30", "year": 2027, "quarter": 3 }, { "revenueAvg": 94224998400, "revenueHigh": 96551002112, "revenueLow": 90791997440, "numberAnalysts": 25, "period": "2027-03-31", "year": 2027, "quarter": 2 } ], "symbol": "AAPL", "freq": "quarterly" } } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "security": [ { "OAuth2": [ "market:supplemental" ] } ], "tags": [ "Stock Estimates" ], "operationId": "get_v1_stock_revenue_estimate" } }, "/v1/stock/ebitda-estimate": { "get": { "summary": "Get EBITDA Estimates", "description": "Retrieve analyst EBITDA (Earnings Before Interest, Taxes, Depreciation, and Amortization) estimates for profitability forecasting.", "parameters": [ { "name": "symbol", "in": "query", "required": true, "schema": { "type": "string", "example": "AAPL" }, "description": "Stock ticker to query. Send the plain uppercase symbol exactly as you'd type it on a brokerage screen, e.g. `AAPL`, `MSFT`, `TSLA`." }, { "name": "freq", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/ReportingFrequency" }, "description": "(Optional) Frequency: annual, quarterly" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ebitdaEstimates": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "ebitdaAvg": { "type": "integer" }, "ebitdaHigh": { "type": "integer" }, "ebitdaLow": { "type": "integer" }, "numberAnalysts": { "type": "integer" }, "period": { "type": "string" }, "year": { "type": "integer" }, "quarter": { "type": "integer" } } } }, "symbol": { "type": "string" }, "freq": { "$ref": "#/components/schemas/ReportingFrequency" } } } } }, "examples": { "default": { "value": { "ebitdaEstimates": { "data": [ { "ebitdaAvg": 41837998080, "ebitdaHigh": 43157000192, "ebitdaLow": 39904002048, "numberAnalysts": 25, "period": "2027-09-30", "year": 2027, "quarter": 4 }, { "ebitdaAvg": 31958001664, "ebitdaHigh": 33003999232, "ebitdaLow": 30474000384, "numberAnalysts": 25, "period": "2027-06-30", "year": 2027, "quarter": 3 }, { "ebitdaAvg": 29007001600, "ebitdaHigh": 30011000832, "ebitdaLow": 27699001344, "numberAnalysts": 25, "period": "2027-03-31", "year": 2027, "quarter": 2 } ], "symbol": "AAPL", "freq": "quarterly" } } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "security": [ { "OAuth2": [ "market:supplemental" ] } ], "tags": [ "Stock Estimates" ], "operationId": "get_v1_stock_ebitda_estimate" } }, "/v1/stock/ebit-estimate": { "get": { "summary": "Get EBIT Estimates", "description": "Retrieve analyst EBIT (Earnings Before Interest and Taxes) estimates showing projected operating profitability.", "parameters": [ { "name": "symbol", "in": "query", "required": true, "schema": { "type": "string", "example": "AAPL" }, "description": "Stock ticker to query. Send the plain uppercase symbol exactly as you'd type it on a brokerage screen, e.g. `AAPL`, `MSFT`, `TSLA`." }, { "name": "freq", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/ReportingFrequency" }, "description": "(Optional) Frequency: annual, quarterly" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ebitEstimates": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "ebitAvg": { "type": "integer" }, "ebitHigh": { "type": "integer" }, "ebitLow": { "type": "integer" }, "numberAnalysts": { "type": "integer" }, "period": { "type": "string" }, "year": { "type": "integer" }, "quarter": { "type": "integer" } } } }, "symbol": { "type": "string" }, "freq": { "$ref": "#/components/schemas/ReportingFrequency" } } } } }, "examples": { "default": { "value": { "ebitEstimates": { "data": [ { "ebitAvg": 36118999040, "ebitHigh": 37274001408, "ebitLow": 34582003712, "numberAnalysts": 25, "period": "2027-09-30", "year": 2027, "quarter": 4 }, { "ebitAvg": 26133999616, "ebitHigh": 26983999488, "ebitLow": 24916000768, "numberAnalysts": 25, "period": "2027-06-30", "year": 2027, "quarter": 3 }, { "ebitAvg": 23142000640, "ebitHigh": 23946999808, "ebitLow": 21992001536, "numberAnalysts": 25, "period": "2027-03-31", "year": 2027, "quarter": 2 } ], "symbol": "AAPL", "freq": "quarterly" } } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "security": [ { "OAuth2": [ "market:supplemental" ] } ], "tags": [ "Stock Estimates" ], "operationId": "get_v1_stock_ebit_estimate" } }, "/v1/stock/eps-estimate": { "get": { "summary": "Get EPS Estimates", "description": "Retrieve analyst earnings per share (EPS) estimates including consensus forecasts, estimate ranges, and earnings growth projections.", "parameters": [ { "name": "symbol", "in": "query", "required": true, "schema": { "type": "string", "example": "AAPL" }, "description": "Stock ticker to query. Send the plain uppercase symbol exactly as you'd type it on a brokerage screen, e.g. `AAPL`, `MSFT`, `TSLA`." }, { "name": "freq", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/ReportingFrequency" }, "description": "(Optional) Frequency: annual, quarterly" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "epsEstimates": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "epsAvg": { "type": "number" }, "epsHigh": { "type": "number" }, "epsLow": { "type": "number" }, "numberAnalysts": { "type": "integer" }, "period": { "type": "string" }, "year": { "type": "integer" }, "quarter": { "type": "integer" } } } }, "symbol": { "type": "string" }, "freq": { "$ref": "#/components/schemas/ReportingFrequency" } } } } }, "examples": { "default": { "value": { "epsEstimates": { "data": [ { "epsAvg": 2.1215999126434326, "epsHigh": 2.309999942779541, "epsLow": 1.8717999458312988, "numberAnalysts": 6, "period": "2027-09-30", "year": 2027, "quarter": 4 }, { "epsAvg": 1.7481000423431396, "epsHigh": 1.850000023841858, "epsLow": 1.6100000143051147, "numberAnalysts": 6, "period": "2027-06-30", "year": 2027, "quarter": 3 }, { "epsAvg": 1.611199975013733, "epsHigh": 1.7200000286102295, "epsLow": 1.4600000381469727, "numberAnalysts": 6, "period": "2027-03-31", "year": 2027, "quarter": 2 } ], "symbol": "AAPL", "freq": "quarterly" } } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "security": [ { "OAuth2": [ "market:supplemental" ] } ], "tags": [ "Stock Estimates" ], "operationId": "get_v1_stock_eps_estimate" } }, "/v1/stock/earnings": { "get": { "summary": "Get Earnings Surprises", "description": "Retrieve historical earnings surprises comparing actual reported earnings to analyst estimates with surprise percentages.", "parameters": [ { "name": "symbol", "in": "query", "required": true, "schema": { "type": "string", "example": "AAPL" }, "description": "Stock ticker to query. Send the plain uppercase symbol exactly as you'd type it on a brokerage screen, e.g. `AAPL`, `MSFT`, `TSLA`." }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1 }, "description": "(Optional) Number of results to return" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "earningSurprises": { "type": "array", "items": { "type": "object", "properties": { "actual": { "type": "number" }, "estimate": { "type": "number" }, "period": { "type": "string" }, "quarter": { "type": "integer" }, "surprise": { "type": "number" }, "surprisePercent": { "type": "number" }, "symbol": { "type": "string" }, "year": { "type": "integer" } } } } } }, "examples": { "default": { "value": { "earningSurprises": [ { "actual": 1.850000023841858, "estimate": 1.8075000047683716, "period": "2025-09-30", "quarter": 4, "surprise": 0.042500000447034836, "surprisePercent": 2.351300001144409, "symbol": "AAPL", "year": 2025 } ] } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "security": [ { "OAuth2": [ "market:supplemental" ] } ], "tags": [ "Stock Estimates" ], "operationId": "get_v1_stock_earnings" } }, "/v1/stock/transcripts/list": { "get": { "summary": "Get Transcripts List", "description": "Retrieve a list of available earnings call transcripts for a symbol.", "parameters": [ { "name": "symbol", "in": "query", "required": true, "schema": { "type": "string", "example": "AAPL" }, "description": "Stock ticker to query. Send the plain uppercase symbol exactly as you'd type it on a brokerage screen, e.g. `AAPL`, `MSFT`." } ], "responses": { "200": { "description": "List of transcripts.", "content": { "application/json": { "schema": { "type": "object", "properties": { "symbol": { "type": "string" }, "transcripts": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "quarter": { "type": "integer" }, "time": { "type": "string" }, "title": { "type": "string" }, "year": { "type": "integer" } } } } } }, "example": { "symbol": "AAPL", "transcripts": [ { "id": "AAPL_3453142", "title": "AAPL - Earnings call Q1 2026", "time": "2026-01-29 22:01:04", "year": 2026, "quarter": 1 } ] } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "security": [ { "OAuth2": [ "market:supplemental" ] } ], "tags": [ "Stock Alternative" ], "operationId": "get_v1_stock_transcripts_list" } }, "/v1/stock/transcripts": { "get": { "summary": "Get Transcript by ID", "description": "Retrieve a single earnings call transcript by ID.", "parameters": [ { "name": "id", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Unique identifier for an earnings-call transcript. Obtain it from `/v1/stock/transcripts/list` for the symbol you want." } ], "responses": { "200": { "description": "Transcript content.", "content": { "application/json": { "schema": { "type": "object", "properties": { "audio": { "type": "string" }, "id": { "type": "string" }, "participant": { "type": "array", "items": { "type": "object", "properties": { "description": { "type": "string" }, "name": { "type": "string" }, "role": { "type": "string" } } } }, "quarter": { "type": "integer" }, "symbol": { "type": "string" }, "time": { "type": "string" }, "title": { "type": "string" }, "transcript": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "session": { "type": "string" }, "speech": { "type": "array", "items": { "type": "string" } } } } }, "year": { "type": "integer" } } }, "example": { "symbol": "AAPL", "transcript": [ { "name": "Operator", "speech": [ "Good day, everyone. Welcome to the Apple Incorporated First Quarter Fiscal Year 2020 Earnings Conference Call. Today's conference is being recorded.", "At this time for opening remarks and introductions, I would like to turn the call over to Tejas Gala, Senior Analyst, Corporate Finance and Investor Relations. Please go ahead." ], "session": "management_discussion" } ], "participant": [ { "name": "Tejas Gala", "description": "Senior Analyst, Corporate Finance and IR", "role": "executive" } ], "audio": "https://api.aries.com/v1/stock/media/presentation/api/redirect?urlType=transcripts-audio&id=AAPL_162777", "id": "AAPL_162777", "title": "AAPL - Earnings call Q1 2020", "time": "2020-01-29 02:36:41", "year": 2020, "quarter": 1 } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "security": [ { "OAuth2": [ "market:supplemental" ] } ], "tags": [ "Stock Alternative" ], "operationId": "get_v1_stock_transcripts" } }, "/v1/stock/earnings-call-live": { "get": { "summary": "Get Earnings Call Live", "description": "Retrieve live or upcoming earnings call information.", "parameters": [ { "name": "from", "in": "query", "required": false, "schema": { "type": "string", "format": "date" }, "description": "Start of the date window, inclusive. Format: `YYYY-MM-DD`." }, { "name": "to", "in": "query", "required": false, "schema": { "type": "string", "format": "date" }, "description": "End of the date window, inclusive. Format: `YYYY-MM-DD`." }, { "name": "symbol", "in": "query", "required": false, "schema": { "type": "string", "example": "AAPL" }, "description": "Stock ticker to query. Send the plain uppercase symbol, e.g. `AAPL`." } ], "responses": { "200": { "description": "Earnings call live data.", "content": { "application/json": { "schema": { "type": "object", "properties": { "event": { "type": "array", "items": { "type": "object", "properties": { "event": { "type": "string" }, "liveAudio": { "type": "string" }, "quarter": { "type": "integer" }, "recording": { "type": "string" }, "symbol": { "type": "string" }, "time": { "type": "string" }, "year": { "type": "integer" } } } } } }, "example": { "event": [ { "symbol": "LTRX", "event": "LTRX - Earnings call Q1 year", "time": "2024-11-07 23:30:00", "year": 2025, "quarter": 1, "liveAudio": "", "recording": "https://api.aries.com/v1/stock/media/recording/file/publicdatany/audio2/0bd25a9ed602ec35eee894fd900a8784f9cf4fe78de1232daa5e53c315acd76d.mp3" } ] } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "security": [ { "OAuth2": [ "market:supplemental" ] } ], "tags": [ "Stock Alternative" ], "operationId": "get_v1_stock_earnings_call_live" } }, "/v1/stock/presentation": { "get": { "summary": "Get Company Presentation", "description": "Retrieve company presentation materials for a symbol.", "parameters": [ { "name": "symbol", "in": "query", "required": true, "schema": { "type": "string", "example": "AAPL" }, "description": "Stock ticker to query. Send the plain uppercase symbol exactly as you'd type it on a brokerage screen, e.g. `AAPL`, `MSFT`." } ], "responses": { "200": { "description": "Company presentation.", "content": { "application/json": { "schema": { "type": "object", "properties": { "res": { "type": "array", "items": { "type": "object", "properties": { "atTime": { "type": "string" }, "quarter": { "type": "integer" }, "title": { "type": "string" }, "url": { "type": "string" }, "year": { "type": "integer" } } } }, "symbol": { "type": "string" } } }, "example": { "symbol": "AAPL", "res": [ { "quarter": 1, "year": 2016, "url": "https://api.aries.com/v1/stock/media/presentation/api/redirect?urlType=transcripts-slides2&id=c5aff8a57185771c8651a3e94520aad3190753a475e80e683ce0746d4ee48152", "title": "AAPL Q1 2016", "atTime": "2016-01-26 22:00:00" } ] } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "security": [ { "OAuth2": [ "market:supplemental" ] } ], "tags": [ "Stock Alternative" ], "operationId": "get_v1_stock_presentation" } }, "/v1/stock/social-sentiment": { "get": { "summary": "Get Social Sentiment", "description": "Retrieve social media sentiment metrics for a symbol.", "parameters": [ { "name": "symbol", "in": "query", "required": true, "schema": { "type": "string", "example": "AAPL" }, "description": "Stock ticker to query. Send the plain uppercase symbol exactly as you'd type it on a brokerage screen, e.g. `AAPL`, `MSFT`." }, { "name": "from", "in": "query", "required": false, "schema": { "type": "string", "format": "date" }, "description": "Start of the date window, inclusive. Format: `YYYY-MM-DD` (e.g. `2024-01-01`)." }, { "name": "to", "in": "query", "required": false, "schema": { "type": "string", "format": "date" }, "description": "End of the date window, inclusive. Format: `YYYY-MM-DD` (e.g. `2024-12-31`)." } ], "responses": { "200": { "description": "Social sentiment data.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "atTime": { "type": "string" }, "mention": { "type": "integer" }, "negativeMention": { "type": "integer" }, "negativeScore": { "type": "number" }, "positiveMention": { "type": "integer" }, "positiveScore": { "type": "number" }, "score": { "type": "number" } } } }, "symbol": { "type": "string" } } }, "example": { "symbol": "AAPL", "data": [ { "mention": 29, "positiveMention": 8, "negativeMention": 17, "positiveScore": 0.0312, "negativeScore": -0.0588, "score": -0.6, "atTime": "2026-03-09 14:00:00" } ] } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "security": [ { "OAuth2": [ "market:supplemental" ] } ], "tags": [ "Stock Alternative" ], "operationId": "get_v1_stock_social_sentiment" } }, "/v1/stock/investment-theme": { "get": { "summary": "Get Investment Theme", "description": "Retrieve investment theme data by theme name.", "parameters": [ { "name": "theme", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/InvestmentThemeId" }, "description": "investment theme identifier. Use the Try it dropdown or the supported values list on the reference page." } ], "responses": { "200": { "description": "Investment theme data.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "symbol": { "type": "string" } } } }, "theme": { "$ref": "#/components/schemas/InvestmentThemeId" } } }, "example": { "theme": "financialExchangesData", "data": [ { "symbol": "MCO" } ] } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "security": [ { "OAuth2": [ "market:supplemental" ] } ], "tags": [ "Stock Alternative" ], "operationId": "get_v1_stock_investment_theme" } }, "/v1/stock/supply-chain": { "get": { "summary": "Get Supply Chain", "description": "Retrieve supply chain data for a symbol.", "parameters": [ { "name": "symbol", "in": "query", "required": true, "schema": { "type": "string", "example": "AAPL" }, "description": "Stock ticker to query. Send the plain uppercase symbol exactly as you'd type it on a brokerage screen, e.g. `AAPL`, `MSFT`." } ], "responses": { "200": { "description": "Supply chain data.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "country": { "type": "string" }, "customer": { "type": "boolean" }, "industry": { "type": "string" }, "name": { "type": "string" }, "oneMonthCorrelation": { "type": "number" }, "oneYearCorrelation": { "type": "number" }, "sixMonthCorrelation": { "type": "number" }, "supplier": { "type": "boolean" }, "symbol": { "type": "string" }, "threeMonthCorrelation": { "type": "number" }, "twoWeekCorrelation": { "type": "number" }, "twoYearCorrelation": { "type": "number" } } } }, "symbol": { "type": "string" } } }, "example": { "symbol": "AAPL", "data": [ { "symbol": "AAPL", "name": "Xperi Corp.", "country": "US", "industry": "Technology", "customer": true, "supplier": true, "oneMonthCorrelation": 0.35, "oneYearCorrelation": 0.35, "sixMonthCorrelation": 0.35, "threeMonthCorrelation": 0.35, "twoWeekCorrelation": 0.35, "twoYearCorrelation": 0.35 } ] } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "security": [ { "OAuth2": [ "market:supplemental" ] } ], "tags": [ "Stock Alternative" ], "operationId": "get_v1_stock_supply_chain" } }, "/v1/stock/esg": { "get": { "summary": "Get Company ESG", "description": "Retrieve environmental, social, and governance (ESG) data for a company.", "parameters": [ { "name": "symbol", "in": "query", "required": true, "schema": { "type": "string", "example": "AAPL" }, "description": "Stock ticker to query. Send the plain uppercase symbol exactly as you'd type it on a brokerage screen, e.g. `AAPL`, `MSFT`." } ], "responses": { "200": { "description": "Company ESG data.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "adultContent": { "type": "boolean" }, "alcoholic": { "type": "boolean" }, "animalTesting": { "type": "boolean" }, "antitrust": { "type": "string" }, "asianEmployeePercentage": { "type": "number" }, "asianManagementPercentage": { "type": "number" }, "blackEmployeePercentage": { "type": "number" }, "blackManagementPercentage": { "type": "number" }, "carbonReductionPolicy": { "type": "string" }, "catholic": { "type": "boolean" }, "co2EmissionScope1": { "type": "integer" }, "co2EmissionScope2": { "type": "integer" }, "co2EmissionScope3": { "type": "integer" }, "co2EmissionTotal": { "type": "integer" }, "coalEnergy": { "type": "boolean" }, "ecofriendlyPackaging": { "type": "boolean" }, "environmentalReporting": { "type": "boolean" }, "firearms": { "type": "boolean" }, "fuelEfficiencyConsumption": { "type": "boolean" }, "gambling": { "type": "boolean" }, "gmo": { "type": "boolean" }, "hazardousSubstances": { "type": "boolean" }, "hispanicLatinoEmployeePercentage": { "type": "number" }, "hispanicLatinoManagementPercentage": { "type": "number" }, "humanRightsPolicy": { "type": "boolean" }, "militaryContract": { "type": "boolean" }, "nuclear": { "type": "boolean" }, "pesticides": { "nullable": true, "type": "string" }, "recallPolicySafety": { "type": "boolean" }, "recyclingPolicy": { "type": "boolean" }, "stakeholderEngagement": { "type": "boolean" }, "tobacco": { "type": "boolean" }, "totalWomenPercentage": { "type": "integer" }, "waterEfficiencyConsumption": { "type": "boolean" }, "whiteEmployeePercentage": { "type": "number" }, "whiteManagementPercentage": { "type": "number" }, "workplaceHealthSafety": { "type": "boolean" } } }, "environmentScore": { "type": "number" }, "governanceScore": { "type": "number" }, "socialScore": { "type": "number" }, "symbol": { "type": "string" }, "totalESGScore": { "type": "number" } } }, "example": { "symbol": "AAPL", "totalESGScore": 70.26119, "environmentScore": 61.893806, "governanceScore": 87.10112, "socialScore": 61.788643, "data": { "adultContent": false, "alcoholic": false, "animalTesting": false, "antitrust": "14", "asianEmployeePercentage": 33.22, "asianManagementPercentage": 34.95, "blackEmployeePercentage": 8.1, "blackManagementPercentage": 3.4, "carbonReductionPolicy": "True", "catholic": true, "co2EmissionScope1": 55200, "co2EmissionScope2": 1224500, "co2EmissionScope3": 15070900, "co2EmissionTotal": 1279700, "coalEnergy": false, "ecofriendlyPackaging": true, "environmentalReporting": true, "firearms": false, "fuelEfficiencyConsumption": false, "gambling": false, "gmo": false, "hazardousSubstances": true, "hispanicLatinoEmployeePercentage": 14.27, "hispanicLatinoManagementPercentage": 7.55, "humanRightsPolicy": true, "militaryContract": false, "nuclear": false, "pesticides": null, "recallPolicySafety": false, "recyclingPolicy": true, "stakeholderEngagement": true, "tobacco": false, "totalWomenPercentage": 35, "waterEfficiencyConsumption": true, "whiteEmployeePercentage": 40.54, "whiteManagementPercentage": 51.31, "workplaceHealthSafety": true } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "security": [ { "OAuth2": [ "market:supplemental" ] } ], "tags": [ "Stock Alternative" ], "operationId": "get_v1_stock_esg" } }, "/v1/stock/historical-esg": { "get": { "summary": "Get Historical ESG", "description": "Retrieve historical environmental, social, and governance (ESG) data for a company over time.", "parameters": [ { "name": "symbol", "in": "query", "required": true, "schema": { "type": "string", "example": "AAPL" }, "description": "Stock ticker to query. Send the plain uppercase symbol exactly as you'd type it on a brokerage screen, e.g. `AAPL`, `MSFT`." } ], "responses": { "200": { "description": "Historical ESG data.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "data": { "type": "object", "properties": { "adultContent": { "type": "boolean" }, "alcoholic": { "type": "boolean" }, "animalTesting": { "type": "boolean" }, "antitrust": { "type": "string" }, "asianEmployeePercentage": { "type": "number" }, "asianManagementPercentage": { "type": "number" }, "blackEmployeePercentage": { "type": "number" }, "blackManagementPercentage": { "type": "number" }, "carbonReductionPolicy": { "type": "string" }, "catholic": { "type": "boolean" }, "co2EmissionScope1": { "type": "integer" }, "co2EmissionScope2": { "type": "integer" }, "co2EmissionScope3": { "type": "integer" }, "co2EmissionTotal": { "type": "integer" }, "coalEnergy": { "type": "boolean" }, "ecofriendlyPackaging": { "type": "boolean" }, "environmentalReporting": { "type": "boolean" }, "firearms": { "type": "boolean" }, "fuelEfficiencyConsumption": { "type": "boolean" }, "gambling": { "type": "boolean" }, "gmo": { "type": "boolean" }, "hazardousSubstances": { "type": "boolean" }, "hispanicLatinoEmployeePercentage": { "type": "number" }, "hispanicLatinoManagementPercentage": { "type": "number" }, "humanRightsPolicy": { "type": "boolean" }, "militaryContract": { "type": "boolean" }, "nuclear": { "type": "boolean" }, "pesticides": { "nullable": true, "type": "string" }, "recallPolicySafety": { "type": "boolean" }, "recyclingPolicy": { "type": "boolean" }, "stakeholderEngagement": { "type": "boolean" }, "tobacco": { "type": "boolean" }, "totalWomenPercentage": { "type": "integer" }, "waterEfficiencyConsumption": { "type": "boolean" }, "whiteEmployeePercentage": { "type": "number" }, "whiteManagementPercentage": { "type": "number" }, "workplaceHealthSafety": { "type": "boolean" } } }, "environmentScore": { "type": "number" }, "governanceScore": { "type": "number" }, "period": { "type": "string" }, "socialScore": { "type": "number" }, "totalESGScore": { "type": "number" } } } }, "symbol": { "type": "string" } } }, "example": { "symbol": "AAPL", "data": [ { "totalESGScore": 70.26119, "environmentScore": 61.893806, "governanceScore": 87.10112, "socialScore": 61.788643, "data": { "adultContent": false, "alcoholic": false, "animalTesting": false, "antitrust": "14", "asianEmployeePercentage": 33.22, "asianManagementPercentage": 34.95, "blackEmployeePercentage": 8.1, "blackManagementPercentage": 3.4, "carbonReductionPolicy": "True", "catholic": true, "co2EmissionScope1": 55200, "co2EmissionScope2": 1224500, "co2EmissionScope3": 15070900, "co2EmissionTotal": 1279700, "coalEnergy": false, "ecofriendlyPackaging": true, "environmentalReporting": true, "firearms": false, "fuelEfficiencyConsumption": false, "gambling": false, "gmo": false, "hazardousSubstances": true, "hispanicLatinoEmployeePercentage": 14.27, "hispanicLatinoManagementPercentage": 7.55, "humanRightsPolicy": true, "militaryContract": false, "nuclear": false, "pesticides": null, "recallPolicySafety": false, "recyclingPolicy": true, "stakeholderEngagement": true, "tobacco": false, "totalWomenPercentage": 35, "waterEfficiencyConsumption": true, "whiteEmployeePercentage": 40.54, "whiteManagementPercentage": 51.31, "workplaceHealthSafety": true }, "period": "2024-09-28" } ] } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "security": [ { "OAuth2": [ "market:supplemental" ] } ], "tags": [ "Stock Alternative" ], "operationId": "get_v1_stock_historical_esg" } }, "/v1/stock/earnings-quality-score": { "get": { "summary": "Get Earnings Quality Score", "description": "Retrieve earnings quality score metrics for a company (annual or quarterly).", "parameters": [ { "name": "symbol", "in": "query", "required": true, "schema": { "type": "string", "example": "AAPL" }, "description": "Stock ticker to query. Send the plain uppercase symbol exactly as you'd type it on a brokerage screen, e.g. `AAPL`, `MSFT`." }, { "name": "freq", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/ReportingFrequency" }, "description": "How often the score is computed. Allowed values:\n- `annual` — one score per fiscal year (broad trends).\n- `quarterly` — one score per quarter (closer to recent reporting)." } ], "responses": { "200": { "description": "Earnings quality score data.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "cashGenerationCapitalAllocation": { "type": "number" }, "growth": { "type": "number" }, "letterScore": { "type": "string" }, "leverage": { "type": "number" }, "period": { "type": "string" }, "profitability": { "type": "number" }, "score": { "type": "number" } } } }, "freq": { "$ref": "#/components/schemas/ReportingFrequency" }, "symbol": { "type": "string" } } }, "example": { "symbol": "F", "freq": "quarterly", "data": [ { "period": "2025-12-31", "growth": 92.320305, "profitability": 76.634964, "cashGenerationCapitalAllocation": 43.21394, "leverage": 100, "score": 78.042305, "letterScore": "A" } ] } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "security": [ { "OAuth2": [ "market:supplemental" ] } ], "tags": [ "Stock Alternative" ], "operationId": "get_v1_stock_earnings_quality_score" } }, "/v1/stock/covid19/us": { "get": { "summary": "Get COVID-19 US", "description": "Retrieve COVID-19 US data.", "parameters": [], "responses": { "200": { "description": "COVID-19 US data.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "case": { "type": "number" }, "death": { "type": "number" }, "state": { "type": "string" }, "updated": { "type": "string" } } } } } }, "example": { "data": [ { "state": "California", "case": 12711918, "death": 112443, "updated": "2024-11-18 18:02:03" } ] } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "security": [ { "OAuth2": [ "market:supplemental" ] } ], "tags": [ "Stock Alternative" ], "operationId": "get_v1_stock_covid19_us" } }, "/v1/stock/fda-advisory-committee-calendar": { "get": { "summary": "Get FDA Advisory Committee Calendar", "description": "Retrieve FDA advisory committee meeting calendar.", "parameters": [], "responses": { "200": { "description": "FDA advisory committee calendar.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "eventDescription": { "type": "string" }, "fromDate": { "type": "string" }, "toDate": { "type": "string" }, "url": { "type": "string" } } } } } }, "example": { "data": [ { "fromDate": "2026-03-12 09:00:00", "toDate": "2026-03-12 15:30:00", "eventDescription": "Vaccines and Related Biological Products Advisory Committee March 12, 2026 Meeting Announcement - 03/12/2026", "url": "https://www.fda.gov/advisory-committees/advisory-committee-calendar/vaccines-and-related-biological-products-advisory-committee-march-12-2026-meeting-announcement" } ] } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "security": [ { "OAuth2": [ "market:supplemental" ] } ], "tags": [ "Stock Alternative" ], "operationId": "get_v1_stock_fda_advisory_committee_calendar" } }, "/v1/stock/uspto-patent": { "get": { "summary": "Get USPTO Patent", "description": "Retrieve USPTO patent data for a symbol within a date range.", "parameters": [ { "name": "symbol", "in": "query", "required": true, "schema": { "type": "string", "example": "AAPL" }, "description": "Stock ticker to query. Send the plain uppercase symbol exactly as you'd type it on a brokerage screen, e.g. `AAPL`, `MSFT`." }, { "name": "from", "in": "query", "required": true, "schema": { "type": "string", "format": "date", "example": "2024-01-01" }, "description": "Start of the date window, inclusive. Format: `YYYY-MM-DD` (e.g. `2024-01-01`)." }, { "name": "to", "in": "query", "required": true, "schema": { "type": "string", "format": "date", "example": "2024-12-31" }, "description": "End of the date window, inclusive. Format: `YYYY-MM-DD` (e.g. `2024-12-31`)." } ], "responses": { "200": { "description": "USPTO patent data.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "applicationNumber": { "type": "string" }, "companyFilingName": { "type": "array", "items": { "type": "string" } }, "description": { "type": "string" }, "filingDate": { "type": "string" }, "filingStatus": { "type": "string" }, "patentNumber": { "type": "string" }, "patentType": { "type": "string" }, "publicationDate": { "type": "string" }, "url": { "type": "string" } } } }, "symbol": { "type": "string" } } }, "example": { "symbol": "NVDA", "data": [ { "applicationNumber": "17565837", "companyFilingName": [ "NVIDIA CORPORATION" ], "filingDate": "2021-12-30 00:00:00", "description": "OBSTACLE TO PATH ASSIGNMENT FOR AUTONOMOUS SYSTEMS AND APPLICATIONS", "filingStatus": "Application", "patentNumber": "US20230213945A1", "publicationDate": "2023-07-06 00:00:00", "patentType": "Utility", "url": "" } ] } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "security": [ { "OAuth2": [ "market:supplemental" ] } ], "tags": [ "Stock Alternative" ], "operationId": "get_v1_stock_uspto_patent" } }, "/v1/stock/visa-application": { "get": { "summary": "Get Visa Application (H1-B)", "description": "Retrieve H1-B visa application data for a symbol within a date range.", "parameters": [ { "name": "symbol", "in": "query", "required": true, "schema": { "type": "string", "example": "AAPL" }, "description": "Stock ticker to query. Send the plain uppercase symbol exactly as you'd type it on a brokerage screen, e.g. `AAPL`, `MSFT`." }, { "name": "from", "in": "query", "required": true, "schema": { "type": "string", "format": "date", "example": "2024-01-01" }, "description": "Start of the date window, inclusive. Format: `YYYY-MM-DD` (e.g. `2024-01-01`)." }, { "name": "to", "in": "query", "required": true, "schema": { "type": "string", "format": "date", "example": "2024-12-31" }, "description": "End of the date window, inclusive. Format: `YYYY-MM-DD` (e.g. `2024-12-31`)." } ], "responses": { "200": { "description": "Visa application data.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "beginDate": { "type": "string" }, "caseNumber": { "type": "string" }, "caseStatus": { "type": "string" }, "employerName": { "type": "string" }, "endDate": { "type": "string" }, "fullTimePosition": { "type": "string" }, "h1bDependent": { "type": "string" }, "jobTitle": { "type": "string" }, "quarter": { "type": "integer" }, "receivedDate": { "type": "string" }, "socCode": { "type": "string" }, "symbol": { "type": "string" }, "visaClass": { "type": "string" }, "wageLevel": { "type": "string" }, "wageRangeFrom": { "type": "number" }, "wageRangeTo": { "type": "number" }, "wageUnitOfPay": { "type": "string" }, "worksiteAddress": { "type": "string" }, "worksiteCity": { "type": "string" }, "worksiteCounty": { "type": "string" }, "worksitePostalCode": { "type": "string" }, "worksiteState": { "type": "string" }, "year": { "type": "integer" } } } }, "symbol": { "type": "string" } } }, "example": { "symbol": "AAPL", "data": [ { "year": 2022, "quarter": 1, "symbol": "AAPL", "caseNumber": "I-200-21364-792636", "caseStatus": "Certified", "receivedDate": "2021-12-29", "visaClass": "H-1B", "jobTitle": "Acoustics Engineer", "socCode": "17-2141.00", "fullTimePosition": "Y", "beginDate": "2021-12-31", "endDate": "2024-12-30", "employerName": "Apple Inc.", "worksiteAddress": "One Apple Park Way", "worksiteCity": "Cupertino", "worksiteCounty": "SANTA CLARA", "worksiteState": "CA", "worksitePostalCode": "95014", "wageRangeFrom": 165000, "wageRangeTo": 185000, "wageUnitOfPay": "Year", "wageLevel": "III", "h1bDependent": "No" } ] } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "security": [ { "OAuth2": [ "market:supplemental" ] } ], "tags": [ "Stock Alternative" ], "operationId": "get_v1_stock_visa_application" } }, "/v1/stock/lobbying": { "get": { "summary": "Get Lobbying", "description": "Retrieve lobbying data for a symbol within a date range.", "parameters": [ { "name": "symbol", "in": "query", "required": true, "schema": { "type": "string", "example": "AAPL" }, "description": "Stock ticker to query. Send the plain uppercase symbol exactly as you'd type it on a brokerage screen, e.g. `AAPL`, `MSFT`." }, { "name": "from", "in": "query", "required": true, "schema": { "type": "string", "format": "date", "example": "2024-01-01" }, "description": "Start of the date window, inclusive. Format: `YYYY-MM-DD` (e.g. `2024-01-01`)." }, { "name": "to", "in": "query", "required": true, "schema": { "type": "string", "format": "date", "example": "2024-12-31" }, "description": "End of the date window, inclusive. Format: `YYYY-MM-DD` (e.g. `2024-12-31`)." } ], "responses": { "200": { "description": "Lobbying data.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "clientId": { "type": "string" }, "country": { "type": "string" }, "date": { "type": "string" }, "description": { "type": "string" }, "documentUrl": { "type": "string" }, "expenses": { "type": "number" }, "houseregistrantId": { "type": "string" }, "income": { "type": "number" }, "name": { "type": "string" }, "period": { "type": "string" }, "postedName": { "type": "string" }, "registrantId": { "type": "string" }, "senateId": { "type": "string" }, "symbol": { "type": "string" }, "year": { "type": "integer" } } } }, "symbol": { "type": "string" } } }, "example": { "symbol": "AAPL", "data": [ { "symbol": "AAPL", "name": "APPLE INC", "description": "", "country": "US", "year": 2020, "period": "Q4", "income": 500000, "expenses": 1450000, "documentUrl": "https://lda.senate.gov/filings/public/filing/cad6db2f-c3ca-4b9d-bc24-4c56fc7eaadb/print/", "postedName": "", "date": "", "clientId": "103979", "registrantId": "4152", "senateId": "4152-103979", "houseregistrantId": "31450" } ] } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "security": [ { "OAuth2": [ "market:supplemental" ] } ], "tags": [ "Stock Alternative" ], "operationId": "get_v1_stock_lobbying" } }, "/v1/stock/usa-spending": { "get": { "summary": "Get USA Spending", "description": "Retrieve USA spending data for a symbol within a date range.", "parameters": [ { "name": "symbol", "in": "query", "required": true, "schema": { "type": "string", "example": "AAPL" }, "description": "Stock ticker to query. Send the plain uppercase symbol exactly as you'd type it on a brokerage screen, e.g. `AAPL`, `MSFT`." }, { "name": "from", "in": "query", "required": true, "schema": { "type": "string", "format": "date", "example": "2024-01-01" }, "description": "Start of the date window, inclusive. Format: `YYYY-MM-DD` (e.g. `2024-01-01`)." }, { "name": "to", "in": "query", "required": true, "schema": { "type": "string", "format": "date", "example": "2024-12-31" }, "description": "End of the date window, inclusive. Format: `YYYY-MM-DD` (e.g. `2024-12-31`)." } ], "responses": { "200": { "description": "USA spending data.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "actionDate": { "type": "string" }, "awardDescription": { "type": "string" }, "awardingAgencyName": { "type": "string" }, "awardingOfficeName": { "type": "string" }, "awardingSubAgencyName": { "type": "string" }, "country": { "type": "string" }, "naicsCode": { "type": "string" }, "performanceCity": { "type": "string" }, "performanceCongressionalDistrict": { "type": "string" }, "performanceCountry": { "type": "string" }, "performanceCounty": { "type": "string" }, "performanceEndDate": { "type": "string" }, "performanceStartDate": { "type": "string" }, "performanceState": { "type": "string" }, "performanceZipCode": { "type": "string" }, "permalink": { "type": "string" }, "recipientName": { "type": "string" }, "recipientParentName": { "type": "string" }, "symbol": { "type": "string" }, "totalValue": { "type": "number" } } } }, "symbol": { "type": "string" } } }, "example": { "symbol": "AAPL", "data": [ { "symbol": "AAPL", "recipientName": "APPLE INC.", "recipientParentName": "APPLE INC.", "awardDescription": "MACBOOK PRO", "country": "USA", "actionDate": "2021-11-12", "totalValue": 4238, "performanceStartDate": "2021-11-12", "performanceEndDate": "2021-12-10", "awardingAgencyName": "SMITHSONIAN INSTITUTION (SI)", "awardingSubAgencyName": "SMITHSONIAN INSTITUTION", "awardingOfficeName": "SMITHSONIAN ASTROPHYSICAL OBSERVATORY", "performanceCountry": "USA", "performanceCity": "CUPERTINO", "performanceCounty": "SANTA CLARA", "performanceState": "CALIFORNIA", "performanceZipCode": "950140642", "performanceCongressionalDistrict": "17", "naicsCode": "334111", "permalink": "https://www.usaspending.gov/award/CONT_AWD_33131222P00465925_3300_-NONE-_-NONE-/" } ] } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "security": [ { "OAuth2": [ "market:supplemental" ] } ], "tags": [ "Stock Alternative" ], "operationId": "get_v1_stock_usa_spending" } }, "/v1/stock/congressional-trading": { "get": { "summary": "Get Congressional Trading", "description": "Retrieve congressional trading data for a symbol within a date range.", "parameters": [ { "name": "symbol", "in": "query", "required": true, "schema": { "type": "string", "example": "AAPL" }, "description": "Stock ticker to query. Send the plain uppercase symbol exactly as you'd type it on a brokerage screen, e.g. `AAPL`, `MSFT`." }, { "name": "from", "in": "query", "required": true, "schema": { "type": "string", "format": "date", "example": "2024-01-01" }, "description": "Start of the date window, inclusive. Format: `YYYY-MM-DD` (e.g. `2024-01-01`)." }, { "name": "to", "in": "query", "required": true, "schema": { "type": "string", "format": "date", "example": "2024-12-31" }, "description": "End of the date window, inclusive. Format: `YYYY-MM-DD` (e.g. `2024-12-31`)." } ], "responses": { "200": { "description": "Congressional trading data.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "amountFrom": { "type": "number" }, "amountTo": { "type": "number" }, "assetName": { "type": "string" }, "filingDate": { "type": "string" }, "name": { "type": "string" }, "ownerType": { "type": "string" }, "position": { "type": "string" }, "symbol": { "type": "string" }, "transactionDate": { "type": "string" }, "transactionType": { "type": "string" } } } }, "symbol": { "type": "string" } } }, "example": { "symbol": "MLPTX", "data": [ { "amountFrom": 100001, "amountTo": 250000, "assetName": "Oppenheimer SteelPath MLP Select 40 Y (NASDAQ)", "filingDate": "2015-05-14", "name": "Lamar Alexander", "ownerType": "Spouse", "position": "senator", "symbol": "MLPTX", "transactionDate": "2014-04-04", "transactionType": "Purchase" } ] } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "security": [ { "OAuth2": [ "market:supplemental" ] } ], "tags": [ "Stock Alternative" ], "operationId": "get_v1_stock_congressional_trading" } }, "/v1/stock/bank-branch": { "get": { "summary": "Get Bank Branch", "description": "Retrieve bank branch data for a symbol.", "parameters": [ { "name": "symbol", "in": "query", "required": true, "schema": { "type": "string", "example": "AAPL" }, "description": "Stock ticker to query. Send the plain uppercase symbol exactly as you'd type it on a brokerage screen, e.g. `AAPL`, `MSFT`." } ], "responses": { "200": { "description": "Bank branch data.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "address": { "type": "string" }, "branchId": { "type": "string" }, "date": { "type": "string" }, "state": { "type": "string" }, "zipCode": { "type": "string" } } } }, "symbol": { "type": "string" } } }, "example": { "data": [ { "branchId": "201601", "address": "1910 E 95th St", "state": "IL", "zipCode": "60617", "date": "2000-02-28" } ], "symbol": "JPM" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "security": [ { "OAuth2": [ "market:supplemental" ] } ], "tags": [ "Stock Alternative" ], "operationId": "get_v1_stock_bank_branch" } }, "/v1/stock/split": { "get": { "summary": "Get Stock Split History", "description": "Retrieve historical stock split events including split ratios, execution dates, and pre/post-split price adjustments. `ticker` accepts a single symbol only. Use `tickersAnyOf` for multiple symbols. If `ticker` contains multiple comma-separated values, the API returns 400: \"Multiple tickers are not supported. Please provide a single ticker.\" If both `ticker` and `tickersAnyOf` are set, the API returns 400: \"Cannot specify both ticker and tickersAnyOf. Use ticker for a single symbol or tickersAnyOf for multiple.\"", "parameters": [ { "name": "ticker", "in": "query", "description": "Single ticker symbol only, such as AAPL. Do not send a comma-separated list here; if you need multiple symbols, use `tickersAnyOf` instead.", "required": false, "schema": { "type": "string", "example": "AAPL" } }, { "name": "tickersAnyOf", "in": "query", "description": "Comma-separated list of ticker symbols.", "required": false, "schema": { "type": "string", "example": "AAPL,TSLA,NVDA" } }, { "name": "tickerFrom", "in": "query", "description": "Filter tickers >= this value (inclusive)", "required": false, "schema": { "type": "string", "example": "A" } }, { "name": "tickerAfter", "in": "query", "description": "Filter tickers > this value (exclusive)", "required": false, "schema": { "type": "string", "example": "A" } }, { "name": "tickerTo", "in": "query", "description": "Filter tickers <= this value (inclusive)", "required": false, "schema": { "type": "string", "example": "Z" } }, { "name": "tickerBefore", "in": "query", "description": "Filter tickers < this value (exclusive)", "required": false, "schema": { "type": "string", "example": "Z" } }, { "name": "executionDate", "in": "query", "description": "Exact execution date in YYYY-MM-DD format", "required": false, "schema": { "type": "string", "format": "date", "example": "2020-08-31" } }, { "name": "executionDateFrom", "in": "query", "description": "Filter to splits that executed on or after this date (inclusive). Format: `YYYY-MM-DD`.", "required": false, "schema": { "type": "string", "format": "date", "example": "2020-01-01" } }, { "name": "executionDateAfter", "in": "query", "description": "Filter to splits that executed strictly after this date (exclusive). Format: `YYYY-MM-DD`.", "required": false, "schema": { "type": "string", "format": "date", "example": "2020-01-01" } }, { "name": "executionDateTo", "in": "query", "description": "Filter to splits that executed on or before this date (inclusive). Format: `YYYY-MM-DD`.", "required": false, "schema": { "type": "string", "format": "date", "example": "2024-12-31" } }, { "name": "executionDateBefore", "in": "query", "description": "Filter to splits that executed strictly before this date (exclusive). Format: `YYYY-MM-DD`.", "required": false, "schema": { "type": "string", "format": "date", "example": "2024-12-31" } }, { "name": "adjustmentType", "in": "query", "description": "Exact type: forward_split, reverse_split, stock_dividend", "required": false, "schema": { "type": "string", "enum": [ "forward_split", "reverse_split", "stock_dividend" ], "example": "forward_split" } }, { "name": "adjustmentTypes", "in": "query", "description": "Comma-separated list of adjustment types", "required": false, "schema": { "type": "string", "example": "forward_split,reverse_split" } }, { "name": "limit", "in": "query", "description": "Maximum number of results to return. Range: 1 to 5000. Use smaller values for UI pages, larger for batch exports.", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 5000, "example": 100 } }, { "name": "sort", "in": "query", "description": "A comma-separated list of sort columns. For each column, append `.asc` or `.desc` to specify direction. Defaults to `ticker.asc` when not specified. Examples: `execution_date.desc` or `ticker.asc,execution_date.desc`.", "required": false, "schema": { "type": "string" } }, { "name": "next", "in": "query", "description": "Pagination cursor from previous response", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "results": { "type": "array", "description": "Array of stock split events", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Stock split event identifier" }, "ticker": { "type": "string", "description": "Stock ticker symbol, such as AAPL. Use the exact ticker for the company you want to research." }, "executionDate": { "type": "string", "format": "date", "description": "Execution date of the split in YYYY-MM-DD format" }, "splitFrom": { "type": "number", "format": "double", "description": "The pre-split factor in the split ratio" }, "splitTo": { "type": "number", "format": "double", "description": "The post-split factor in the split ratio" }, "adjustmentType": { "type": "string", "description": "Type of stock split adjustment", "enum": [ "forward_split", "reverse_split", "stock_dividend" ] }, "historicalAdjustmentFactor": { "type": "number", "format": "double", "description": "Factor used to adjust historical prices" } }, "required": [ "ticker", "executionDate", "splitFrom", "splitTo" ] } }, "nextUrl": { "type": "string", "description": "Pagination URL for the next page, when available" }, "requestId": { "type": "string", "description": "Provider request identifier, when available" }, "status": { "type": "string", "description": "Status string from the upstream data provider — typically `OK` for a successful response. Treat any other value as an error indicator alongside the HTTP status code.", "example": "OK" } }, "required": [ "results", "status" ] }, "examples": { "default": { "value": { "results": [ { "id": "E987D589F61E7FAE48774F7C79B0E801", "ticker": "AAPL", "executionDate": "2020-08-31", "splitFrom": 1, "splitTo": 4, "adjustmentType": "forward_split", "historicalAdjustmentFactor": 0.25 } ], "status": "OK", "requestId": "a47d1beb8c11b6ae897ab76a1b095d8d" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "security": [ { "OAuth2": [ "market:supplemental" ] } ], "tags": [ "Corporate Actions" ], "operationId": "get_v1_stock_split" } }, "/v1/stocks/aggs": { "get": { "summary": "Get Aggregate Bars", "description": "Get aggregate bars for a stock over a time range with customizable time spans (second, minute, hour, day, week, month, quarter, year).", "tags": [ "Stocks" ], "parameters": [ { "name": "ticker", "in": "query", "required": true, "schema": { "type": "string", "example": "AAPL" }, "description": "Stock ticker symbol, such as AAPL. Use the exact ticker for the company you want to research." }, { "name": "multiplier", "in": "query", "required": true, "schema": { "type": "integer", "minimum": 1, "example": 1 }, "description": "Size of each aggregate time window. Enter 1 or greater, such as 1 day or 5 minutes depending on `timespan`." }, { "name": "timespan", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "second", "minute", "hour", "day", "week", "month", "quarter", "year" ], "example": "day" }, "description": "Time span unit for each aggregate bar, such as minute, hour, day, week, month, quarter, or year when supported." }, { "name": "from", "in": "query", "required": true, "schema": { "type": "string", "example": "2024-01-01" }, "description": "Start date in YYYY-MM-DD format. Enter the first date to include in the research window. or timestamp" }, { "name": "to", "in": "query", "required": true, "schema": { "type": "string", "example": "2024-01-31" }, "description": "End date in YYYY-MM-DD format. Enter the last date to include in the research window. or timestamp" }, { "name": "adjusted", "in": "query", "required": false, "schema": { "type": "boolean", "example": true }, "description": "Whether to adjust historical prices for stock splits. Use true for normalized charting and false for raw market data." }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "asc", "desc" ] }, "description": "Sort direction for aggregate bars. Use `asc` for oldest first or `desc` for newest first." }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 50000, "example": 1000 }, "description": "Maximum number of results to return. Use smaller values for UI pages and larger values for exports within API limits." }, { "name": "next", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Pagination cursor from the previous response. Omit it on the first request, then send the returned cursor to fetch the next page." } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "adjusted": { "type": "boolean", "description": "Whether or not the results are adjusted for splits" }, "queryCount": { "type": "integer", "description": "Number of results returned" }, "requestId": { "type": "string", "description": "Unique request ID" }, "results": { "type": "array", "description": "Array of aggregate bars", "items": { "$ref": "#/components/schemas/StockOhlcBar" } }, "resultsCount": { "type": "integer", "description": "Total number of results" }, "status": { "type": "string", "description": "Status string from the upstream data provider — typically `OK` for a successful response. Treat any other value as an error indicator alongside the HTTP status code." }, "ticker": { "type": "string", "description": "Stock ticker symbol, such as AAPL. Use the exact ticker for the company you want to research." }, "nextUrl": { "type": "string", "description": "URL for next page of results" } } }, "example": { "adjusted": true, "queryCount": 21, "requestId": "633a048bfb27b7a72181b65f0bb88cb0", "results": [ { "c": 185.64, "h": 188.44, "l": 183.885, "n": 1008871, "o": 187.15, "t": 1704171600000, "v": 81964874, "vw": 185.9465 }, { "c": 184.4, "h": 187.095, "l": 184.35, "n": 679844, "o": 187.04, "t": 1706677200000, "v": 55467803, "vw": 185.3525 } ], "resultsCount": 21, "status": "OK", "ticker": "AAPL" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "security": [ { "OAuth2": [ "market:supplemental" ] } ], "operationId": "get_v1_stocks_aggs" } }, "/v1/stocks/grouped": { "get": { "summary": "Get Daily Market Summary", "description": "Get the daily open, high, low, and close (OHLC) for the entire market on a specific date.", "tags": [ "Stocks" ], "parameters": [ { "name": "date", "in": "query", "required": true, "schema": { "type": "string", "format": "date", "example": "2024-01-15" }, "description": "Date in YYYY-MM-DD format. Enter the specific calendar date you want to query." }, { "name": "adjusted", "in": "query", "required": false, "schema": { "type": "boolean", "example": true }, "description": "Whether to adjust historical prices for stock splits. Use true for normalized charting and false for raw market data." }, { "name": "includeOtc", "in": "query", "required": false, "schema": { "type": "boolean", "example": false }, "description": "Whether to include over-the-counter securities. Use true only when your product needs OTC market coverage." } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "adjusted": { "type": "boolean", "description": "Whether or not the results are adjusted for splits" }, "queryCount": { "type": "integer", "description": "Number of results returned" }, "requestId": { "type": "string", "description": "Unique request ID" }, "results": { "type": "array", "description": "Array of grouped daily bars", "items": { "$ref": "#/components/schemas/StockOhlcBar" } }, "resultsCount": { "type": "integer", "description": "Total number of results" }, "status": { "type": "string", "description": "Status string from the upstream data provider — typically `OK` for a successful response. Treat any other value as an error indicator alongside the HTTP status code." } } }, "example": { "adjusted": true, "queryCount": 1, "requestId": "03182c050e5e955bc6e10e78f2890fff", "results": [ { "c": 206.25, "h": 206.9197, "l": 204.65, "n": 317, "o": 204.81, "t": 1736974800000, "v": 14444, "vw": 205.4248, "T": "XNTK" } ], "resultsCount": 1, "status": "OK" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "security": [ { "OAuth2": [ "market:supplemental" ] } ], "operationId": "get_v1_stocks_grouped" } }, "/v1/stocks/open-close": { "get": { "summary": "Get Daily Ticker Summary", "description": "Get the open, close and afterhours prices of a stock on a specific date.", "tags": [ "Stocks" ], "parameters": [ { "name": "ticker", "in": "query", "required": true, "schema": { "type": "string", "example": "AAPL" }, "description": "Stock ticker symbol, such as AAPL. Use the exact ticker for the company you want to research." }, { "name": "date", "in": "query", "required": true, "schema": { "type": "string", "format": "date", "example": "2024-01-15" }, "description": "Date in YYYY-MM-DD format. Enter the specific calendar date you want to query." }, { "name": "adjusted", "in": "query", "required": false, "schema": { "type": "boolean", "example": true }, "description": "Whether to adjust historical prices for stock splits. Use true for normalized charting and false for raw market data." } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "afterHours": { "type": "number", "description": "After hours price" }, "close": { "type": "number", "description": "Closing price" }, "from": { "type": "string", "description": "Date in YYYY-MM-DD format. Enter the specific calendar date you want to query." }, "high": { "type": "number", "description": "High price" }, "low": { "type": "number", "description": "Low price" }, "open": { "type": "number", "description": "Opening price" }, "preMarket": { "type": "number", "description": "Pre-market price" }, "status": { "type": "string", "description": "Status string from the upstream data provider — typically `OK` for a successful response. Treat any other value as an error indicator alongside the HTTP status code." }, "symbol": { "type": "string", "description": "Stock ticker symbol, such as AAPL. Use the exact ticker for the company you want to research." }, "volume": { "type": "number", "description": "Trading volume" }, "otc": { "type": "boolean", "description": "Whether the security is OTC" } } }, "example": { "afterHours": 238.5993, "close": 237.87, "from": "2025-01-15", "high": 238.96, "low": 234.43, "open": 234.635, "preMarket": 233.79, "status": "OK", "symbol": "AAPL", "volume": 39822169 } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "security": [ { "OAuth2": [ "market:supplemental" ] } ], "operationId": "get_v1_stocks_open_close" } }, "/v1/stocks/prev": { "get": { "summary": "Get Previous Day Bar", "description": "Get the previous day's OHLCV (Open, High, Low, Close, Volume) data for a stock.", "tags": [ "Stocks" ], "parameters": [ { "name": "ticker", "in": "query", "required": true, "schema": { "type": "string", "example": "AAPL" }, "description": "Stock ticker symbol, such as AAPL. Use the exact ticker for the company you want to research." }, { "name": "adjusted", "in": "query", "required": false, "schema": { "type": "boolean", "example": true }, "description": "Whether to adjust historical prices for stock splits. Use true for normalized charting and false for raw market data." } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "adjusted": { "type": "boolean", "description": "Whether or not the results are adjusted for splits" }, "queryCount": { "type": "integer", "description": "Number of results returned" }, "requestId": { "type": "string", "description": "Unique request ID" }, "results": { "type": "array", "description": "Array containing previous day bar", "items": { "$ref": "#/components/schemas/StockOhlcBar" } }, "resultsCount": { "type": "integer", "description": "Total number of results" }, "status": { "type": "string", "description": "Status string from the upstream data provider — typically `OK` for a successful response. Treat any other value as an error indicator alongside the HTTP status code." }, "ticker": { "type": "string", "description": "Stock ticker symbol, such as AAPL. Use the exact ticker for the company you want to research." } } }, "example": { "adjusted": true, "queryCount": 1, "requestId": "82a13adb7cdd6b2dab0c4bea3cba1540", "results": [ { "c": 271.01, "h": 277.84, "l": 269, "n": 641453, "o": 272.255, "t": 1767387600000, "v": 37782525, "vw": 271.9204, "T": "AAPL" } ], "resultsCount": 1, "status": "OK", "ticker": "AAPL" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "security": [ { "OAuth2": [ "market:supplemental" ] } ], "operationId": "get_v1_stocks_prev" } }, "/v1/stocks/snapshot": { "get": { "summary": "Get Full Market Snapshot", "description": "Get snapshot of all tickers or specific tickers with current day data including latest price, volume, and daily changes.", "tags": [ "Stocks" ], "parameters": [ { "name": "tickers", "in": "query", "required": false, "schema": { "type": "string", "example": "AAPL,TSLA,GOOG" }, "description": "Comma-separated list of tickers, such as AAPL,MSFT. Use this to request several companies in one call." }, { "name": "includeOtc", "in": "query", "required": false, "schema": { "type": "boolean", "example": false }, "description": "Whether to include over-the-counter securities. Use true only when your product needs OTC market coverage." } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "count": { "type": "integer", "description": "Number of tickers returned" }, "status": { "type": "string", "description": "Status string from the upstream data provider — typically `OK` for a successful response. Treat any other value as an error indicator alongside the HTTP status code." }, "tickers": { "type": "array", "description": "Array of ticker snapshots", "items": { "type": "object", "properties": { "day": { "type": "object", "description": "Current day aggregate", "properties": { "close": { "type": "number", "description": "Close price" }, "high": { "type": "number", "description": "High price" }, "low": { "type": "number", "description": "Low price" }, "open": { "type": "number", "description": "Open price" }, "volume": { "type": "number", "description": "Volume" }, "vwap": { "type": "number", "description": "VWAP" } } }, "lastQuote": { "type": "object", "description": "Last quote information", "properties": { "askPrice": { "type": "number" }, "askSize": { "type": "integer" }, "bidPrice": { "type": "number" }, "bidSize": { "type": "integer" }, "timestamp": { "type": "integer", "format": "int64" } } }, "lastTrade": { "type": "object", "description": "Last trade information", "properties": { "conditions": { "type": "array", "items": { "type": "integer" } }, "tradeId": { "type": "string" }, "price": { "type": "number" }, "size": { "type": "integer" }, "timestamp": { "type": "integer", "format": "int64" }, "exchangeId": { "type": "integer" } } }, "min": { "type": "object", "properties": { "accumulatedVolume": { "type": "integer" }, "close": { "type": "number" }, "high": { "type": "number" }, "low": { "type": "number" }, "numberOfTrades": { "type": "integer" }, "open": { "type": "number" }, "timestamp": { "type": "integer" }, "volume": { "type": "integer" }, "vwap": { "type": "number" } }, "description": "Latest minute aggregate" }, "prevDay": { "type": "object", "properties": { "close": { "type": "number" }, "high": { "type": "number" }, "low": { "type": "number" }, "open": { "type": "number" }, "volume": { "type": "integer" }, "vwap": { "type": "number" } }, "description": "Previous day aggregate" }, "ticker": { "type": "string", "description": "Ticker symbol" }, "todaysChange": { "type": "number", "description": "Today's change" }, "todaysChangePerc": { "type": "number", "description": "Today's change percent" }, "updated": { "type": "integer", "description": "Last updated timestamp" } } } } } }, "example": { "count": 3, "status": "OK", "tickers": [ { "day": { "close": 444.176, "high": 445.955, "low": 442.158, "open": 442.158, "volume": 151395, "vwap": 445.03447 }, "lastQuote": { "askPrice": 0, "askSize": 0, "bidPrice": 0, "bidSize": 0, "timestamp": 0 }, "lastTrade": { "tradeId": "71675577320245", "price": 0, "size": 0, "timestamp": 0, "exchangeId": 0 }, "min": { "accumulatedVolume": 151395, "close": 444.187, "high": 444.57, "low": 444.187, "numberOfTrades": 59, "open": 444.57, "timestamp": 1767606360000, "volume": 2532, "vwap": 444.40449 }, "prevDay": { "close": 438.07, "high": 458.34, "low": 435.3, "open": 457.8, "volume": 85351571, "vwap": 444.0976 }, "ticker": "TSLA", "todaysChange": 0, "todaysChangePerc": 0, "updated": 1767606420000000000 } ] } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "security": [ { "OAuth2": [ "market:supplemental" ] } ], "operationId": "get_v1_stocks_snapshot" } }, "/v1/stocks/unified-snapshot": { "get": { "summary": "Get Unified Snapshot", "description": "Get unified snapshots across asset classes (`stocks`, `options`, `fx`, `crypto`, `indices`). `ticker` accepts a single symbol only. Use `tickersAnyOf` for multiple symbols. If `ticker` contains multiple comma-separated values, the API returns 400: \"Multiple tickers are not supported. Please provide a single ticker.\" If both `ticker` and `tickersAnyOf` are set, the API returns 400: \"Cannot specify both ticker and tickersAnyOf. Use ticker for a single symbol or tickersAnyOf for multiple.\" For `type=options`, response items may include options-specific fields like `details`, `greeks`, `impliedVolatility`, `openInterest`, `breakEvenPrice`, and `underlyingAsset`; non-applicable fields are omitted.", "tags": [ "Stocks" ], "parameters": [ { "name": "type", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "stocks", "options", "fx", "crypto", "indices" ], "example": "stocks", "description": "Asset class filter for unified snapshot." }, "description": "Which asset class to include in the snapshot. Allowed values:\n- `stocks` — equities and ETFs.\n- `options` — option contracts.\n- `fx` — foreign-exchange currency pairs.\n- `crypto` — cryptocurrencies.\n- `indices` — market indices like SPX, NDX, VIX." }, { "name": "ticker", "in": "query", "required": false, "schema": { "type": "string", "example": "AAPL" }, "description": "Single ticker symbol filter. Enter one ticker such as AAPL to narrow results to one company. In the docs playground, if you enter `ticker`, do not select `type`, because selecting `type` can clear the `ticker` field." }, { "name": "tickersAnyOf", "in": "query", "required": false, "schema": { "type": "string", "example": "AAPL,TSLA,GOOG" }, "description": "Comma-separated list of ticker symbols (maximum 250)." }, { "name": "tickerFrom", "in": "query", "required": false, "schema": { "type": "string", "example": "A" }, "description": "Ticker lower-bound filter. Returns symbols alphabetically on or after this ticker." }, { "name": "tickerAfter", "in": "query", "required": false, "schema": { "type": "string", "example": "A" }, "description": "Ticker lower-bound filter. Returns symbols alphabetically after this ticker, excluding the ticker itself." }, { "name": "tickerTo", "in": "query", "required": false, "schema": { "type": "string", "example": "Z" }, "description": "Ticker upper-bound filter. Returns symbols alphabetically on or before this ticker." }, { "name": "tickerBefore", "in": "query", "required": false, "schema": { "type": "string", "example": "Z" }, "description": "Ticker upper-bound filter. Returns symbols alphabetically before this ticker, excluding the ticker itself." }, { "name": "order", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "asc" }, "description": "Sort order for returned records. Use asc for oldest first or desc for newest first when supported." }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 250, "example": 10 }, "description": "Maximum number of results to return. Use smaller values for UI pages and larger values for exports within API limits." }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Sort field used for ordering. Massive documents this separately from `order`, so enter the provider-supported field name in the text box, for example `ticker`." }, { "name": "next", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Pagination cursor from the previous response. Omit it on the first request, then send the returned cursor to fetch the next page." } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "nextUrl": { "type": "string", "description": "URL for next page of results" }, "requestId": { "type": "string", "description": "Unique request ID" }, "results": { "type": "array", "description": "Array of unified snapshots", "items": { "type": "object", "properties": { "fmv": { "type": "number", "description": "Fair market value" }, "fmvLastUpdated": { "type": "integer", "description": "FMV last updated timestamp" }, "lastMinute": { "type": "object", "properties": { "close": { "type": "number" }, "high": { "type": "number" }, "low": { "type": "number" }, "open": { "type": "number" }, "transactions": { "type": "integer" }, "volume": { "type": "integer" }, "vwap": { "type": "number" } }, "description": "Last minute aggregate" }, "lastQuote": { "$ref": "#/components/schemas/OptionSnapshotLastQuote" }, "lastTrade": { "$ref": "#/components/schemas/OptionSnapshotLastTrade" }, "breakEvenPrice": { "type": "number", "description": "Options-only break-even price when available" }, "details": { "$ref": "#/components/schemas/OptionSnapshotContractDetails" }, "greeks": { "$ref": "#/components/schemas/OptionSnapshotGreeks" }, "impliedVolatility": { "type": "number", "description": "Options implied volatility when available" }, "openInterest": { "type": "integer", "description": "Options open interest when available" }, "marketStatus": { "type": "string", "description": "Market status" }, "name": { "type": "string", "description": "Company name" }, "error": { "type": "string", "description": "Per-item error, when returned" }, "message": { "type": "string", "description": "Per-item message, when returned" }, "session": { "$ref": "#/components/schemas/OptionSnapshotDayBar" }, "ticker": { "type": "string", "description": "Ticker symbol" }, "timeframe": { "type": "string", "description": "Timeframe for the item, when available" }, "type": { "$ref": "#/components/schemas/OrderTypeEnum" }, "underlyingAsset": { "$ref": "#/components/schemas/OptionSnapshotUnderlying" }, "lastUpdated": { "type": "integer", "description": "Item-level last updated timestamp, when available" }, "value": { "type": "number", "description": "Value field, when available" } } } }, "status": { "type": "string", "description": "Status string from the upstream data provider — typically `OK` for a successful response. Treat any other value as an error indicator alongside the HTTP status code." } } }, "example": { "requestId": "1d0ab9bef56cd6a18a809d4c4c0070f1", "results": [ { "fmv": 270.66, "fmvLastUpdated": 1767606739184712400, "lastMinute": { "close": 270.66, "high": 270.66, "low": 270.66, "open": 270.66, "transactions": 3, "volume": 53, "vwap": 270.66 }, "lastQuote": { "ask": 285.79, "askExchange": 15, "askSize": 100, "bid": 258.4, "bidExchange": 15, "bidSize": 100, "lastUpdated": 1767387600000915500, "timeframe": "DELAYED" }, "lastTrade": { "conditions": [ 12, 37 ], "exchange": 15, "id": "14717", "lastUpdated": 1767391050283999700, "price": 270.81, "size": 3, "timeframe": "DELAYED" }, "marketStatus": "early_trading", "name": "Apple Inc.", "session": { "change": -0.2, "changePercent": -0.0738, "close": 270.66, "earlyTradingChange": -0.35, "earlyTradingChangePercent": -0.129, "high": 271.025, "low": 270.371, "open": 271.005, "previousClose": 271.01, "volume": 23380 }, "ticker": "AAPL", "type": "stocks" } ], "status": "OK" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "security": [ { "OAuth2": [ "market:supplemental" ] } ], "operationId": "get_v1_stocks_unified_snapshot" } }, "/v1/stocks/trades": { "get": { "summary": "Get Stock Trades", "description": "Get tick-level trade data for a stock with precise timestamps.", "tags": [ "Stocks" ], "parameters": [ { "name": "ticker", "in": "query", "required": true, "schema": { "type": "string", "example": "AAPL" }, "description": "Stock ticker symbol, such as AAPL. Use the exact ticker for the company you want to research." }, { "name": "timestamp", "in": "query", "required": false, "schema": { "type": "string", "example": "2024-01-15" }, "description": "Query by timestamp (YYYY-MM-DD or nanoseconds)" }, { "name": "timestampFrom", "in": "query", "required": false, "schema": { "type": "string", "example": "2024-01-01" }, "description": "Timestamp start filter. Returns records at or after this timestamp." }, { "name": "timestampAfter", "in": "query", "required": false, "schema": { "type": "string", "example": "2024-01-01" }, "description": "Timestamp lower-bound filter. Returns records after this timestamp, excluding the timestamp itself." }, { "name": "timestampTo", "in": "query", "required": false, "schema": { "type": "string", "example": "2024-01-31" }, "description": "Timestamp end filter. Returns records at or before this timestamp." }, { "name": "timestampBefore", "in": "query", "required": false, "schema": { "type": "string", "example": "2024-01-31" }, "description": "Timestamp upper-bound filter. Returns records before this timestamp, excluding the timestamp itself." }, { "name": "order", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "asc" }, "description": "Sort order for returned records. Use asc for oldest first or desc for newest first when supported." }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 50000, "example": 1000 }, "description": "Maximum number of results to return. Use smaller values for UI pages and larger values for exports within API limits." }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Sort field used for ordering. Massive documents this separately from `order`, so enter the provider-supported field name in the text box, for example `timestamp`." }, { "name": "next", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Pagination cursor from the previous response. Omit it on the first request, then send the returned cursor to fetch the next page." } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "nextUrl": { "type": "string", "description": "URL for next page of results" }, "requestId": { "type": "string", "description": "Unique request ID" }, "results": { "type": "array", "description": "Array of trade objects", "items": { "type": "object", "properties": { "conditions": { "type": "array", "items": { "type": "integer" }, "description": "Trade conditions" }, "correction": { "type": "integer", "description": "Correction indicator" }, "exchange": { "type": "string", "description": "Exchange code where the data originates. Format depends on the upstream data source and may use MIC, ISO 10383, or a vendor-specific code." }, "id": { "type": "string", "description": "Trade ID" }, "participantTimestamp": { "type": "integer", "format": "int64", "description": "Participant timestamp (nanoseconds)" }, "price": { "type": "number", "description": "Trade price" }, "sequenceNumber": { "type": "integer", "format": "int64", "description": "Sequence number" }, "sipTimestamp": { "type": "integer", "format": "int64", "description": "SIP timestamp (nanoseconds)" }, "size": { "type": "number", "description": "Trade size (shares)" }, "tape": { "type": "integer", "description": "Tape" }, "trfId": { "type": "integer", "description": "TRF ID" }, "trfTimestamp": { "type": "integer", "format": "int64", "description": "TRF timestamp" } } } }, "status": { "type": "string", "description": "Status string from the upstream data provider — typically `OK` for a successful response. Treat any other value as an error indicator alongside the HTTP status code." } } }, "example": { "nextUrl": "https://api.aries.com/v1/stocks/trades?next=YXA9MTAwMDM3MDkmYXM9YXRsYXMtc3RvY2tzLXRyYWRlcyZsaW1pdD0xMDAwJm9yZGVyPWRlc2Mmc29ydD10aW1lc3RhbXAmdGltZXN0YW1wLmx0ZT0yMDI2LTAxLTAyVDIyJTNBNTAlM0EwNS4xNzU5NTM5NTRa&ticker=AAPL", "requestId": "065feb8d4f03d1b18c1f13237a342e3f", "results": [ { "conditions": [ 12 ], "exchange": 4, "id": "360988", "participantTimestamp": 1767401995260648000, "price": 270.9607, "sequenceNumber": 10029677, "sipTimestamp": 1767401995260878300, "size": 391, "tape": 3, "trfId": 202, "trfTimestamp": 1767401995260857300 } ], "status": "DELAYED" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "security": [ { "OAuth2": [ "market:supplemental" ] } ], "operationId": "get_v1_stocks_trades" } }, "/v1/stocks/last-trade": { "get": { "summary": "Get Last Trade", "description": "Get the most recent trade for a stock.", "tags": [ "Stocks" ], "parameters": [ { "name": "ticker", "in": "query", "required": true, "schema": { "type": "string", "example": "AAPL" }, "description": "Stock ticker symbol, such as AAPL. Use the exact ticker for the company you want to research." } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string", "description": "Unique request ID" }, "results": { "type": "object", "description": "Last trade object", "properties": { "ticker": { "type": "string", "description": "Ticker symbol" }, "conditions": { "type": "array", "items": { "type": "integer" }, "description": "Trade conditions" }, "trfTimestamp": { "type": "integer", "description": "TRF timestamp" }, "id": { "type": "string", "description": "Trade ID" }, "price": { "type": "number", "description": "Trade price" }, "sequenceNumber": { "type": "integer", "description": "Sequence number" }, "trfId": { "type": "integer", "description": "TRF ID" }, "size": { "type": "number", "description": "Trade size (shares)" }, "sipTimestamp": { "type": "integer", "format": "int64", "description": "SIP timestamp" }, "exchange": { "type": "string", "description": "Exchange code where the data originates. Format depends on the upstream data source and may use MIC, ISO 10383, or a vendor-specific code." }, "participantTimestamp": { "type": "integer", "format": "int64", "description": "Participant timestamp" }, "tape": { "type": "integer", "description": "Tape" }, "correction": { "type": "integer", "description": "Correction indicator" } } }, "status": { "type": "string", "description": "Status string from the upstream data provider — typically `OK` for a successful response. Treat any other value as an error indicator alongside the HTTP status code." } } }, "example": { "requestId": "5eac8eaf43c0b46e598180f4a2bef742", "results": { "ticker": "AAPL", "conditions": [ 12 ], "trfTimestamp": 1767401995260857300, "id": "360988", "price": 270.9607, "sequenceNumber": 10029677, "trfId": 202, "size": 391, "sipTimestamp": 1767401995260878300, "exchange": 4, "participantTimestamp": 1767401995260648000, "tape": 3 }, "status": "DELAYED" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "security": [ { "OAuth2": [ "market:supplemental" ] } ], "operationId": "get_v1_stocks_last_trade" } }, "/v1/stocks/quotes": { "get": { "summary": "Get Stock Quotes (NBBO)", "description": "Get NBBO (National Best Bid and Offer) quotes for a stock with historical quote data.", "tags": [ "Stocks" ], "parameters": [ { "name": "ticker", "in": "query", "required": true, "schema": { "type": "string", "example": "AAPL" }, "description": "Stock ticker symbol, such as AAPL. Use the exact ticker for the company you want to research." }, { "name": "timestamp", "in": "query", "required": false, "schema": { "type": "string", "example": "2024-01-15" }, "description": "Query by timestamp (YYYY-MM-DD or nanoseconds)" }, { "name": "timestampFrom", "in": "query", "required": false, "schema": { "type": "string", "example": "2024-01-01" }, "description": "Timestamp start filter. Returns records at or after this timestamp." }, { "name": "timestampAfter", "in": "query", "required": false, "schema": { "type": "string", "example": "2024-01-01" }, "description": "Timestamp lower-bound filter. Returns records after this timestamp, excluding the timestamp itself." }, { "name": "timestampTo", "in": "query", "required": false, "schema": { "type": "string", "example": "2024-01-31" }, "description": "Timestamp end filter. Returns records at or before this timestamp." }, { "name": "timestampBefore", "in": "query", "required": false, "schema": { "type": "string", "example": "2024-01-31" }, "description": "Timestamp upper-bound filter. Returns records before this timestamp, excluding the timestamp itself." }, { "name": "order", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "asc" }, "description": "Sort order for returned records. Use asc for oldest first or desc for newest first when supported." }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 50000, "example": 1000 }, "description": "Maximum number of results to return. Use smaller values for UI pages and larger values for exports within API limits." }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Sort field used for ordering. Massive documents this separately from `order`, so enter the provider-supported field name in the text box, for example `timestamp`." }, { "name": "next", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Pagination cursor from the previous response. Omit it on the first request, then send the returned cursor to fetch the next page." } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "nextUrl": { "type": "string", "description": "URL for next page of results" }, "requestId": { "type": "string", "description": "Unique request ID" }, "results": { "type": "array", "description": "Array of NBBO quote objects", "items": { "type": "object", "properties": { "askExchange": { "type": "integer", "description": "Ask exchange ID" }, "askPrice": { "type": "number", "description": "Ask price" }, "askSize": { "type": "number", "description": "Ask size" }, "bidExchange": { "type": "integer", "description": "Bid exchange ID" }, "bidPrice": { "type": "number", "description": "Bid price" }, "bidSize": { "type": "number", "description": "Bid size" }, "conditions": { "type": "array", "items": { "type": "integer" }, "description": "Quote conditions" }, "indicators": { "type": "array", "items": { "type": "integer" }, "description": "Quote indicators" }, "participantTimestamp": { "type": "integer", "format": "int64", "description": "Participant timestamp" }, "sequenceNumber": { "type": "integer", "format": "int64", "description": "Sequence number" }, "sipTimestamp": { "type": "integer", "format": "int64", "description": "SIP timestamp" }, "tape": { "type": "integer", "description": "Tape" }, "trfTimestamp": { "type": "integer", "format": "int64", "description": "TRF timestamp" } } } }, "status": { "type": "string", "description": "Status string from the upstream data provider — typically `OK` for a successful response. Treat any other value as an error indicator alongside the HTTP status code." } } }, "example": { "nextUrl": "https://api.aries.com/v1/stocks/quotes?next=YXA9MCZhcz0mbGltaXQ9MTAwMCZvcmRlcj1kZXNjJnNvcnQ9dGltZXN0YW1wJnRpbWVzdGFtcC5sdGU9MjAyNi0wMS0wMlQyMCUzQTU5JTNBNTkuNTEzODEyODU2Wg&ticker=AAPL", "requestId": "399655f8ac3c2844fa53720e1c5989ae", "results": [ { "askExchange": 21, "askPrice": 271.1, "askSize": 600, "bidExchange": 12, "bidPrice": 270.96, "bidSize": 100, "indicators": [ 604 ], "participantTimestamp": 1767401938487902500, "sequenceNumber": 88394647, "sipTimestamp": 1767401938487914800, "tape": 3 } ], "status": "DELAYED" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "security": [ { "OAuth2": [ "market:supplemental" ] } ], "operationId": "get_v1_stocks_quotes" } }, "/v1/stocks/last-quote": { "get": { "summary": "Get Last Quote (NBBO)", "description": "Get the most recent NBBO (National Best Bid and Offer) quote for a stock.", "tags": [ "Stocks" ], "parameters": [ { "name": "ticker", "in": "query", "required": true, "schema": { "type": "string", "example": "AAPL" }, "description": "Stock ticker symbol, such as AAPL. Use the exact ticker for the company you want to research." } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string", "description": "Unique request ID" }, "results": { "type": "object", "description": "Last NBBO quote object", "properties": { "askPrice": { "type": "number", "description": "Ask price" }, "askSize": { "type": "integer", "description": "Ask size" }, "ticker": { "type": "string", "description": "Ticker symbol" }, "askExchange": { "type": "integer", "description": "Ask exchange ID" }, "indicators": { "type": "array", "items": { "type": "integer" }, "description": "Quote indicators" }, "bidPrice": { "type": "number", "description": "Bid price" }, "sequenceNumber": { "type": "integer", "format": "int64", "description": "Sequence number" }, "bidSize": { "type": "integer", "description": "Bid size" }, "sipTimestamp": { "type": "integer", "format": "int64", "description": "SIP timestamp" }, "bidExchange": { "type": "integer", "description": "Bid exchange ID" }, "participantTimestamp": { "type": "integer", "format": "int64", "description": "Participant timestamp" }, "tape": { "type": "integer", "description": "Tape" }, "conditions": { "type": "array", "items": { "type": "integer" }, "description": "Quote conditions" }, "trfTimestamp": { "type": "integer", "format": "int64", "description": "TRF timestamp" } } }, "status": { "type": "string", "description": "Status string from the upstream data provider — typically `OK` for a successful response. Treat any other value as an error indicator alongside the HTTP status code." } } }, "example": { "requestId": "ff0cd7f98ace500f3dffce9416765d90", "results": { "askPrice": 271.1, "askSize": 600, "ticker": "AAPL", "askExchange": 21, "indicators": [ 604 ], "bidPrice": 270.96, "sequenceNumber": 88394647, "bidSize": 100, "sipTimestamp": 1767401938487914800, "bidExchange": 12, "participantTimestamp": 1767401938487902500, "tape": 3 }, "status": "DELAYED" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "security": [ { "OAuth2": [ "market:supplemental" ] } ], "operationId": "get_v1_stocks_last_quote" } }, "/v1/options/snapshot/chain/{underlyingAsset}": { "get": { "operationId": "getOptionChainSnapshot", "summary": "Get option chain snapshot", "description": "Returns a paginated snapshot of option contracts for an underlying equity. Supports optional filters on strike, expiration, and contract type. Query parameters use camelCase; pagination uses `nextUrl` in the response body. Uses the upstream chain snapshot data source.", "tags": [ "Options" ], "parameters": [ { "name": "underlyingAsset", "in": "path", "required": true, "description": "Underlying equity symbol (for example AAPL).", "schema": { "type": "string", "example": "AAPL" } }, { "name": "strikePrice", "in": "query", "required": false, "description": "Filter by exact strike price (numeric string).", "schema": { "type": "string", "example": "190" } }, { "name": "expirationDate", "in": "query", "required": false, "description": "Filter by expiration date (typically YYYY-MM-DD).", "schema": { "type": "string", "example": "2024-01-19" } }, { "name": "contractType", "in": "query", "required": false, "description": "Filter by contract type (for example call or put).", "schema": { "type": "string", "example": "call" } }, { "name": "strikePriceGte", "in": "query", "required": false, "description": "Strike price greater than or equal to this value.", "schema": { "type": "string" } }, { "name": "strikePriceGt", "in": "query", "required": false, "description": "Strike price strictly greater than this value.", "schema": { "type": "string" } }, { "name": "strikePriceLte", "in": "query", "required": false, "description": "Strike price less than or equal to this value.", "schema": { "type": "string" } }, { "name": "strikePriceLt", "in": "query", "required": false, "description": "Strike price strictly less than this value.", "schema": { "type": "string" } }, { "name": "expirationDateGte", "in": "query", "required": false, "description": "Expiration date greater than or equal to this value.", "schema": { "type": "string" } }, { "name": "expirationDateGt", "in": "query", "required": false, "description": "Expiration date strictly greater than this value.", "schema": { "type": "string" } }, { "name": "expirationDateLte", "in": "query", "required": false, "description": "Expiration date less than or equal to this value.", "schema": { "type": "string" } }, { "name": "expirationDateLt", "in": "query", "required": false, "description": "Expiration date strictly less than this value.", "schema": { "type": "string" } }, { "name": "order", "in": "query", "required": false, "description": "Sort order for returned records. Use asc for oldest first or desc for newest first when supported. for results.", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "asc" } }, { "name": "limit", "in": "query", "required": false, "description": "Maximum number of contracts per page (1–250).", "schema": { "type": "integer", "minimum": 1, "maximum": 250, "example": 50 } }, { "name": "sort", "in": "query", "required": false, "description": "Sort field used for ordering. Massive documents this separately from `order`, so enter the provider-supported field name in the text box.", "schema": { "type": "string" } }, { "name": "next", "in": "query", "required": false, "description": "Pagination cursor from the previous response. Omit it on the first request, then send the returned cursor to fetch the next page. for the next page. Prefer following the absolute `nextUrl` from a previous response; you may also pass the `next` query parameter when continuing the same request pattern.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Option chain snapshot returned successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OptionChainSnapshotResponse" }, "example": { "nextUrl": "https://api.aries.com/v1/options/snapshot/chain/AAPL?limit=1&next=YXA9TyUzQUFBUEwyNjA0MTBDMDAxMTAwMDAlM0ExMTAuMDAmYXM9JmV4cGlyYXRpb25fZGF0ZS5ndGU9MjAyNi0wNC0xMCZsaW1pdD0xJm9yZGVyPWFzYyZzb3J0PXRpY2tlcg&order=asc&sort=ticker", "requestId": "cef93e70deeab28211f93cf18894ea94", "results": [ { "breakEvenPrice": 260.625, "day": { "change": 0, "changePercent": 0, "close": 147.62, "high": 148.41, "lastUpdated": 1775678400000000000, "low": 147.62, "open": 148.41, "previousClose": 147.62, "volume": 4, "vwap": 147.9625 }, "details": { "contractType": "call", "exerciseStyle": "american", "expirationDate": "2026-04-10", "sharesPerContract": 100, "strikePrice": 110, "ticker": "O:AAPL260410C00110000" }, "fmv": 150.626, "fmvLastUpdated": 1775764519938981000, "greeks": { "delta": 0.9866009460931855, "gamma": 0.0003035183978405151, "theta": -2.5694750192894538, "vega": 0.0038452348585003293 }, "impliedVolatility": 9.52609127380109, "lastQuote": { "ask": 152.4, "askExchange": 300, "askSize": 135, "bid": 148.85, "bidExchange": 300, "bidSize": 136, "lastUpdated": 1775764799797068500, "midpoint": 150.625, "timeframe": "REAL-TIME" }, "lastTrade": { "conditions": [ 240 ], "exchange": 308, "price": 147.62, "sipTimestamp": 1775665726017723100, "size": 1, "timeframe": "REAL-TIME" }, "openInterest": 1, "underlyingAsset": { "changeToBreakEven": 0.639, "lastUpdated": 1775779195495831800, "price": 259.986, "ticker": "AAPL", "timeframe": "DELAYED" } } ], "status": "OK" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "security": [ { "OAuth2": [ "options:information" ] } ] } }, "/v1/options/snapshot/{underlyingAsset}/{optionContract}": { "get": { "operationId": "getOptionContractSnapshot", "summary": "Get option contract snapshot", "description": "Returns a point-in-time snapshot for a single option contract: details, day bar, last quote, last trade, Greeks, implied volatility, and underlying context when available. Responses may be cached for approximately five minutes. Uses the upstream contract snapshot data source.", "tags": [ "Options" ], "parameters": [ { "name": "underlyingAsset", "in": "path", "required": true, "description": "Underlying equity symbol (for example AAPL).", "schema": { "type": "string", "example": "AAPL" } }, { "name": "optionContract", "in": "path", "required": true, "description": "OCC-format options contract identifier (for example O:AAPL240119C00190000).", "schema": { "type": "string", "example": "O:AAPL260410C00110000" } } ], "responses": { "200": { "description": "Option contract snapshot returned successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OptionContractSnapshotResponse" }, "example": { "requestId": "6901ccfe43be44e62c437b958758e480", "results": { "breakEvenPrice": 260.625, "day": { "change": 0, "changePercent": 0, "close": 147.62, "high": 148.41, "lastUpdated": 1775678400000000000, "low": 147.62, "open": 148.41, "previousClose": 147.62, "volume": 4, "vwap": 147.9625 }, "details": { "contractType": "call", "exerciseStyle": "american", "expirationDate": "2026-04-10", "sharesPerContract": 100, "strikePrice": 110, "ticker": "O:AAPL260410C00110000" }, "fmv": 150.626, "fmvLastUpdated": 1775764519938981000, "greeks": { "delta": 0.9866008816205978, "gamma": 0.00030351939549158076, "theta": -2.5708677258514525, "vega": 0.00384419352968541 }, "impliedVolatility": 9.52866677365293, "lastQuote": { "ask": 152.4, "askExchange": 300, "askSize": 135, "bid": 148.85, "bidExchange": 300, "bidSize": 136, "lastUpdated": 1775764799797068500, "midpoint": 150.625, "timeframe": "REAL-TIME" }, "lastTrade": { "conditions": [ 240 ], "exchange": 308, "price": 147.62, "sipTimestamp": 1775665726017723100, "size": 1, "timeframe": "REAL-TIME" }, "openInterest": 1, "underlyingAsset": { "changeToBreakEven": 0.639, "lastUpdated": 1775779195495831800, "price": 259.986, "ticker": "AAPL", "timeframe": "DELAYED" } }, "status": "OK" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "security": [ { "OAuth2": [ "options:information" ] } ] } }, "/v1/options/trades": { "get": { "summary": "Get Options Trades", "description": "Get tick-level trade data for options contracts with precise timestamps.", "tags": [ "Options" ], "parameters": [ { "name": "ticker", "in": "query", "required": true, "schema": { "type": "string", "example": "O:AAPL230120C00150000" }, "description": "Options contract ticker symbol. Enter the exact option symbol returned by option search or chain endpoints." }, { "name": "timestamp", "in": "query", "required": false, "schema": { "type": "string", "example": "2024-01-15" }, "description": "Query by timestamp (YYYY-MM-DD or nanoseconds)" }, { "name": "timestampFrom", "in": "query", "required": false, "schema": { "type": "string", "example": "2024-01-01" }, "description": "Timestamp start filter. Returns records at or after this timestamp." }, { "name": "timestampAfter", "in": "query", "required": false, "schema": { "type": "string", "example": "2024-01-01" }, "description": "Timestamp lower-bound filter. Returns records after this timestamp, excluding the timestamp itself." }, { "name": "timestampTo", "in": "query", "required": false, "schema": { "type": "string", "example": "2024-01-31" }, "description": "Timestamp end filter. Returns records at or before this timestamp." }, { "name": "timestampBefore", "in": "query", "required": false, "schema": { "type": "string", "example": "2024-01-31" }, "description": "Timestamp upper-bound filter. Returns records before this timestamp, excluding the timestamp itself." }, { "name": "order", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "asc" }, "description": "Sort order for returned records. Use asc for oldest first or desc for newest first when supported." }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 50000, "example": 1000 }, "description": "Maximum number of results to return. Use smaller values for UI pages and larger values for exports within API limits." }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Sort field used for ordering. Massive documents this separately from `order`, so enter the provider-supported field name in the text box, for example `timestamp`." }, { "name": "next", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Pagination cursor from the previous response. Omit it on the first request, then send the returned cursor to fetch the next page." } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "nextUrl": { "type": "string", "description": "URL for next page of results" }, "requestId": { "type": "string", "description": "Unique request ID" }, "results": { "type": "array", "description": "Array of options trade objects", "items": { "type": "object", "properties": { "conditions": { "type": "array", "items": { "type": "integer" }, "description": "Trade conditions" }, "correction": { "type": "integer", "description": "Correction indicator" }, "exchange": { "type": "string", "description": "Exchange code where the data originates. Format depends on the upstream data source and may use MIC, ISO 10383, or a vendor-specific code." }, "participantTimestamp": { "type": "integer", "format": "int64", "description": "Participant timestamp (nanoseconds)" }, "price": { "type": "number", "description": "Trade price" }, "sipTimestamp": { "type": "integer", "format": "int64", "description": "SIP timestamp (nanoseconds)" }, "size": { "type": "number", "description": "Trade size (contracts)" } } } }, "status": { "type": "string", "description": "Status string from the upstream data provider — typically `OK` for a successful response. Treat any other value as an error indicator alongside the HTTP status code." } } }, "example": { "nextUrl": "https://api.aries.com/v1/options/trades?next=YXA9MTAwMCZhcz1vcHRpb25zLXRyYWRlcyZsaW1pdD0xMDAwJm9yZGVyPWRlc2Mmc29ydD10aW1lc3RhbXAmdGltZXN0YW1wLmx0ZT0yMDIzLTAxLTExVDE2JTNBMDMlM0E0My4zOTRa&ticker=O%3AAAPL230120C00150000", "requestId": "dbfa60aa037390553e639aae76021193", "results": [ { "conditions": [ 232 ], "exchange": 308, "participantTimestamp": 1674248368870000000, "price": 0.01, "sipTimestamp": 1674248368870000000, "size": 2 }, { "conditions": [ 209 ], "exchange": 301, "participantTimestamp": 1673453023394000000, "price": 0.04, "sipTimestamp": 1673453023394000000, "size": 11 } ], "status": "OK" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "security": [ { "OAuth2": [ "options:information" ] } ], "operationId": "get_v1_options_trades" } }, "/v1/options/last-trade": { "get": { "summary": "Get Options Last Trade", "description": "Get the most recent trade for an options contract.", "tags": [ "Options" ], "parameters": [ { "name": "ticker", "in": "query", "required": true, "schema": { "type": "string", "example": "O:AAPL230120C00150000" }, "description": "Options contract ticker symbol. Enter the exact option symbol returned by option search or chain endpoints." } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestId": { "type": "string", "description": "Unique request ID" }, "results": { "type": "object", "description": "Last options trade object", "properties": { "ticker": { "type": "string", "description": "Options contract ticker symbol. Enter the exact option symbol returned by option search or chain endpoints." }, "conditions": { "type": "array", "items": { "type": "integer" }, "description": "Trade conditions" }, "correction": { "type": "integer", "description": "Correction indicator" }, "trfTimestamp": { "type": "integer", "format": "int64", "description": "TRF timestamp" }, "id": { "type": "string", "description": "Trade ID" }, "price": { "type": "number", "description": "Trade price" }, "sequenceNumber": { "type": "integer", "format": "int64", "description": "Sequence number" }, "size": { "type": "number", "description": "Trade size (contracts)" }, "sipTimestamp": { "type": "integer", "format": "int64", "description": "SIP timestamp" }, "exchange": { "type": "string", "description": "Exchange code where the data originates. Format depends on the upstream data source and may use MIC, ISO 10383, or a vendor-specific code." }, "participantTimestamp": { "type": "integer", "format": "int64", "description": "Participant timestamp" }, "trfId": { "type": "integer", "description": "TRF ID" }, "tape": { "type": "integer", "description": "Tape" } } }, "status": { "type": "string", "description": "Status string from the upstream data provider — typically `OK` for a successful response. Treat any other value as an error indicator alongside the HTTP status code." } } }, "example": { "requestId": "c6f94e3d743860d032711055c19da4fe", "results": { "ticker": "O:AAPL230120C00150000", "conditions": [ 232 ], "id": "2", "price": 0.01, "sequenceNumber": 0, "size": 2, "sipTimestamp": 1674248368870000000, "exchange": 308, "participantTimestamp": 1674248368870000000 }, "status": "OK" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "security": [ { "OAuth2": [ "options:information" ] } ], "operationId": "get_v1_options_last_trade" } }, "/v1/options/quotes": { "get": { "summary": "Get Options Quotes", "description": "Get quote data for options contracts including bid, ask, and Greeks.", "tags": [ "Options" ], "parameters": [ { "name": "ticker", "in": "query", "required": true, "schema": { "type": "string", "example": "O:AAPL230120C00150000" }, "description": "Options contract ticker symbol. Enter the exact option symbol returned by option search or chain endpoints." }, { "name": "timestamp", "in": "query", "required": false, "schema": { "type": "string", "example": "2024-01-15" }, "description": "Query by timestamp (YYYY-MM-DD or nanoseconds)" }, { "name": "timestampFrom", "in": "query", "required": false, "schema": { "type": "string", "example": "2024-01-01" }, "description": "Timestamp start filter. Returns records at or after this timestamp." }, { "name": "timestampAfter", "in": "query", "required": false, "schema": { "type": "string", "example": "2024-01-01" }, "description": "Timestamp lower-bound filter. Returns records after this timestamp, excluding the timestamp itself." }, { "name": "timestampTo", "in": "query", "required": false, "schema": { "type": "string", "example": "2024-01-31" }, "description": "Timestamp end filter. Returns records at or before this timestamp." }, { "name": "timestampBefore", "in": "query", "required": false, "schema": { "type": "string", "example": "2024-01-31" }, "description": "Timestamp upper-bound filter. Returns records before this timestamp, excluding the timestamp itself." }, { "name": "order", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "asc" }, "description": "Sort order for returned records. Use asc for oldest first or desc for newest first when supported." }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 50000, "example": 1000 }, "description": "Maximum number of results to return. Use smaller values for UI pages and larger values for exports within API limits." }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Sort field used for ordering. Massive documents this separately from `order`, so enter the provider-supported field name in the text box, for example `timestamp`." }, { "name": "next", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Pagination cursor from the previous response. Omit it on the first request, then send the returned cursor to fetch the next page." } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "nextUrl": { "type": "string", "description": "URL for next page of results" }, "requestId": { "type": "string", "description": "Unique request ID" }, "results": { "type": "array", "description": "Array of options quote objects", "items": { "type": "object", "properties": { "askExchange": { "type": "integer", "description": "Ask exchange ID" }, "askPrice": { "type": "number", "description": "Ask price" }, "askSize": { "type": "number", "description": "Ask size" }, "bidExchange": { "type": "integer", "description": "Bid exchange ID" }, "bidPrice": { "type": "number", "description": "Bid price" }, "bidSize": { "type": "number", "description": "Bid size" }, "sequenceNumber": { "type": "integer", "format": "int64", "description": "Sequence number" }, "sipTimestamp": { "type": "integer", "format": "int64", "description": "SIP timestamp (nanoseconds)" } } } }, "status": { "type": "string", "description": "Status string from the upstream data provider — typically `OK` for a successful response. Treat any other value as an error indicator alongside the HTTP status code." } } }, "example": { "nextUrl": "https://api.aries.com/v1/options/quotes?next=YXA9NzM2JmFzPSZsaW1pdD0xMDAwJm9yZGVyPWRlc2Mmc29ydD10aW1lc3RhbXAmdGltZXN0YW1wLmx0ZT0yMDIzLTAxLTEzVDIwJTNBNTAlM0EyOC43NjE2MDI4MTZa&ticker=O%3AAAPL230120C00150000", "requestId": "abdd5e0f749621028802750474bc45cc", "results": [ { "askExchange": 312, "askPrice": 0.01, "askSize": 448, "bidExchange": 312, "bidPrice": 0, "bidSize": 0, "sequenceNumber": 397175, "sipTimestamp": 1674225000502655700 }, { "askExchange": 322, "askPrice": 0.03, "askSize": 605, "bidExchange": 322, "bidPrice": 0.02, "bidSize": 946, "sequenceNumber": 1456051843, "sipTimestamp": 1673643028761602800 } ], "status": "OK" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "security": [ { "OAuth2": [ "options:information" ] } ], "operationId": "get_v1_options_quotes" } }, "/v1/etf/profile": { "get": { "operationId": "getEtfProfile", "summary": "Get ETF Profile", "description": "Retrieve comprehensive ETF information including fund name, description, expense ratio, assets under management, and tracking methodology.", "parameters": [ { "name": "symbol", "in": "query", "required": true, "schema": { "type": "string", "example": "SPY" }, "description": "ETF ticker symbol (e.g. SPY, QQQ, VTI)" }, { "name": "isin", "in": "query", "required": false, "schema": { "type": "string" }, "description": "ISIN identifier — the 12-character International Securities Identification Number for the instrument (e.g. `US0378331005` for Apple). Provide this instead of `symbol` when you have an ISIN." } ], "responses": { "200": { "description": "ETF profile.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "profile": { "type": "object", "properties": { "assetClass": { "type": "string" }, "aum": { "type": "integer" }, "avgVolume": { "type": "integer" }, "cusip": { "type": "string" }, "description": { "type": "string" }, "domicile": { "type": "string" }, "etfCompany": { "type": "string" }, "expenseRatio": { "type": "number" }, "inceptionDate": { "type": "string" }, "investmentSegment": { "type": "string" }, "isin": { "type": "string" }, "name": { "type": "string" }, "nav": { "type": "number" }, "navCurrency": { "type": "string" }, "priceToBook": { "type": "number" }, "priceToEarnings": { "type": "number" }, "trackingIndex": { "type": "string" }, "logo": { "type": "string" }, "website": { "type": "string" } } }, "symbol": { "type": "string" } } } } }, "examples": { "default": { "value": { "data": { "profile": { "assetClass": "Equity", "aum": 722624708608, "avgVolume": 71473536, "cusip": "78462F103", "description": "SPY was created on 1993-01-22 by SPDR. The fund's investment portfolio concentrates primarily on large cap equity. The ETF currently has 715474.27m in AUM and 504 holdings. SPY tracks a market cap-weighted index of US large- and mid-cap stocks selected by the S&P Committee.", "domicile": "US", "etfCompany": "SPDR", "expenseRatio": 0.09449999779462814, "inceptionDate": "1993-01-22", "investmentSegment": "Large Cap", "isin": "US78462F1030", "name": "SPDR S&P 500 ETF Trust", "nav": 680.6957397460938, "navCurrency": "USD", "priceToBook": 5.355377197265625, "priceToEarnings": 27.603900909423828, "trackingIndex": "S&P 500", "logo": "https://api.aries.com/v1/logos/image/f2/etf_logo/9115112100114451159711010011253484845101116102451161146.png", "website": "https://www.ssga.com/us/en/intermediary/etfs/spdr-sp-500-etf-trust-spy" }, "symbol": "SPY" } } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "security": [ { "OAuth2": [ "market:supplemental" ] } ], "tags": [ "ETF" ] } }, "/v1/etf/holdings": { "get": { "operationId": "getEtfHoldings", "summary": "Get ETF Holdings", "description": "Retrieve detailed ETF holdings showing constituent securities, allocation percentages, share quantities, and market values.", "parameters": [ { "name": "symbol", "in": "query", "required": false, "description": "ETF ticker to filter by. Send the plain uppercase symbol (e.g. `SPY`). Provide either `symbol` or `isin`.", "schema": { "type": "string" } }, { "name": "isin", "in": "query", "required": false, "description": "ISIN identifier — the 12-character International Securities Identification Number for the instrument (e.g. `US0378331005` for Apple). Provide this instead of `symbol` when you have an ISIN.", "schema": { "type": "string" } }, { "name": "skip", "in": "query", "required": false, "description": "(Optional) Number of records to skip for pagination", "schema": { "type": "integer" } }, { "name": "date", "in": "query", "required": false, "schema": { "type": "string", "format": "date", "example": "2024-12-01" }, "description": "(Optional) Date for historical holdings (YYYY-MM-DD)" } ], "responses": { "200": { "description": "ETF holdings.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "holdings": { "type": "array", "items": { "type": "object", "properties": { "assetType": { "type": "string" }, "cusip": { "type": "string" }, "isin": { "type": "string" }, "name": { "type": "string" }, "percent": { "type": "number" }, "share": { "type": "integer" }, "symbol": { "type": "string" }, "value": { "type": "integer" } } } }, "numberOfHoldings": { "type": "integer" }, "symbol": { "type": "string" } } } } }, "examples": { "default": { "value": { "data": { "holdings": [ { "assetType": "Equity", "cusip": "037833100", "isin": "US0378331005", "name": "Apple Inc", "percent": 7.171259880065918, "share": 1210000000, "symbol": "AAPL", "value": 464000000000 }, { "assetType": "Equity", "cusip": "594918104", "isin": "US5949181045", "name": "Microsoft Corp", "percent": 6.791339874267578, "share": 790000000, "symbol": "MSFT", "value": 439000000000 }, { "assetType": "Equity", "cusip": "023135106", "isin": "US0231351067", "name": "Amazon.com Inc", "percent": 3.60932993888855, "share": 1010000000, "symbol": "AMZN", "value": 233000000000 } ], "numberOfHoldings": 504, "symbol": "SPY" } } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "security": [ { "OAuth2": [ "market:supplemental" ] } ], "tags": [ "ETF" ] } }, "/v1/etf/sector": { "get": { "operationId": "getEtfSectorAllocation", "summary": "Get ETF Sector Allocation", "description": "Retrieve ETF sector allocation breakdown showing percentage exposure to different industries such as technology, healthcare, and financials.", "parameters": [ { "name": "symbol", "in": "query", "required": true, "description": "ETF ticker to query. Send the plain uppercase symbol, e.g. `SPY`, `QQQ`, `IWM`.", "schema": { "type": "string" } }, { "name": "isin", "in": "query", "required": false, "description": "ISIN identifier — the 12-character International Securities Identification Number for the instrument (e.g. `US0378331005` for Apple). Provide this instead of `symbol` when you have an ISIN.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "sectorExposure": { "type": "array", "items": { "type": "object", "properties": { "industry": { "type": "string" }, "exposure": { "type": "number" } } } }, "symbol": { "type": "string" } } } } }, "examples": { "default": { "value": { "data": { "sectorExposure": [ { "industry": "Technology", "exposure": 31.219999313354492 }, { "industry": "Financial Services", "exposure": 12.470000267028809 }, { "industry": "Healthcare", "exposure": 11.529999732971191 } ], "symbol": "SPY" } } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "security": [ { "OAuth2": [ "market:supplemental" ] } ], "tags": [ "ETF" ] } }, "/v1/etf/country": { "get": { "operationId": "getEtfCountryAllocation", "summary": "Get ETF Country Allocation", "description": "Retrieve ETF geographic allocation showing percentage exposure to different countries and regions for assessing international diversification.", "parameters": [ { "name": "symbol", "in": "query", "required": true, "description": "ETF ticker to query. Send the plain uppercase symbol, e.g. `SPY`, `QQQ`, `IWM`.", "schema": { "type": "string" } }, { "name": "isin", "in": "query", "required": false, "description": "ISIN identifier — the 12-character International Securities Identification Number for the instrument (e.g. `US0378331005` for Apple). Provide this instead of `symbol` when you have an ISIN.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "countryExposure": { "type": "array", "items": { "type": "object", "properties": { "country": { "type": "string" }, "exposure": { "type": "number" } } } }, "symbol": { "type": "string" } } } } }, "examples": { "default": { "value": { "data": { "countryExposure": [ { "country": "United States", "exposure": 99.40734100341797 }, { "country": "Switzerland", "exposure": 0.2782300114631653 }, { "country": "Netherlands", "exposure": 0.12555000185966492 } ], "symbol": "SPY" } } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "security": [ { "OAuth2": [ "market:supplemental" ] } ], "tags": [ "ETF" ] } }, "/v1/scan/pattern": { "get": { "operationId": "getTechnicalPatterns", "summary": "Get Technical Patterns", "description": "Retrieve identified technical chart patterns including head and shoulders, double tops/bottoms, triangles, and other price formation signals.", "parameters": [ { "name": "symbol", "in": "query", "required": true, "schema": { "type": "string", "example": "AAPL" }, "description": "Stock ticker to query. Send the plain uppercase symbol exactly as you'd type it on a brokerage screen, e.g. `AAPL`, `MSFT`, `TSLA`." }, { "name": "resolution", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/ChartResolution" }, "description": "How long each bar covers. Use a number of minutes (`1`, `5`, `15`, `30`, `60`, `240`), a letter for daily/weekly/monthly (`D`, `W`, `M`), or an N-trade tick bar (`100T`, `500T`). See `ChartResolution` for the full list." } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "points": { "type": "array", "items": { "type": "object", "properties": { "aprice": { "type": "number" }, "atime": { "type": "integer" }, "bprice": { "type": "integer" }, "btime": { "type": "integer" }, "cprice": { "type": "integer" }, "ctime": { "type": "integer" }, "dprice": { "type": "number" }, "dtime": { "type": "integer" }, "end_price": { "type": "integer" }, "end_time": { "type": "integer" }, "entry": { "type": "integer" }, "eprice": { "type": "integer" }, "etime": { "type": "integer" }, "mature": { "type": "integer" }, "patternname": { "type": "string" }, "patterntype": { "type": "string" }, "profit1": { "type": "integer" }, "profit2": { "type": "integer" }, "sortTime": { "type": "integer" }, "start_price": { "type": "integer" }, "start_time": { "type": "integer" }, "status": { "type": "string", "description": "Status string from the upstream data provider — typically `OK` for a successful response. Treat any other value as an error indicator alongside the HTTP status code." }, "stoploss": { "type": "integer" }, "symbol": { "type": "string" }, "terminal": { "type": "integer" } } } } } } } }, "examples": { "default": { "value": { "data": { "points": [ { "aprice": 213.58, "atime": 1745971200, "bprice": 0, "btime": 0, "cprice": 0, "ctime": 0, "dprice": 197.02, "dtime": 1746489600, "end_price": 0, "end_time": 0, "entry": 0, "eprice": 0, "etime": 0, "mature": 1, "patternname": "two black gapping", "patterntype": "bearish", "profit1": 0, "profit2": 0, "sortTime": 1746489600, "start_price": 0, "start_time": 0, "status": "complete", "stoploss": 0, "symbol": "AAPL.US", "terminal": 0 } ] } } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "security": [ { "OAuth2": [ "market:supplemental" ] } ], "tags": [ "Technical Analysis" ] } }, "/v1/scan/support-resistance": { "get": { "operationId": "getSupportResistanceLevels", "summary": "Get Support & Resistance Levels", "description": "Retrieve calculated support and resistance price levels based on historical price action for identifying key trading zones.", "parameters": [ { "name": "symbol", "in": "query", "required": true, "schema": { "type": "string", "example": "AAPL" }, "description": "Stock ticker to query. Send the plain uppercase symbol exactly as you'd type it on a brokerage screen, e.g. `AAPL`, `MSFT`, `TSLA`." }, { "name": "resolution", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/ChartResolution" }, "description": "How long each bar covers. Use a number of minutes (`1`, `5`, `15`, `30`, `60`, `240`), a letter for daily/weekly/monthly (`D`, `W`, `M`), or an N-trade tick bar (`100T`, `500T`). See `ChartResolution` for the full list." } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "levels": { "type": "array", "items": { "type": "number" } } } } } }, "examples": { "default": { "value": { "data": { "levels": [ 189.8112030029297, 199.2606964111328, 216.22999572753906, 244, 288.6199951171875 ] } } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "security": [ { "OAuth2": [ "market:supplemental" ] } ], "tags": [ "Technical Analysis" ] } }, "/v1/scan/technical-indicator": { "get": { "operationId": "getAggregateTechnicalIndicators", "summary": "Get Aggregate Technical Indicators", "description": "Retrieve aggregate technical indicator signals combining moving averages, oscillators, and momentum indicators for overall buy/sell recommendations.", "parameters": [ { "name": "symbol", "in": "query", "required": true, "schema": { "type": "string", "example": "AAPL" }, "description": "Stock ticker to query. Send the plain uppercase symbol exactly as you'd type it on a brokerage screen, e.g. `AAPL`, `MSFT`, `TSLA`." }, { "name": "resolution", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/ChartResolution" }, "description": "How long each bar covers. Use a number of minutes (`1`, `5`, `15`, `30`, `60`, `240`), a letter for daily/weekly/monthly (`D`, `W`, `M`), or an N-trade tick bar (`100T`, `500T`). See `ChartResolution` for the full list." } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "technicalAnalysis": { "type": "object", "properties": { "count": { "type": "object", "properties": { "buy": { "type": "integer" }, "neutral": { "type": "integer" }, "sell": { "type": "integer" } } }, "signal": { "type": "string" } } }, "trend": { "type": "object", "properties": { "adx": { "type": "number" }, "trending": { "type": "boolean" } } } } } } }, "examples": { "default": { "value": { "data": { "technicalAnalysis": { "count": { "buy": 3, "neutral": 8, "sell": 5 }, "signal": "neutral" }, "trend": { "adx": 25.959386825561523, "trending": true } } } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "security": [ { "OAuth2": [ "market:supplemental" ] } ], "tags": [ "Technical Analysis" ] } }, "/v1/indicator": { "get": { "summary": "Get Technical Indicator Data", "description": "Retrieve calculated technical indicator values including SMA, EMA, RSI, MACD, Bollinger Bands, and other charting indicators.", "parameters": [ { "name": "symbol", "in": "query", "required": true, "description": "Stock ticker to query. Send the plain uppercase symbol exactly as you'd type it on a brokerage screen, e.g. `AAPL`, `MSFT`, `TSLA`.", "schema": { "type": "string" } }, { "name": "resolution", "in": "query", "required": true, "description": "How long each bar covers. Use a number of minutes (`1`, `5`, `15`, `30`, `60`, `240`), a letter for daily/weekly/monthly (`D`, `W`, `M`), or an N-trade tick bar (`100T`, `500T`). See `ChartResolution` for the full list.", "schema": { "$ref": "#/components/schemas/ChartResolution" } }, { "name": "indicator", "in": "query", "required": true, "description": "Which technical indicator to compute. Common picks: `sma` (simple moving average), `ema` (exponential moving average), `rsi` (relative strength index), `macd` (moving-average convergence-divergence), `bbands` (Bollinger Bands). See `TechnicalIndicatorType` for the full list of supported slugs.", "schema": { "$ref": "#/components/schemas/TechnicalIndicatorType" } }, { "name": "from", "in": "query", "required": true, "description": "Start timestamp (Unix seconds)", "schema": { "type": "integer", "format": "int64" } }, { "name": "to", "in": "query", "required": true, "description": "End timestamp (Unix seconds)", "schema": { "type": "integer", "format": "int64" } }, { "name": "timeperiod", "in": "query", "required": false, "description": "(Optional) Period for SMA/RSI/BBANDS", "schema": { "type": "integer" } }, { "name": "fast_period", "in": "query", "required": false, "description": "MACD fast EMA length, in bars. The shorter of the two moving averages used to compute MACD. Standard value is 12. Only used when `indicator=macd`.", "schema": { "type": "integer" } }, { "name": "slow_period", "in": "query", "required": false, "description": "MACD slow EMA length, in bars. The longer of the two moving averages used to compute MACD. Standard value is 26. Only used when `indicator=macd`.", "schema": { "type": "integer" } }, { "name": "signal_period", "in": "query", "required": false, "description": "MACD signal EMA length, in bars. Used to smooth the MACD line into the signal line; crossovers between the two are the basic MACD trading cue. Standard value is 9. Only used when `indicator=macd`.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "sma": { "type": "array", "items": { "type": "integer" } }, "t": { "type": "array", "items": { "type": "integer" } } } }, "examples": { "default": { "value": { "sma": [ 0, 0, 74.23916, 73.74833, 73.72416, 70.676666, 70.045, 68.911, 67.41666, 66.802 ], "t": [ 1583107200, 1583193600, 1583280000, 1583366400, 1583452800, 1583712000, 1583798400, 1583884800, 1583971200, 1584057600 ] } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "security": [ { "OAuth2": [ "market:supplemental" ] } ], "tags": [ "Technical Analysis" ], "operationId": "get_v1_indicator" } }, "/v1/news-sentiment": { "get": { "summary": "Get News Sentiment", "description": "Retrieve news sentiment analysis including bullish/bearish indicators, sentiment scores, and media buzz metrics for assessing market mood.", "parameters": [ { "name": "symbol", "in": "query", "required": true, "schema": { "type": "string", "example": "AAPL" }, "description": "Stock ticker to query. Send the plain uppercase symbol exactly as you'd type it on a brokerage screen, e.g. `AAPL`, `MSFT`, `TSLA`." } ], "responses": { "200": { "description": "News sentiment data.", "content": { "application/json": { "schema": { "type": "object", "properties": { "buzz": { "type": "object", "properties": { "articlesInLastWeek": { "type": "integer" }, "buzz": { "type": "number" }, "weeklyAverage": { "type": "number" } } }, "companyNewsScore": { "type": "number" }, "sectorAverageBullishPercent": { "type": "number" }, "sectorAverageNewsScore": { "type": "number" }, "sentiment": { "type": "object", "properties": { "bearishPercent": { "type": "integer" }, "bullishPercent": { "type": "integer" } } }, "symbol": { "type": "string" } } }, "examples": { "default": { "value": { "buzz": { "articlesInLastWeek": 20, "buzz": 0.8888, "weeklyAverage": 22.5 }, "companyNewsScore": 0.9166, "sectorAverageBullishPercent": 0.6482, "sectorAverageNewsScore": 0.5191, "sentiment": { "bearishPercent": 0, "bullishPercent": 1 }, "symbol": "V" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "security": [ { "OAuth2": [ "market:supplemental" ] } ], "tags": [ "News" ], "operationId": "get_v1_news_sentiment" } } }, "components": { "responses": { "BadRequest": { "description": "Invalid query/path/body, malformed JSON, or failed validation.\n\n**Backend (shared HTTP errors):** Routes that use the shared error writer typically return a **nested** JSON object: `error.type` is an uppercase category such as `VALIDATION` or `BAD_REQUEST` (see the API implementation). Other routes may return the **flat** `ErrorResponse` shape (`error` as a string, optional `codes`). The body may rarely be empty.\n\n**OpenAPI:** Every operation’s **400** response references this component so the documented schema and examples stay aligned.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/AuthenticationErrorEnvelope" }, { "$ref": "#/components/schemas/ErrorResponse" } ], "description": "400 responses commonly use a nested `error` object (`type`, `code`, `message`, optional `details`). Some services still return flat `ErrorResponse` (`error` string, optional `codes`)." }, "examples": { "nested_shared_http_error": { "summary": "Nested error (typical for shared WriteHTTPError-style responses)", "value": { "error": { "type": "VALIDATION", "code": "VALIDATION_ERROR", "message": "Query parameter validation failed", "details": { "fieldName": "field is required" } } } }, "nested_bad_request": { "summary": "Nested error (BAD_REQUEST / invalid JSON)", "value": { "error": { "type": "BAD_REQUEST", "code": "INVALID_JSON", "message": "string" } } }, "flat_string": { "summary": "Flat error string", "value": { "error": "string" } }, "flat_with_codes": { "summary": "Flat error with field codes (some services)", "value": { "error": "string", "codes": [ { "field": "string", "code": "string", "description": "string" } ] } } } } } }, "Unauthorized": { "description": "Authentication failed: missing credentials, invalid JWT, or expired access token.\n\n**Response body variants:** Some routes return JSON with a string `error` field (and optionally `codes` / `metadata`). Others return JSON where `error` is a structured object (`type`, `code`, `message`, and optionally `details`, `request_id`). In edge cases (for example certain gateway or middleware paths) the response may have **no body** even though the status is 401—clients should treat 401 as unauthenticated and refresh or re-authenticate regardless of body shape.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ErrorResponse" }, { "$ref": "#/components/schemas/AuthenticationErrorEnvelope" } ], "description": "401 responses may use a flat `ErrorResponse` shape or a nested `error` object. Inspect `error`: if it is a string, use the flat shape; if it is an object, use the structured shape." }, "examples": { "flat_message": { "summary": "Flat error string (typical)", "value": { "error": "string" } }, "flat_with_codes": { "summary": "Flat error with structured codes", "value": { "error": "string", "codes": [ { "code": "string", "description": "string" } ] } }, "nested_error_object": { "summary": "Nested error (shared HTTP error format)", "value": { "error": { "type": "AUTHENTICATION", "code": "INVALID_TOKEN", "message": "string" } } } } } } }, "Forbidden": { "description": "Authenticated but not allowed to perform this action or access this resource (insufficient scope or role).\n\n**Response body variants:** Flat `ErrorResponse` or nested `error` object, same pattern as 400/401.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ErrorResponse" }, { "$ref": "#/components/schemas/AuthenticationErrorEnvelope" } ], "description": "403 responses may use a flat or nested error shape." }, "examples": { "flat": { "summary": "Flat message", "value": { "error": "string" } }, "nested": { "summary": "Nested error (shared HTTP error format)", "value": { "error": { "type": "AUTHORIZATION", "code": "INSUFFICIENT_SCOPE", "message": "string" } } } } } } }, "NotFound": { "description": "The requested resource does not exist or is not visible to this caller.\n\n**Response body variants:** Flat `ErrorResponse` or nested `error` object.", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ErrorResponse" }, { "$ref": "#/components/schemas/AuthenticationErrorEnvelope" } ], "description": "404 responses may use a flat or nested error shape." }, "examples": { "flat": { "summary": "Flat message", "value": { "error": "string" } }, "nested": { "summary": "Nested error (shared HTTP error format)", "value": { "error": { "type": "NOT_FOUND", "code": "RESOURCE_NOT_FOUND", "message": "string" } } } } } } }, "RateLimitExceeded": { "description": "Too many requests for this client or IP. **Slow down** and retry after a delay.\n\n**Headers:** When present, `Retry-After` indicates how long to wait (seconds or an HTTP-date).\n\n**Body:** Flat `ErrorResponse` or nested `error` object, same as other errors.", "headers": { "Retry-After": { "description": "Seconds to wait before retrying, or an HTTP-date (RFC 7231). Omitted if not applicable.", "schema": { "type": "string", "example": "60" } } }, "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ErrorResponse" }, { "$ref": "#/components/schemas/AuthenticationErrorEnvelope" } ], "description": "429 responses may use a flat or nested error shape." }, "examples": { "flat": { "summary": "Flat rate-limit message", "value": { "error": "string" } }, "nested": { "summary": "Nested error (shared HTTP error format)", "value": { "error": { "type": "RATE_LIMIT", "code": "TOO_MANY_REQUESTS", "message": "string" } } } } } } }, "InternalServerError": { "description": "Unexpected server error or upstream failure. **Retry with exponential backoff**; do not assume a specific JSON body shape.\n\n**Response body variants:** Flat `ErrorResponse`, nested `error` object, or occasionally a minimal message. Some paths may return **no body**.", "content": { "application/json": { "examples": { "flat_string": { "summary": "Flat error string", "value": { "error": "string" } }, "nested_error_object": { "summary": "Nested error (shared HTTP error format)", "value": { "error": { "type": "INTERNAL", "code": "INTERNAL_ERROR", "message": "string" } } } }, "schema": { "oneOf": [ { "$ref": "#/components/schemas/ErrorResponse" }, { "$ref": "#/components/schemas/AuthenticationErrorEnvelope" } ], "description": "5xx responses may use a flat or nested error shape." } } } }, "PredMdBadRequest": { "description": "Invalid request (validation error, malformed JSON, or missing required parameters). Response body is a prediction-market `ErrorEnvelope` with a structured `AppError`.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "success": false, "error": { "type": "VALIDATION", "code": "SYMBOL_REQUIRED", "message": "string" } } } } }, "PredMdNotFound": { "description": "Resource not found. Response body is a prediction-market `ErrorEnvelope` with a structured `AppError`.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "success": false, "error": { "type": "NOT_FOUND", "code": "EVENT_NOT_FOUND", "message": "string" } } } } }, "PredMdInternalServerError": { "description": "Unexpected server error. Response body is a prediction-market `ErrorEnvelope` with a structured `AppError`.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "success": false, "error": { "type": "INTERNAL", "code": "INTERNAL_ERROR", "message": "string" } } } } }, "PredMdBadGateway": { "description": "Upstream data source failure. Response body is a prediction-market `ErrorEnvelope` with a structured `AppError`.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" }, "example": { "success": false, "error": { "type": "EXTERNAL_SERVICE", "code": "UPSTREAM_UNAVAILABLE", "message": "string" } } } } } }, "schemas": { "SortOrderEnum": { "type": "string", "description": "Sort direction for results. Use ascending for oldest or smallest first, descending for newest or largest first.", "enum": [ "asc", "desc" ], "example": "asc" }, "OrderSideEnum": { "type": "string", "description": "Which direction to trade in. Pick one:\n- `BUY` — buying shares or contracts (opens a long position or closes an existing short).\n- `SELL` — selling shares or contracts you already hold (closes a long position).\n- `SELL_SHORT` — selling shares you do not own (opens a short position). Subject to short-sale regulations.\n- `BUY_TO_COVER` — buying shares to close an open short position.", "enum": [ "BUY", "SELL", "SELL_SHORT", "BUY_TO_COVER" ], "example": "BUY" }, "SecurityTypeEnum": { "type": "string", "description": "What kind of instrument the order is for. Pick one:\n- `CS` — Common Stock (equity / ETF).\n- `OPT` — Option contract (call or put).", "enum": [ "CS", "OPT" ], "example": "CS" }, "OrderTypeEnum": { "type": "string", "description": "How the order is priced. Pick one:\n- `MARKET` — Execute immediately at the best available price. Fast and guaranteed to fill, but no price guarantee — the actual fill price can move during execution.\n- `LIMIT` — Execute only at the limit `price` or better (lower for buys, higher for sells). Gives you price control, no execution guarantee. Requires the `price` field.\n- `STOP` — Sits inactive until the market hits `stopPrice`, then converts to a market order. Common for stop-loss exits. Requires the `stopPrice` field.\n- `STOP_LIMIT` — Sits inactive until the market hits `stopPrice`, then converts to a limit order at `price`. More control than `STOP`, but the limit may not fill. Requires both `stopPrice` and `price`.", "enum": [ "MARKET", "LIMIT", "STOP", "STOP_LIMIT" ], "example": "LIMIT" }, "TimeInForceEnum": { "type": "string", "description": "How long the order should stay alive before automatically cancelling. Pick one:\n- `DAY` — Active until the end of today's regular trading session, then cancelled if not filled. The default choice for most orders.\n- `GTC` — Good 'Til Cancelled. Stays open across multiple trading days until you cancel it (the broker may cap at 60–90 days).\n- `IOC` — Immediate Or Cancel. Fill whatever you can right now; cancel the rest immediately. Useful when you want partial fills but no resting order.\n- `FOK` — Fill Or Kill. Fill the entire order immediately, or cancel it entirely. No partial fills allowed.\n- `EXTENDED_HOURS` — Active during pre-market and after-hours trading sessions in addition to regular hours.\n- `AT_THE_OPENING` — Execute at the official market open price; if it can't fill at open, it's cancelled.\n- `AT_THE_CLOSE` — Execute at the official market close price; if it can't fill at close, it's cancelled.", "enum": [ "DAY", "GTC", "IOC", "FOK", "EXTENDED_HOURS", "AT_THE_OPENING", "AT_THE_CLOSE" ], "example": "DAY" }, "NewsTypeEnum": { "type": "string", "description": "Source category of the news item. Pick one:\n- `news` — Editorial news articles from journalists and news services.\n- `press_release` — Official press releases issued directly by companies.", "enum": [ "news", "press_release" ], "example": "news" }, "ApiClient": { "type": "object", "description": "OAuth2 API client", "properties": { "client_id": { "type": "string", "description": "OAuth2 client ID" }, "created_at": { "type": "string", "format": "date-time", "description": "Client creation timestamp" }, "domains": { "type": "array", "items": { "type": "string" }, "description": "List of allowed domains" }, "last_used_at": { "type": "string", "format": "date-time", "description": "Last usage timestamp" }, "name": { "type": "string", "description": "Client name" }, "redirect_uris": { "type": "array", "items": { "type": "string" }, "description": "List of allowed redirect URIs" }, "scopes": { "type": "array", "items": { "type": "string" }, "description": "List of allowed scopes" }, "updated_at": { "type": "string", "format": "date-time", "description": "Client last update timestamp" }, "client_secret": { "type": "string", "description": "OAuth2 client secret (shown only once on create)" } } }, "StockOhlcBar": { "type": "object", "description": "OHLCV bar for stock price history. Use values at each bar to render candles or historical price charts.", "properties": { "c": { "type": "number", "description": "Close price for the bar interval. Use it as the final price in a candle." }, "h": { "type": "number", "description": "Highest traded price during the bar interval. Use it for the candle's upper wick." }, "l": { "type": "number", "description": "Lowest traded price during the bar interval. Use it for the candle's lower wick." }, "n": { "type": "integer", "description": "Number of trades included in the bar. Use it as an activity indicator when available." }, "o": { "type": "number", "description": "Opening price for the bar interval. Use it as the first price in a candle." }, "t": { "type": "integer", "format": "int64", "description": "Bar timestamp in Unix milliseconds. Use it as the x-axis time value." }, "v": { "type": "number", "description": "Shares or contracts traded during the bar interval. Use it for volume charts." }, "vw": { "type": "number", "description": "Volume weighted average price" }, "T": { "type": "string", "description": "Ticker symbol (optional, e.g. for grouped/prev)", "x-speakeasy-name-override": "TickerSymbol" } } }, "AccountItem": { "description": "User account item returned by GET /v2/users/me/accounts. Use `trading_account_id` as the `tradingAccountId` in order API requests. Account type and class are empty when broker metadata is unavailable (e.g. simulation accounts).", "properties": { "trading_account_id": { "description": "Trading account identifier. Pass this value as `tradingAccountId` when placing, replacing, or canceling orders.", "type": "string", "example": "3AF05000" }, "broker_account_id": { "description": "Broker account identifier. Empty for simulation accounts.", "type": "string", "example": "3AF05000" }, "status": { "description": "Account status. **OPEN** = account open for trading; **SUSPENDED** = account suspended; **CLOSED** = account closed; **PENDING_APEX_VERIFICATION** = sent to Apex, awaiting verification; **CANCELED** = account canceled; **REJECTED** = application/account rejected.", "enum": [ "NEW", "PENDING_PLAID_VERIFICATION", "PENDING_APEX_VERIFICATION", "READY_FOR_BACK_OFFICE", "BACK_OFFICE", "OPEN", "CANCELED", "REJECTED", "SUSPENDED", "CLOSED", "ERROR", "AWAITING_REVIEW", "AWAITING_APEX", "RETURNED_APEX", "PENDING_CLOSE" ], "type": "string" }, "is_sim": { "description": "Whether this is a simulation (paper trading) account.", "type": "boolean" }, "account_type": { "description": "Account type (for example INDIVIDUAL or JOINT). Empty for simulation accounts or when broker metadata is unavailable.", "type": "string" }, "account_class": { "description": "Account class (for example MARGIN or CASH). Empty for simulation accounts or when broker metadata is unavailable.", "type": "string" } }, "type": "object" }, "AccountItemApplication": { "description": "Account application info (nested in AccountItem)", "properties": { "submitted": { "description": "Whether the account application has been submitted. Use this to decide whether the user should continue onboarding or wait for review.", "type": "boolean" }, "missing_fields": { "description": "Fields still required before the application can move forward. Show these to the user as onboarding tasks.", "items": { "type": "string" }, "type": "array" }, "created_at": { "description": "When the account application record was created.", "format": "date-time", "type": "string" }, "updated_at": { "description": "When the account application record was last updated.", "format": "date-time", "type": "string" } }, "type": "object" }, "AccountItemUser": { "description": "User summary (nested in AccountItem)", "properties": { "id": { "description": "Aries user ID for this account owner.", "format": "int64", "type": "integer" }, "email": { "description": "Email address for the account owner. Use for account labels or support workflows, not for authentication.", "type": "string" }, "country": { "description": "Country associated with the account owner.", "type": "string" }, "plaid_status": { "description": "Plaid connection status for funding or identity workflows. Use this to decide whether the user needs to reconnect or finish bank verification.", "type": "string" }, "created_at": { "description": "When the user record was created.", "format": "date-time", "type": "string" }, "updated_at": { "description": "When the user record was last updated.", "format": "date-time", "type": "string" } }, "type": "object" }, "ApplicationResponse": { "properties": { "can_submit": { "type": "boolean" }, "id": { "format": "int64", "type": "integer" }, "missing_fields": { "items": { "type": "string" }, "type": "array" }, "plaid_link_token": { "nullable": true, "type": "string" }, "status": { "enum": [ "CREATED", "PENDING_ID_VERFICATION", "PENDING_APPROVAL", "APPROVED", "REJECTED" ], "type": "string", "description": "Account application lifecycle status:\n- `CREATED` — application started but not submitted.\n- `PENDING_ID_VERFICATION` — identity verification in progress.\n- `PENDING_APPROVAL` — application submitted; awaiting back-office review.\n- `APPROVED` — application accepted; account can be opened.\n- `REJECTED` — application denied." } }, "type": "object" }, "AccountBalance": { "type": "object", "description": "Response body for GET /v1/accounts/{id}/balances. Returned as the **top-level JSON object** (not wrapped in `balance`/`availability`). Numeric amounts are decimal strings. Domain-only fields such as `creditMultiplier` are not exposed on this HTTP response.", "properties": { "accountId": { "type": "string", "description": "Account these balances belong to. Match it to the account selected by the user." }, "dayTradeBuyingPower": { "type": "string", "description": "How much the user can use for same-day round-trip trades. Typically up to 4× equity for pattern day traders. Resets at end of day. Decimal string." }, "netBuyingPower": { "type": "string", "description": "Total purchasing power available right now across all instruments — the main number to show as 'Buying Power' in a trading UI. Decimal string." }, "optionBuyingPower": { "type": "string", "description": "How much the user can spend specifically on options. Usually lower than stock buying power because options require cash. Decimal string." }, "stockBuyingPower": { "type": "string", "description": "How much the user can spend specifically on stocks. On a margin account this is typically up to 2× cash. Decimal string." }, "totalEquity": { "type": "string", "description": "Cash plus market value of positions minus any margin debit — the account's net worth right now. Use this as the headline portfolio value. Decimal string." }, "realizedPl": { "type": "string", "description": "Cumulative profit/loss from positions that have already been **closed**. Locked in — does not move with the market. Decimal string." }, "unrealizedPl": { "type": "string", "description": "Profit/loss on positions the user currently **holds open** — paper gains/losses based on current market prices. Changes with the market. Decimal string." }, "settledFunds": { "type": "string", "description": "Cash that has fully settled (T+1/T+2 has passed) and is freely available with no restrictions. Decimal string." }, "unsettledFunds": { "type": "string", "description": "Cash from recent sales that hasn't settled yet. Usable for most trades, but cash accounts may restrict using it for new buys. Decimal string." }, "startOfDayCash": { "type": "string", "description": "Cash balance when today's trading session opened. Useful as the baseline for calculating today's cash change. Decimal string." }, "maintReq": { "type": "string", "description": "**Maintenance requirement** — the minimum equity that must be held to support current positions. Drop below this and the account may receive a margin call. Decimal string." }, "grossMargin": { "type": "string", "description": "Total amount currently borrowed from the broker on margin (before offsets). Use this in risk and account-health displays. Decimal string." }, "sma": { "type": "string", "description": "**Special Memorandum Account** — a Reg T concept. Effectively a stored-up pool of 'extra' buying power that grew from past gains in a margin account. Decimal string." }, "credit": { "type": "string", "description": "Total margin credit line extended to the account. Decimal string." }, "creditRemaining": { "type": "string", "description": "How much of the credit line is still available to draw against. Decimal string." }, "pdt": { "type": "string", "description": "**Pattern Day Trader** flag balance — relates to FINRA Rule 4210 (four-day-trades-in-five-days rule, $25,000 minimum equity). Decimal string." }, "pdtCreditRemaining": { "type": "string", "description": "Remaining day-trade buying power for a PDT-flagged account. Decimal string." }, "pendingOrdersCount": { "type": "integer", "description": "Number of orders currently pending. Use this to explain why available buying power may be reserved." }, "pendingOrdersMarginRequirements": { "type": "string", "description": "Estimated margin requirement reserved by pending orders, returned as a decimal string." }, "valueBought": { "type": "string", "description": "Total value bought for the reporting window, returned as a decimal string. Use this in trading activity summaries." }, "valueSold": { "type": "string", "description": "Total value sold for the reporting window, returned as a decimal string. Use this in trading activity summaries." }, "dayTradeOvernightRegTBuyingPower": { "type": "string", "description": "Reg T overnight buying power available for day-trade-related calculations, returned as a decimal string." }, "heldBackFunds": { "type": "string", "description": "Funds reserved or held back by the brokerage, returned as a decimal string. Subtract this from available cash displays when explaining restricted funds." }, "sodPositionsMarketValue": { "type": "string", "description": "Market value of positions at the start of the day, returned as a decimal string. Use this for daily performance comparisons." }, "sodTtlEquity": { "type": "string", "description": "Total account equity at the start of the day, returned as a decimal string. Use this as the baseline for day-over-day equity changes." }, "sodTtlEquityUpdatedAt": { "type": "string", "format": "date-time", "description": "When start-of-day total equity was last updated. Omitted when not set." } }, "example": { "accountId": "TEST-ACCOUNT-001", "dayTradeBuyingPower": "50000.00", "netBuyingPower": "125000.50", "optionBuyingPower": "25000.00", "stockBuyingPower": "125000.50", "totalEquity": "250000.00", "realizedPl": "1500.25", "unrealizedPl": "-250.75", "settledFunds": "100000.00", "unsettledFunds": "5000.00", "startOfDayCash": "95000.00", "maintReq": "75000.00", "grossMargin": "120000.00", "sma": "0", "credit": "0", "creditRemaining": "0", "pdt": "0", "pdtCreditRemaining": "0", "pendingOrdersCount": 2, "pendingOrdersMarginRequirements": "2500.00", "valueBought": "45000.00", "valueSold": "12000.00", "dayTradeOvernightRegTBuyingPower": "48000.00", "heldBackFunds": "0", "sodPositionsMarketValue": "180000.00", "sodTtlEquity": "248000.00", "sodTtlEquityUpdatedAt": "2026-01-15T09:30:00Z" } }, "AccountBalanceV2": { "type": "object", "description": "Response body for GET /v2/accounts/{id}/balance. Returned as the **top-level JSON object**. Numeric amounts are decimal strings.", "properties": { "balance": { "type": "string", "description": "Total account balance (net account value), returned as a decimal string. Use this as the headline portfolio value." }, "accountId": { "type": "string", "description": "Account these balances belong to. Match it to the account selected by the user." }, "dayTradeBuyingPower": { "type": "string", "description": "How much the user can use for same-day round-trip trades. Typically up to 4× equity for pattern day traders. Resets at end of day. Decimal string." }, "netBuyingPower": { "type": "string", "description": "Total purchasing power available right now across all instruments — the main number to show as 'Buying Power' in a trading UI. Decimal string." }, "optionBuyingPower": { "type": "string", "description": "How much the user can spend specifically on options. Usually lower than stock buying power because options require cash. Decimal string." }, "stockBuyingPower": { "type": "string", "description": "How much the user can spend specifically on stocks. On a margin account this is typically up to 2× cash. Decimal string." }, "realizedPl": { "type": "string", "description": "Cumulative profit/loss from positions that have already been **closed**. Locked in — does not move with the market. Decimal string." }, "unrealizedPl": { "type": "string", "description": "Profit/loss on positions the user currently **holds open** — paper gains/losses based on current market prices. Changes with the market. Decimal string." }, "openPnl": { "type": "string", "description": "Total open (unrealized) profit/loss across all currently held positions, returned as a decimal string. Mirrors `unrealizedPl`." }, "dayOpenPnl": { "type": "string", "description": "Open (unrealized) profit/loss generated during the current trading day, returned as a decimal string." }, "dayRealizedPnl": { "type": "string", "description": "Profit/loss realized from positions closed during the current trading day, returned as a decimal string." }, "dayTotalPnl": { "type": "string", "description": "Total profit/loss for the current trading day, combining day open and day realized P&L (`dayOpenPnl` + `dayRealizedPnl`). Decimal string." }, "costOfPositions": { "type": "string", "description": "Aggregate cost basis of all currently open positions, returned as a decimal string." }, "settledFunds": { "type": "string", "description": "Cash that has fully settled (T+1/T+2 has passed) and is freely available with no restrictions. Decimal string." }, "unsettledFunds": { "type": "string", "description": "Cash from recent sales that hasn't settled yet. Usable for most trades, but cash accounts may restrict using it for new buys. Decimal string." }, "cashBalance": { "type": "string", "description": "Current cash balance in the account, returned as a decimal string. Can be negative on a margin account." }, "amountAvailableToWithdraw": { "type": "string", "description": "Cash currently available to withdraw from the account, returned as a decimal string." }, "startOfDayCash": { "type": "string", "description": "Cash balance when today's trading session opened. Useful as the baseline for calculating today's cash change. Decimal string." }, "maintReq": { "type": "string", "description": "**Maintenance requirement** — the minimum equity that must be held to support current positions. Drop below this and the account may receive a margin call. Decimal string." }, "grossMargin": { "type": "string", "description": "Total amount currently borrowed from the broker on margin (before offsets). Use this in risk and account-health displays. Decimal string." }, "sma": { "type": "string", "description": "**Special Memorandum Account** — a Reg T concept. Effectively a stored-up pool of 'extra' buying power that grew from past gains in a margin account. Decimal string." }, "credit": { "type": "string", "description": "Total margin credit line extended to the account. Decimal string." }, "creditRemaining": { "type": "string", "description": "How much of the credit line is still available to draw against. Decimal string." }, "pdt": { "type": "string", "description": "**Pattern Day Trader** flag balance — relates to FINRA Rule 4210 (four-day-trades-in-five-days rule, $25,000 minimum equity). Decimal string." }, "pdtCreditRemaining": { "type": "string", "description": "Remaining day-trade buying power for a PDT-flagged account. Decimal string." }, "pendingOrdersCount": { "type": "integer", "description": "Number of orders currently pending. Use this to explain why available buying power may be reserved." }, "pendingOrdersMarginRequirements": { "type": "string", "description": "Estimated margin requirement reserved by pending orders, returned as a decimal string." }, "valueBought": { "type": "string", "description": "Total value bought for the reporting window, returned as a decimal string. Use this in trading activity summaries." }, "valueSold": { "type": "string", "description": "Total value sold for the reporting window, returned as a decimal string. Use this in trading activity summaries." }, "dayTradeOvernightRegTBuyingPower": { "type": "string", "description": "Reg T overnight buying power available for day-trade-related calculations, returned as a decimal string." }, "heldBackFunds": { "type": "string", "description": "Funds reserved or held back by the brokerage, returned as a decimal string. Subtract this from available cash displays when explaining restricted funds." }, "sodPositionsMarketValue": { "type": "string", "description": "Market value of positions at the start of the day, returned as a decimal string. Use this for daily performance comparisons." }, "sodTtlEquity": { "type": "string", "description": "Total account equity at the start of the day, returned as a decimal string. Use this as the baseline for day-over-day equity changes." }, "sodTtlEquityUpdatedAt": { "type": "string", "format": "date-time", "description": "When start-of-day total equity (`sodTtlEquity`) was last updated, in RFC3339 format. Omitted when not set." }, "smaCreditRemaining": { "type": "string", "description": "Remaining SMA-based buying power still available to draw against, returned as a decimal string." } }, "example": { "balance": "248874.14377781", "accountId": "TEST-ACCOUNT-001", "dayTradeBuyingPower": "50000", "netBuyingPower": "125000.5", "optionBuyingPower": "25000", "stockBuyingPower": "125000.5", "realizedPl": "37.5", "unrealizedPl": "836.64377781", "openPnl": "836.64377781", "dayOpenPnl": "512.14", "dayRealizedPnl": "37.5", "dayTotalPnl": "549.64", "costOfPositions": "180000", "settledFunds": "100000", "unsettledFunds": "5000", "cashBalance": "105000", "amountAvailableToWithdraw": "100000", "startOfDayCash": "95000", "maintReq": "75000", "grossMargin": "120000", "sma": "0", "credit": "0", "creditRemaining": "0", "pdt": "0", "pdtCreditRemaining": "0", "pendingOrdersCount": 0, "pendingOrdersMarginRequirements": "0", "valueBought": "45000", "valueSold": "12000", "dayTradeOvernightRegTBuyingPower": "48000", "heldBackFunds": "0", "sodPositionsMarketValue": "180000", "sodTtlEquity": "248000", "sodTtlEquityUpdatedAt": "2026-01-15T09:30:00Z", "smaCreditRemaining": "0" } }, "CancelOrderRequest": { "type": "object", "description": "Request body for canceling an open order. Use this only for an order that has not fully filled yet.", "required": [ "origClientOrderId", "accountId", "symbol" ], "properties": { "origClientOrderId": { "type": "string", "description": "Client order ID of the order to cancel. Enter the ID returned when the order was placed or from the account order history.", "minLength": 1, "maxLength": 100, "example": "ORDER-123456" }, "accountId": { "type": "string", "description": "Trading account identifier that should own the order. Use the order-routing account ID returned or configured for the user's brokerage account.", "minLength": 1, "maxLength": 50, "example": "TEST-ACCOUNT-001" }, "symbol": { "type": "string", "description": "Symbol on the original order. Enter the exact uppercase symbol from the order you are canceling.", "minLength": 1, "maxLength": 20, "example": "AAPL" }, "side": { "$ref": "#/components/schemas/OrderSideEnum" }, "securityType": { "$ref": "#/components/schemas/SecurityTypeEnum" }, "putOrCall": { "type": "string", "description": "Option contract type. Enter PUT for a put option or CALL for a call option; omit for stock orders.", "enum": [ "PUT", "CALL" ], "example": "CALL" }, "strikePrice": { "type": "string", "description": "Option strike price from the original option order. Required only when canceling an option order that needs contract details.", "pattern": "^\\d+(\\.\\d{1,2})?$", "example": "150.00" }, "maturity": { "type": "string", "description": "Option expiration date in YYYY-MM-DD format. Required only when canceling an option order that needs contract details.", "format": "date", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "example": "2025-01-17" } } }, "CancelOrderResponse": { "description": "Response returned after requesting cancellation of an order. Use it to confirm whether the cancellation was accepted or needs follow-up.", "properties": { "orderId": { "description": "Order ID for the cancel request result. Use it to confirm which order the response refers to.", "format": "int64", "type": "integer" }, "status": { "description": "Order status after the cancel request. Typical values:\n- `PENDING_CANCEL` — cancel accepted by the broker but not yet final.\n- `CANCELED` — order is fully cancelled; no further fills.\n- `REJECTED` — the cancel was refused (e.g. the order already filled). The original order is unchanged.\n\nThe full FIX OrdStatus enum is supported — see the Place Order response for all possible values.", "type": "string", "enum": [ "NEW", "PARTIALLY_FILLED", "FILLED", "DONE_FOR_DAY", "CANCELED", "REPLACED", "PENDING_CANCEL", "STOPPED", "REJECTED", "SUSPENDED", "PENDING_NEW", "CALCULATED", "EXPIRED", "ACCEPTED_FOR_BID", "PENDING_REPLACE", "SUPERSEDED" ] } }, "type": "object" }, "ChartBars": { "description": "Historical chart data returned as parallel arrays. Values at the same index belong to the same bar, so `t[0]`, `o[0]`, `h[0]`, `l[0]`, `c[0]`, and `v[0]` describe one candle.", "properties": { "c": { "description": "Close price for each bar. Use the value at the same index as `t` for chart candles and performance calculations.", "items": { "type": "number" }, "type": "array" }, "errmsg": { "description": "Human-readable error message. Present only when `s` is `error` or `no_data`; show it when no chart can be rendered.", "type": "string" }, "h": { "description": "Highest traded price during each bar interval. Use it for candle wicks and intraperiod range.", "items": { "type": "number" }, "type": "array" }, "l": { "description": "Lowest traded price during each bar interval. Use it for candle wicks and intraperiod range.", "items": { "type": "number" }, "type": "array" }, "nextTime": { "description": "Next available bar timestamp when the requested range has more data. Use it for pagination or loading older chart data.", "format": "int64", "type": "integer" }, "o": { "description": "Open price for each bar interval. Use the value at the same index as `t` for candle bodies.", "items": { "type": "number" }, "type": "array" }, "s": { "description": "Response status. `ok` means chart arrays are usable; `no_data` means the symbol or range returned no bars; `error` means read `errmsg`.", "enum": [ "ok", "no_data", "error" ], "type": "string" }, "t": { "description": "Bar timestamps in Unix seconds. Each timestamp index lines up with open, high, low, close, and volume arrays.", "items": { "format": "int64", "type": "integer" }, "type": "array" }, "v": { "description": "Trading volume for each bar interval. Use the value at the same index as `t` for volume charts.", "items": { "format": "int64", "type": "integer" }, "type": "array" } }, "required": [ "s" ], "type": "object" }, "ChartConfig": { "description": "Capabilities returned for the charting API. Use this once at startup to configure supported resolutions and chart UI options.", "properties": { "supported_resolutions": { "description": "List of supported chart resolutions, including tick-based intervals with a `T` suffix, minute-based intervals, and daily, weekly, and monthly resolutions.", "example": [ "1T", "5T", "10T", "25T", "50T", "100T", "250T", "500T", "1000T", "1", "3", "5", "15", "30", "45", "60", "120", "180", "240", "1D", "1W", "1M", "3M", "6M", "12M" ], "items": { "type": "string" }, "type": "array" }, "has_intraday": { "description": "Whether intraday chart data is available", "example": true, "type": "boolean" }, "intraday_multipliers": { "description": "Supported intraday multipliers used with minute-based chart resolutions", "example": [ "1", "5", "15", "30", "60", "240" ], "items": { "type": "string" }, "type": "array" }, "has_daily": { "description": "Whether daily chart data is available", "example": true, "type": "boolean" }, "daily_multipliers": { "description": "Supported daily multipliers", "example": [ "1" ], "items": { "type": "string" }, "type": "array" }, "has_weekly_and_monthly": { "description": "Whether weekly and monthly chart data is available", "example": true, "type": "boolean" }, "weekly_multipliers": { "description": "Supported weekly multipliers", "example": [ "1" ], "items": { "type": "string" }, "type": "array" }, "monthly_multipliers": { "description": "Supported monthly multipliers", "example": [ "1" ], "items": { "type": "string" }, "type": "array" }, "supports_group_request": { "description": "Whether the API supports group requests", "example": false, "type": "boolean" }, "supports_marks": { "description": "Whether the API supports marks on charts", "example": false, "type": "boolean" }, "supports_search": { "description": "Whether the API supports symbol search", "example": true, "type": "boolean" }, "supports_time": { "description": "Whether the API supports time endpoint", "example": false, "type": "boolean" }, "supports_timescale_marks": { "description": "Whether the API supports timescale marks", "example": false, "type": "boolean" } }, "type": "object" }, "DeleteKeysRequest": { "properties": { "keys": { "description": "Array of setting keys to delete", "items": { "type": "string" }, "type": "array" } }, "required": [ "keys" ], "type": "object" }, "EarningRelease": { "properties": { "date": { "description": "Earnings release date", "type": "string" }, "epsActual": { "description": "Actual earnings per share", "nullable": true, "type": "number" }, "epsEstimate": { "description": "Estimated earnings per share", "nullable": true, "type": "number" }, "hour": { "description": "Time of day for earnings release: 'bmo' (before market open), 'amc' (after market close), 'dmh' (during market hours)", "type": "string" }, "quarter": { "description": "Quarter number (1-4)", "type": "integer" }, "revenueActual": { "description": "Actual revenue", "nullable": true, "type": "number" }, "revenueEstimate": { "description": "Estimated revenue", "nullable": true, "type": "number" }, "symbol": { "description": "Stock ticker symbol, such as AAPL. Use the exact ticker for the company you want to research.", "type": "string" }, "year": { "description": "Year of the earnings", "type": "integer" }, "name": { "description": "Company name", "type": "string" }, "epsSurprise": { "description": "Difference between actual and estimated EPS", "nullable": true, "type": "number" }, "revenueSurprise": { "description": "Difference between actual and estimated revenue", "nullable": true, "type": "number" }, "marketCap": { "description": "Market capitalization in millions", "nullable": true, "type": "number" }, "logo": { "description": "Company logos for UI display", "type": "object", "properties": { "logoLight": { "description": "Logo URL for light theme", "type": "string" }, "logoDark": { "description": "Logo URL for dark theme", "type": "string" } } }, "analystRating": { "description": "Analyst ratings summary", "type": "object", "properties": { "currentRating": { "description": "Current analyst rating (e.g., Buy, Sell, Hold)", "type": "string" }, "priceTarget": { "description": "Average price target", "type": "number" }, "totalRatings": { "description": "Total number of analyst ratings", "type": "integer" }, "successRate": { "description": "Historical success rate of analysts", "type": "string" }, "averageReturn": { "description": "Average return based on analyst recommendations", "type": "string" } } } }, "type": "object" }, "EconomicsCalendarEvent": { "properties": { "actual": { "description": "Actual reported value (present after release)", "type": "string" }, "calendarID": { "description": "Unique identifier for the calendar event", "type": "string", "example": "te_395222" }, "category": { "description": "Category label for the economic event/indicator (e.g. `GDP`, `Inflation`, `Employment`). Format depends on the upstream data source.", "type": "string", "example": "Continuing Jobless Claims" }, "country": { "description": "Country name", "type": "string", "example": "United States" }, "date": { "description": "Event date (YYYY-MM-DD)", "type": "string", "format": "date", "example": "2026-03-05" }, "time": { "description": "Event time (HH:MM:SS)", "type": "string", "example": "13:30:00" }, "event": { "description": "Event name", "type": "string", "example": "Continuing Jobless Claims" }, "importance": { "description": "Event importance level", "type": "integer", "example": 1 }, "reference": { "description": "Reference period (e.g. Feb/21)", "type": "string", "example": "Feb/21" }, "referenceDate": { "description": "Reference period date (ISO 8601)", "type": "string", "format": "date-time", "example": "2026-02-21T00:00:00" }, "previous": { "description": "Previous period value", "type": "string", "example": "1833K" }, "forecast": { "description": "Market forecast value", "type": "string", "example": "1850K" }, "teForecast": { "description": "Trading Economics forecast value", "type": "string", "example": "1840.0K" }, "source": { "$ref": "#/components/schemas/OrdersV2Source" }, "sourceUrl": { "description": "URL to the data source", "type": "string", "example": "http://www.dol.gov" }, "unit": { "description": "Unit of measure for the indicator", "type": "string", "example": "K" }, "ticker": { "description": "Economic indicator ticker symbol", "type": "string", "example": "UNITEDSTACONJOBCLA" }, "symbol": { "description": "Economic indicator symbol", "type": "string", "example": "UNITEDSTACONJOBCLA" }, "lastUpdate": { "description": "Last update timestamp (ISO 8601)", "type": "string", "format": "date-time", "example": "2026-03-03T10:49:26.58" } }, "type": "object" }, "EconomicsIndicator": { "properties": { "category": { "description": "Category label for the economic event/indicator (e.g. `GDP`, `Inflation`, `Employment`). Format depends on the upstream data source.", "type": "string" }, "country": { "description": "Country code or name", "type": "string" }, "dateTime": { "description": "Date and time of the data point", "type": "string" }, "frequency": { "description": "Data frequency (e.g., monthly, quarterly, yearly)", "type": "string" }, "historicalDataSymbol": { "description": "Symbol identifier for the historical data", "type": "string" }, "lastUpdate": { "description": "Last update timestamp", "type": "string" }, "value": { "description": "Indicator value", "type": "number" } }, "type": "object", "example": { "Message": "", "category": "Employment", "country": "US", "dateTime": "2026-01-15T08:30:00Z", "frequency": "monthly", "historicalDataSymbol": "USURTOT", "lastUpdate": "2026-01-15T08:30:00Z", "value": 3.7 } }, "EquityDetails": { "properties": { "address": { "description": "Company address", "type": "string" }, "alphaVantageUpdatedAt": { "description": "Timestamp when fundamentals were last refreshed from the external data source.", "type": "string" }, "askExchange": { "description": "Ask exchange", "type": "string" }, "askPrice": { "description": "Current ask price", "type": "number" }, "assetType": { "description": "Asset type filter. Use it to narrow unified snapshots to supported instrument classes.", "type": "string" }, "assets": { "description": "Total assets", "type": "number" }, "beta": { "description": "Beta — how volatile the stock is relative to the overall market. Beta = 1 moves with the market, > 1 is more volatile, < 1 is less volatile, negative is inversely correlated.", "type": "number" }, "bidExchange": { "description": "Bid exchange", "type": "string" }, "bidPrice": { "description": "Current bid price", "type": "number" }, "bidSize": { "description": "Bid size", "type": "number" }, "bookValue": { "description": "Book value per share", "type": "number" }, "closePrice": { "description": "Closing price", "type": "number" }, "description": { "description": "Company description", "type": "string" }, "dilutedEPSTTM": { "description": "Diluted EPS over the trailing twelve months (TTM) — earnings per share calculated as if all stock options, warrants, and convertibles were exercised. The conservative EPS figure.", "type": "number" }, "dividendPerShare": { "description": "Dividend per share", "type": "number" }, "dividendYield": { "description": "Dividend yield — annual dividends per share divided by current share price, as a decimal. Roughly the income return a buyer would receive from dividends at today's price.", "type": "number" }, "ebitda": { "description": "EBITDA — Earnings Before Interest, Taxes, Depreciation, and Amortization. A measure of operating profitability before non-cash and financing items, in U.S. dollars.", "type": "number" }, "eps": { "description": "EPS — Earnings Per Share. The company's net profit divided by total shares outstanding. Higher generally means more profitable per share.", "type": "number" }, "eps3YearGrowthRate": { "description": "3-year EPS growth rate", "type": "number" }, "eps5YearGrowthRate": { "description": "5-year EPS growth rate", "type": "number" }, "epsDiluted": { "description": "Diluted earnings per share", "type": "number" }, "evToEBITDA": { "description": "EV/EBITDA — Enterprise Value divided by EBITDA. A capital-structure-neutral valuation ratio used to compare companies regardless of how they're financed. Lower can mean cheaper, but compare within the same industry.", "type": "number" }, "evToRevenue": { "description": "EV/Revenue — Enterprise Value divided by trailing revenue. Used to value companies with low or no earnings; lower can mean cheaper. Compare within the same industry.", "type": "number" }, "fiscalYearEnd": { "description": "Fiscal year end", "type": "string" }, "forwardPE": { "description": "Forward P/E — current price divided by **forecast** earnings per share over the next 12 months. Lower can mean cheaper relative to expected future earnings; compare within the same industry.", "type": "number" }, "grossProfitTTM": { "description": "Gross profit over the trailing twelve months (TTM) — revenue minus cost of goods sold over the last four reported quarters, in U.S. dollars.", "type": "number" }, "high52WeekDate": { "description": "Date of 52-week high", "type": "string" }, "highPrice": { "description": "Daily high price", "type": "number" }, "industry": { "description": "Company industry", "type": "string" }, "lastPrice": { "description": "Last traded price", "type": "number" }, "latestQuarter": { "description": "Latest quarter date", "type": "string" }, "liabilities": { "description": "Total liabilities", "type": "number" }, "longTermDebt": { "description": "Long-term debt", "type": "number" }, "low52WeekDate": { "description": "Date of 52-week low", "type": "string" }, "low52WeekPrice": { "description": "52-week low price", "type": "number" }, "marketCapitalization": { "description": "Market capitalization — current share price multiplied by total shares outstanding. The total dollar value the market currently assigns to the company.", "type": "number" }, "midPrice": { "description": "Mid price between bid and ask", "type": "number" }, "movingAverage200Day": { "description": "200-day moving average — the average closing price over the last 200 trading days. A common long-term trend indicator: price above the 200-day MA is often called an uptrend.", "type": "number" }, "movingAverage50Day": { "description": "50-day moving average — the average closing price over the last 50 trading days. A common medium-term trend indicator.", "type": "number" }, "name": { "description": "Company name", "type": "string" }, "officialSite": { "description": "Official website URL", "type": "string" }, "openPrice": { "description": "Opening price", "type": "number" }, "operatingMarginTTM": { "description": "Operating margin over the trailing twelve months (TTM) — operating income divided by revenue, as a decimal. Shows what portion of each dollar of sales becomes operating profit.", "type": "number" }, "pE": { "description": "Price-to-earnings ratio — current share price divided by earnings per share. Roughly: how many dollars investors are paying for each $1 of yearly company profit. Lower can mean cheaper; compare within the same industry.", "type": "number" }, "pegRatio": { "description": "PEG ratio — Price/Earnings divided by expected earnings growth. PEG ≈ 1 is often called fairly valued, PEG < 1 is potentially undervalued vs. its growth, PEG > 1 is potentially overvalued.", "type": "number" }, "price": { "description": "Current price", "type": "number" }, "priceToBookRatio": { "description": "Price-to-book ratio — current share price divided by book value per share. Below 1 means the market values the company below its accounting book value; useful for asset-heavy industries like banks.", "type": "number" }, "priceToSalesRatioTTM": { "description": "Price-to-sales ratio (TTM)", "type": "number" }, "profitMargin": { "description": "Net profit margin — net income divided by revenue, as a decimal. How much of each dollar of sales the company keeps as profit after all expenses.", "type": "number" }, "quarterlyEarningsGrowthYOY": { "description": "Quarterly earnings growth year-over-year", "type": "number" }, "quarterlyRevenueGrowthYOY": { "description": "Quarterly revenue growth year-over-year", "type": "number" }, "quoteTimestamp": { "description": "Last quote timestamp", "type": "string" }, "returnOnAssetsTTM": { "description": "Return on Assets over the trailing twelve months (TTM) — net income divided by total assets, as a decimal. How efficiently the company uses its assets to generate profit.", "type": "number" }, "returnOnEquityTTM": { "description": "Return on Equity over the trailing twelve months (TTM) — net income divided by shareholder equity, as a decimal. How efficiently the company generates profit from the money shareholders have put in.", "type": "number" }, "revenuePerShareTTM": { "description": "Revenue per share over the trailing twelve months (TTM) — total revenue divided by shares outstanding.", "type": "number" }, "revenueTTM": { "description": "Revenue over the trailing twelve months (TTM) — total sales over the last four reported quarters, in U.S. dollars.", "type": "number" }, "sector": { "description": "Company sector", "type": "string" }, "sharesOutstanding": { "description": "Shares outstanding", "type": "number" }, "sicCode": { "description": "Standard Industrial Classification code", "type": "string" }, "spread": { "description": "Bid-ask spread", "type": "number" }, "symbol": { "description": "Trading symbol", "type": "string" }, "tick": { "description": "Tick information", "type": "number" }, "tradeTimestamp": { "description": "Last trade timestamp", "type": "string" }, "trailingPE": { "description": "Trailing P/E — current price divided by **actual** earnings per share over the trailing 12 months. The most common P/E figure quoted; compare within the same industry.", "type": "number" } }, "type": "object" }, "ErrorCode": { "properties": { "code": { "description": "Machine-readable error code", "example": "INVALID_PASSWORD", "type": "string" }, "description": { "description": "Human-readable description of the error", "example": "Password must be between 8 and 64 characters", "type": "string" }, "field": { "description": "Field name that caused the error", "example": "password", "type": "string" } }, "type": "object" }, "OptionsUnusualActivityTrade": { "type": "object", "description": "Single options unusual activity trade", "properties": { "symbol": { "type": "string", "description": "Underlying symbol (e.g. AAPL)" }, "timestamp": { "type": "string", "format": "date-time", "description": "Trade timestamp (ISO 8601)" }, "type": { "type": "string", "description": "Provider-supplied unusual activity classification for the trade, such as block, sweep, or split.", "example": "block" }, "total_value": { "type": "number", "description": "Total dollar value of the trade" }, "total_size": { "type": "number", "description": "Total contract size" }, "average_price": { "type": "number", "description": "Average price per contract" }, "contract": { "type": "string", "description": "Option contract identifier" }, "ask_at_execution": { "type": "number", "description": "Ask price at execution" }, "bid_at_execution": { "type": "number", "description": "Bid price at execution" }, "sentiment": { "type": "string", "description": "Sentiment (e.g. bearish, bullish)" }, "underlying_price_at_execution": { "type": "number", "description": "Underlying price at execution" } } }, "OptionsUnusualActivityResponse": { "type": "object", "description": "Response for GET /v1/options/unusual_activity/{symbol}. Contains unusual activity trades and optional pagination pointer.", "properties": { "trades": { "type": "array", "description": "List of unusual options activity trades", "items": { "$ref": "#/components/schemas/OptionsUnusualActivityTrade" } }, "next_page": { "type": "string", "nullable": true, "description": "Absolute link to the next page when more results are available." } } }, "OptionsScreenerItem": { "type": "object", "description": "Option contract details returned by options top-volume and top-gainers endpoints.", "properties": { "symbol": { "type": "string", "description": "Option contract symbol. Use this exact value when requesting option quotes, snapshots, or trades." }, "underlyingSymbol": { "type": "string", "description": "Underlying stock or ETF symbol" }, "logoUrl": { "type": "string", "description": "URL to the underlying company or ETF logo" }, "type": { "type": "string", "description": "Option type returned by the API. `c` = Call; `P` = Put.", "enum": [ "c", "P" ] }, "strike": { "type": "number", "description": "Option strike price. Use it to explain the price level where the option can be exercised." }, "expiry": { "type": "string", "description": "Option expiration date. Use it to group contracts by expiry and show time remaining." }, "volume": { "type": "integer", "format": "int64", "description": "Contracts traded during the current session. Use it to identify active option contracts." }, "openInterest": { "type": "integer", "format": "int64", "description": "Number of outstanding contracts. Use it to estimate option liquidity beyond today's trading volume." }, "lastPrice": { "type": "number", "description": "Most recent traded option price. Use bid and ask when estimating immediate execution cost." }, "change": { "type": "number", "description": "Price change from previous close" }, "changePercent": { "type": "number", "description": "Percentage change from previous close" }, "bid": { "type": "number", "description": "Highest current buyer price for the option. Use it as the reference price when selling." }, "ask": { "type": "number", "description": "Lowest current seller price for the option. Use it as the reference price when buying." }, "impliedVolatility": { "type": "number", "description": "Market-implied volatility for the option. Use it to compare how expensive option premium is across contracts." } }, "example": { "symbol": "AAPL240119C00190000", "underlyingSymbol": "AAPL", "logoUrl": "https://cdn.example.com/logos/AAPL.png", "type": "c", "strike": 190, "expiry": "2024-01-19", "volume": 12500, "openInterest": 45000, "lastPrice": 3.45, "change": 0.22, "changePercent": 6.81, "bid": 3.4, "ask": 3.5, "impliedVolatility": 0.28 } }, "AuthenticationErrorDetail": { "type": "object", "description": "Structured payload for the nested `error` object. Services using the shared Go error writer emit uppercase `type` values aligned with error categories (for example `VALIDATION`, `BAD_REQUEST`, `AUTHENTICATION`, `AUTHORIZATION`, `NOT_FOUND`, `RATE_LIMIT`, `INTERNAL`).", "properties": { "type": { "type": "string", "description": "Error category emitted by the shared error writer, such as VALIDATION, BAD_REQUEST, AUTHENTICATION, AUTHORIZATION, NOT_FOUND, RATE_LIMIT, or INTERNAL.", "example": "AUTHENTICATION" }, "code": { "type": "string", "description": "Machine-readable code", "example": "INVALID_TOKEN" }, "message": { "type": "string", "description": "Error detail as a string. Exact message content is not fixed and should not be hard-coded.", "example": "string" }, "details": { "type": "object", "additionalProperties": true, "description": "Optional extra context" }, "request_id": { "type": "string", "description": "Request correlation id when provided" } } }, "AuthenticationErrorEnvelope": { "type": "object", "description": "JSON envelope where `error` is a nested object (`type`, `code`, `message`, …). Many services use this shape for 400, 401, 403, 404, 429, and 5xx when using the shared HTTP error format.", "properties": { "error": { "$ref": "#/components/schemas/AuthenticationErrorDetail" }, "meta": { "type": "object", "additionalProperties": true, "description": "Optional metadata" } } }, "ErrorResponse": { "properties": { "codes": { "description": "Structured error codes for programmatic handling", "items": { "$ref": "#/components/schemas/ErrorCode" }, "type": "array" }, "error": { "description": "Error detail as a string. Exact message content is not fixed and should not be hard-coded.", "example": "string", "type": "string" }, "metadata": { "additionalProperties": true, "description": "Additional error context", "type": "object" } }, "type": "object" }, "Error": { "description": "Error response (alias for ErrorResponse for compatibility)", "type": "object", "properties": { "error": { "type": "string", "description": "Error detail as a string. Exact message content is not fixed and should not be hard-coded.", "example": "string" }, "codes": { "type": "array", "items": { "$ref": "#/components/schemas/ErrorCode" }, "description": "Structured error codes" }, "metadata": { "type": "object", "additionalProperties": true, "description": "Additional context" } } }, "MarketStatus": { "type": "object", "properties": { "exchange": { "type": "string", "description": "Exchange code (e.g., US, TO, L)" }, "timezone": { "type": "string", "description": "Timezone of the exchange (e.g., America/New_York)" }, "isOpen": { "type": "boolean", "description": "Whether the market is currently open for trading" }, "session": { "type": "string", "description": "Current trading session (pre-market, regular, after-hours, or empty if closed)" }, "timestamp": { "type": "integer", "format": "int64", "description": "Unix timestamp of the status data" } } }, "MarketHolidayResponse": { "type": "object", "properties": { "holidays": { "type": "array", "description": "List of market holidays and special trading days", "items": { "$ref": "#/components/schemas/MarketHoliday" } } } }, "OwnershipDataResponse": { "type": "object", "properties": { "data": { "type": "array", "description": "List of institutional ownership records", "items": { "$ref": "#/components/schemas/OwnershipRecord" } } } }, "InsiderTransactionsResponse": { "type": "object", "properties": { "transactions": { "type": "array", "description": "List of insider trading transactions", "items": { "$ref": "#/components/schemas/InsiderTransaction" } } } }, "InstitutionalPortfolioResponse": { "type": "object", "properties": { "holdings": { "type": "array", "description": "List of holdings in an institutional investor's portfolio", "items": { "$ref": "#/components/schemas/InstitutionalHolding" } } } }, "InstitutionalOwnershipResponse": { "type": "object", "properties": { "data": { "type": "array", "description": "List of institutional ownership records for a security", "items": { "$ref": "#/components/schemas/InstitutionalHolding" } } } }, "FinancialsReportedResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/FinancialsReportedDataWrapper", "description": "Wrapper containing company and filing data" } } }, "FinancialsStatementsResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/FinancialsStatementsDataWrapper", "description": "Wrapper containing financial statements data" } } }, "FinancialsRevenueBreakdownResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/FinancialsRevenueBreakdownDataWrapper" } } }, "CashFlowStatement": { "type": "object", "description": "Single SEC cash flow statement row.", "properties": { "cashFromOperatingActivitiesContinuingOperations": { "type": "number", "format": "double" }, "changeInCashAndEquivalents": { "type": "number", "format": "double" }, "changeInOtherOperatingAssetsAndLiabilitiesNet": { "type": "number", "format": "double" }, "cik": { "type": "string" }, "depreciationDepletionAndAmortization": { "type": "number", "format": "double" }, "dividends": { "type": "number", "format": "double" }, "effectOfCurrencyExchangeRate": { "type": "number", "format": "double" }, "filingDate": { "type": "string" }, "fiscalQuarter": { "type": "number", "format": "double" }, "fiscalYear": { "type": "number", "format": "double" }, "incomeLossFromDiscontinuedOperations": { "type": "number", "format": "double" }, "longTermDebtIssuancesRepayments": { "type": "number", "format": "double" }, "netCashFromFinancingActivities": { "type": "number", "format": "double" }, "netCashFromFinancingActivitiesContinuingOperations": { "type": "number", "format": "double" }, "netCashFromFinancingActivitiesDiscontinuedOperations": { "type": "number", "format": "double" }, "netCashFromInvestingActivities": { "type": "number", "format": "double" }, "netCashFromInvestingActivitiesContinuingOperations": { "type": "number", "format": "double" }, "netCashFromInvestingActivitiesDiscontinuedOperations": { "type": "number", "format": "double" }, "netCashFromOperatingActivities": { "type": "number", "format": "double" }, "netCashFromOperatingActivitiesDiscontinuedOperations": { "type": "number", "format": "double" }, "netIncome": { "type": "number", "format": "double" }, "noncontrollingInterests": { "type": "number", "format": "double" }, "otherCashAdjustments": { "type": "number", "format": "double" }, "otherFinancingActivities": { "type": "number", "format": "double" }, "otherInvestingActivities": { "type": "number", "format": "double" }, "otherOperatingActivities": { "type": "number", "format": "double" }, "periodEnd": { "type": "string" }, "purchaseOfPropertyPlantAndEquipment": { "type": "number", "format": "double" }, "saleOfPropertyPlantAndEquipment": { "type": "number", "format": "double" }, "shortTermDebtIssuancesRepayments": { "type": "number", "format": "double" }, "tickers": { "type": "array", "items": { "type": "string" } }, "timeframe": { "type": "string" } } }, "CashFlowStatementsResponse": { "type": "object", "description": "Paginated SEC cash flow statements (results, status, requestId, nextUrl).", "properties": { "results": { "type": "array", "description": "Cash flow statement rows for the requested filters. Use these to analyze operating, investing, and financing cash flows.", "items": { "$ref": "#/components/schemas/CashFlowStatement" } }, "status": { "type": "string", "description": "Status string from the upstream data provider — typically `OK` for a successful response. Treat any other value as an error indicator alongside the HTTP status code." }, "requestId": { "type": "string", "description": "Provider request identifier. Include this when reporting data issues to support." }, "nextUrl": { "type": "string", "description": "URL for the next page when more results exist" } } }, "IncomeStatement": { "type": "object", "description": "Single SEC income statement row.", "properties": { "basicEarningsPerShare": { "type": "number", "format": "double" }, "basicSharesOutstanding": { "type": "number", "format": "double" }, "cik": { "type": "string" }, "consolidatedNetIncomeLoss": { "type": "number", "format": "double" }, "costOfRevenue": { "type": "number", "format": "double" }, "depreciationDepletionAmortization": { "type": "number", "format": "double" }, "dilutedEarningsPerShare": { "type": "number", "format": "double" }, "dilutedSharesOutstanding": { "type": "number", "format": "double" }, "discontinuedOperations": { "type": "number", "format": "double" }, "ebitda": { "type": "number", "format": "double" }, "equityInAffiliates": { "type": "number", "format": "double" }, "extraordinaryItems": { "type": "number", "format": "double" }, "filingDate": { "type": "string" }, "fiscalQuarter": { "type": "number", "format": "double" }, "fiscalYear": { "type": "number", "format": "double" }, "grossProfit": { "type": "number", "format": "double" }, "incomeBeforeIncomeTaxes": { "type": "number", "format": "double" }, "incomeTaxes": { "type": "number", "format": "double" }, "interestExpense": { "type": "number", "format": "double" }, "interestIncome": { "type": "number", "format": "double" }, "netIncomeLossAttributableCommonShareholders": { "type": "number", "format": "double" }, "noncontrollingInterest": { "type": "number", "format": "double" }, "operatingIncome": { "type": "number", "format": "double" }, "otherIncomeExpense": { "type": "number", "format": "double" }, "otherOperatingExpenses": { "type": "number", "format": "double" }, "periodEnd": { "type": "string" }, "preferredStockDividendsDeclared": { "type": "number", "format": "double" }, "researchDevelopment": { "type": "number", "format": "double" }, "revenue": { "type": "number", "format": "double" }, "sellingGeneralAdministrative": { "type": "number", "format": "double" }, "tickers": { "type": "array", "items": { "type": "string" } }, "timeframe": { "type": "string" }, "totalOperatingExpenses": { "type": "number", "format": "double" }, "totalOtherIncomeExpense": { "type": "number", "format": "double" } } }, "IncomeStatementsResponse": { "type": "object", "description": "Paginated SEC income statements (results, status, requestId, nextUrl).", "properties": { "results": { "type": "array", "description": "Income statement rows for the requested filters. Use these to analyze revenue, expenses, and profitability.", "items": { "$ref": "#/components/schemas/IncomeStatement" } }, "status": { "type": "string", "description": "Status string from the upstream data provider — typically `OK` for a successful response. Treat any other value as an error indicator alongside the HTTP status code." }, "requestId": { "type": "string", "description": "Provider request identifier. Include this when reporting data issues to support." }, "nextUrl": { "type": "string", "description": "URL for the next page when more results exist" } } }, "IndicesRealtimeIndexInfo": { "type": "object", "description": "Index metadata for a realtime quote item.", "properties": { "indexName": { "type": "string", "description": "Display name of the index" }, "symbol": { "type": "string", "description": "Index symbol (e.g. SPX)" }, "indexGroup": { "type": "string", "description": "Index group or venue code (e.g. IND_CBOM)" }, "valoren": { "type": "string", "description": "Valoren / internal identifier" }, "currency": { "type": "string", "description": "Quote currency" } } }, "IndicesRealtimeIndexValue": { "type": "object", "description": "Realtime OHLC and change fields for an index quote.", "properties": { "high52Weeks": { "type": "number", "format": "double", "description": "52-week high" }, "low52Weeks": { "type": "number", "format": "double", "description": "52-week low" }, "date": { "type": "string", "description": "Session date in source format (locale-specific)" }, "time": { "type": "string", "description": "Quote time in source format" }, "utcOffset": { "type": "integer", "description": "UTC offset in hours" }, "volume": { "type": "integer", "format": "int64", "description": "Volume (may be 0 for some indices)" }, "open": { "type": "number", "format": "double" }, "high": { "type": "number", "format": "double" }, "low": { "type": "number", "format": "double" }, "last": { "type": "number", "format": "double", "description": "Last traded value" }, "close": { "type": "number", "format": "double", "description": "Current / last close value" }, "changeFromOpen": { "type": "number", "format": "double" }, "percentChangeFromOpen": { "type": "number", "format": "double" }, "previousClose": { "type": "number", "format": "double" }, "previousCloseDate": { "type": "string", "description": "Prior close date in source format" }, "changeFromPreviousClose": { "type": "number", "format": "double" }, "percentChangeFromPreviousClose": { "type": "number", "format": "double" } } }, "IndicesRealtimeValuesItem": { "type": "object", "description": "One index in the batch realtime values response.", "required": [ "identifier", "identifierType", "index", "value" ], "properties": { "identifier": { "type": "string", "description": "Full index identifier (e.g. SPX.IND_CBOM)" }, "identifierType": { "$ref": "#/components/schemas/TenderOfferIdentifierType" }, "index": { "$ref": "#/components/schemas/IndicesRealtimeIndexInfo" }, "value": { "$ref": "#/components/schemas/IndicesRealtimeIndexValue" } } }, "IndicesRealtimeValuesResponse": { "type": "object", "description": "Batch realtime index quotes returned by GET /v1/indices/realtime/values.", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/IndicesRealtimeValuesItem" }, "description": "One entry per requested identifier" } } }, "SecFilingsResponse": { "type": "object", "properties": { "filings": { "type": "array", "description": "Array of SEC filings", "items": { "$ref": "#/components/schemas/SecFiling" } } } }, "FilingsSimilarityIndexResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/FilingsSimilarityIndexDataWrapper", "description": "Wrapper containing similarity index data" } } }, "IpoCalendarResponse": { "type": "object", "properties": { "ipos": { "type": "array", "items": { "$ref": "#/components/schemas/IpoItem" } } } }, "DividendsResponse": { "type": "object", "properties": { "results": { "type": "array", "description": "Array of dividend payment events.", "items": { "$ref": "#/components/schemas/DividendItem" } }, "nextUrl": { "type": "string", "description": "Opaque pagination URL for the next page of results when more data is available." }, "requestId": { "type": "string", "description": "Provider request identifier for tracing and support." }, "status": { "type": "string", "description": "Provider response status." } } }, "DividendItem": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the dividend event." }, "ticker": { "type": "string", "description": "Stock ticker symbol" }, "cashAmount": { "type": "number", "description": "Original cash dividend amount per share." }, "currency": { "type": "string", "description": "Currency code for the cash amount, such as USD." }, "declarationDate": { "type": "string", "description": "Date when the dividend was announced." }, "exDividendDate": { "type": "string", "description": "Date when the stock begins trading without the dividend." }, "frequency": { "type": "integer", "description": "Times per year the dividend is paid, such as 0, 1, 4, or 12." }, "payDate": { "type": "string", "description": "Date when the dividend payment is distributed." }, "recordDate": { "type": "string", "description": "Record date used to determine shareholder eligibility." }, "distributionType": { "type": "string", "description": "Distribution classification such as recurring, special, supplemental, irregular, or unknown." }, "historicalAdjustmentFactor": { "type": "number", "description": "Adjustment factor used for historical-price normalization." }, "splitAdjustedCashAmount": { "type": "number", "description": "Dividend cash amount adjusted for stock splits." } } }, "FilingSimilarityRecord": { "type": "object", "properties": { "acceptedDate": { "type": "string", "description": "Date when the SEC accepted the filing" }, "accessNumber": { "type": "string", "description": "SEC accession number" }, "cik": { "type": "string", "description": "Central Index Key" }, "filedDate": { "type": "string", "description": "Date when filed with SEC" }, "filingUrl": { "type": "string", "description": "URL to the complete filing" }, "form": { "type": "string", "description": "Type of SEC form" }, "item1": { "type": "number", "description": "Cosine similarity score for Item 1 (Business) section" }, "item1a": { "type": "number", "description": "Cosine similarity score for Item 1A (Risk Factors) section" }, "item2": { "type": "number", "description": "Cosine similarity score for Item 2 (Properties) section" }, "item7": { "type": "number", "description": "Cosine similarity score for Item 7 (MD&A) section" }, "item7a": { "type": "number", "description": "Cosine similarity score for Item 7A (Market Risk) section" }, "reportUrl": { "type": "string", "description": "URL to the formatted report" } } }, "FilingsSimilarityIndexDataWrapper": { "type": "object", "properties": { "cik": { "type": "string", "description": "Central Index Key" }, "similarity": { "type": "array", "description": "Array of filing similarity records with cosine similarity scores", "items": { "$ref": "#/components/schemas/FilingSimilarityRecord" } }, "symbol": { "type": "string", "description": "Stock ticker symbol" } } }, "FinancialStatement": { "type": "object", "properties": { "costOfGoodsSold": { "type": "number", "description": "Direct costs attributable to production of goods sold" }, "dilutedAverageSharesOutstanding": { "type": "number", "description": "Average number of shares outstanding including dilutive securities" }, "dilutedEPS": { "type": "number", "description": "Earnings per share assuming dilution from convertible securities" }, "ebit": { "type": "number", "description": "Earnings Before Interest and Taxes" }, "grossIncome": { "type": "number", "description": "Revenue minus cost of goods sold" }, "interestIncomeExpense": { "type": "number", "description": "Net interest income or expense from debt and investments" }, "netIncome": { "type": "number", "description": "Total profit after all expenses and taxes" }, "netIncomeAfterTaxes": { "type": "number", "description": "Net income after deducting income taxes" }, "nonRecurringItems": { "type": "number", "description": "One-time or unusual items affecting income" }, "period": { "type": "string", "description": "Reporting period in YYYY-MM-DD format" }, "pretaxIncome": { "type": "number", "description": "Income before provision for income taxes" }, "provisionforIncomeTaxes": { "type": "number", "description": "Estimated income tax expense for the period" }, "researchDevelopment": { "type": "number", "description": "Expenses for research and development activities" }, "revenue": { "type": "number", "description": "Total revenue from operations" }, "sgaExpense": { "type": "number", "description": "Selling, General, and Administrative expenses" }, "totalOperatingExpense": { "type": "number", "description": "Sum of all operating expenses" }, "totalOtherIncomeExpenseNet": { "type": "number", "description": "Net of other income and expenses not related to operations" }, "year": { "type": "integer", "description": "Fiscal year of the financial statement" } } }, "FinancialsReportedDataWrapper": { "type": "object", "properties": { "cik": { "type": "string", "description": "Central Index Key assigned by the SEC" }, "data": { "type": "array", "description": "Array of reported filings with financial data", "items": { "$ref": "#/components/schemas/ReportedFiling" } }, "symbol": { "type": "string", "description": "Stock ticker symbol" } } }, "FinancialsRevenueBreakdownDataWrapper": { "type": "object", "properties": { "cik": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/RevenueBreakdownEntry" } }, "symbol": { "type": "string" } } }, "FinancialsStatementsDataWrapper": { "type": "object", "properties": { "financials": { "type": "array", "description": "Array of financial statements for different periods", "items": { "$ref": "#/components/schemas/FinancialStatement" } }, "symbol": { "type": "string", "description": "Stock ticker symbol" } } }, "InsiderTransaction": { "type": "object", "properties": { "symbol": { "type": "string", "description": "Stock ticker symbol" }, "name": { "type": "string", "description": "Name of the insider (executive, director, or beneficial owner)" }, "share": { "type": "integer", "description": "Number of shares involved in the transaction" }, "change": { "type": "integer", "description": "Net change in shares held after the transaction" }, "filingDate": { "type": "string", "description": "Date when the Form 4 was filed with the SEC in YYYY-MM-DD format" }, "transactionDate": { "type": "string", "description": "Date when the transaction occurred in YYYY-MM-DD format" }, "transactionCode": { "type": "string", "description": "SEC transaction code (P=Purchase, S=Sale, A=Award, etc.)" }, "transactionPrice": { "type": "number", "description": "Price per share at which the transaction was executed" } } }, "InstitutionalHolding": { "type": "object", "properties": { "symbol": { "type": "string", "description": "Stock ticker symbol" }, "cusip": { "type": "string", "description": "CUSIP identifier for the security" }, "name": { "type": "string", "description": "Name of the security or company" }, "share": { "type": "integer", "description": "Number of shares held" }, "change": { "type": "integer", "description": "Change in share count from previous quarter" }, "value": { "type": "number", "description": "Market value of the holding in USD" }, "putCall": { "type": "string", "description": "Type of option position (PUT, CALL, or empty for stock positions)" } } }, "IpoItem": { "type": "object", "properties": { "symbol": { "type": "string", "description": "Stock ticker symbol for the IPO" }, "name": { "type": "string", "description": "Company name" }, "date": { "type": "string", "description": "Expected or actual IPO date in YYYY-MM-DD format" }, "exchange": { "type": "string", "description": "Stock exchange where the IPO will list" }, "priceFrom": { "type": "number", "description": "Minimum price per share in the IPO price range" }, "priceTo": { "type": "number", "description": "Maximum price per share in the IPO price range" }, "totalSharesValue": { "type": "number", "description": "Total value of shares offered in the IPO" }, "status": { "type": "string", "description": "IPO status (expected, priced, filed, withdrawn)" } } }, "MarketHoliday": { "type": "object", "properties": { "eventName": { "type": "string", "description": "Name of the holiday or special market event" }, "atDate": { "type": "string", "format": "date", "description": "Date of the holiday in YYYY-MM-DD format" }, "tradingHour": { "type": "string", "description": "Trading hours for the day (e.g., 09:30-13:00 for early close, empty for full closure)" } } }, "OwnershipRecord": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the institutional investor or fund" }, "share": { "type": "integer", "description": "Number of shares held" }, "change": { "type": "integer", "description": "Change in share count from previous filing" }, "filingDate": { "type": "string", "description": "Date of the regulatory filing in YYYY-MM-DD format" }, "source": { "type": "string", "description": "Source of the ownership data (e.g., 13F, 13G)" }, "percentOfShares": { "type": "number", "description": "Percentage of total outstanding shares held" } } }, "ReportedBSItem": { "type": "object", "properties": { "concept": { "type": "string", "description": "XBRL concept tag identifier for the financial line item" }, "label": { "type": "string", "description": "Human-readable label for the financial line item" }, "unit": { "type": "string", "description": "Unit of measurement (e.g., USD, shares)" }, "value": { "type": "number", "description": "Numerical value of the financial line item" } } }, "ReportedFiling": { "type": "object", "properties": { "acceptedDate": { "type": "string", "description": "Date and time when the SEC accepted the filing" }, "accessNumber": { "type": "string", "description": "SEC accession number uniquely identifying the filing" }, "cik": { "type": "string", "description": "Central Index Key assigned by the SEC to the company" }, "endDate": { "type": "string", "description": "End date of the reporting period in YYYY-MM-DD format" }, "filedDate": { "type": "string", "description": "Date when the filing was submitted to the SEC" }, "form": { "type": "string", "description": "Type of SEC form (e.g., 10-K, 10-Q, 8-K)" }, "quarter": { "type": "integer", "description": "Fiscal quarter number (1-4)" }, "report": { "$ref": "#/components/schemas/ReportedReport", "description": "Detailed financial report data" }, "startDate": { "type": "string", "description": "Start date of the reporting period in YYYY-MM-DD format" }, "symbol": { "type": "string", "description": "Stock ticker symbol" }, "year": { "type": "integer", "description": "Fiscal year of the report" } } }, "ReportedReport": { "type": "object", "properties": { "bs": { "type": "array", "description": "Balance sheet line items from the reported financial statements", "items": { "$ref": "#/components/schemas/ReportedBSItem" } } } }, "RevenueBreakdownAxis": { "type": "object", "properties": { "axis": { "type": "string", "description": "XBRL axis identifier (e.g., product line, geography)" }, "data": { "type": "array", "description": "Array of revenue data points for this axis", "items": { "$ref": "#/components/schemas/RevenueBreakdownDataPoint" } }, "label": { "type": "string", "description": "Human-readable label for the axis" } } }, "RevenueBreakdownDataPoint": { "type": "object", "properties": { "label": { "type": "string", "description": "Label for the revenue segment" }, "member": { "type": "string", "description": "XBRL member identifier for the segment" }, "percentage": { "type": "number", "description": "Percentage of total revenue from this segment" }, "unit": { "type": "string", "description": "Unit of measurement (e.g., USD)" }, "value": { "type": "number", "description": "Revenue value for this segment" } } }, "RevenueBreakdownEntry": { "type": "object", "properties": { "accessNumber": { "type": "string", "description": "SEC accession number for the filing" }, "breakdown": { "$ref": "#/components/schemas/RevenueBreakdownInner", "description": "Detailed revenue breakdown data" } } }, "RevenueBreakdownInner": { "type": "object", "properties": { "concept": { "type": "string", "description": "XBRL concept tag for revenue" }, "endDate": { "type": "string", "description": "End date of the reporting period in YYYY-MM-DD format" }, "revenueBreakdown": { "type": "array", "description": "Array of revenue breakdown axes (by product, geography, etc.)", "items": { "$ref": "#/components/schemas/RevenueBreakdownAxis" } }, "startDate": { "type": "string", "description": "Start date of the reporting period in YYYY-MM-DD format" }, "unit": { "type": "string", "description": "Unit of measurement (e.g., USD)" }, "value": { "type": "number", "description": "Total revenue value" } } }, "SecFiling": { "type": "object", "properties": { "accessNumber": { "type": "string", "description": "SEC accession number uniquely identifying the filing" }, "symbol": { "type": "string", "description": "Stock ticker symbol" }, "cik": { "type": "string", "description": "Central Index Key assigned by the SEC" }, "form": { "type": "string", "description": "Type of SEC form (e.g., 10-K, 10-Q, 8-K)" }, "filedDate": { "type": "string", "description": "Date when the filing was submitted to the SEC" }, "acceptedDate": { "type": "string", "description": "Date and time when the SEC accepted the filing" }, "reportUrl": { "type": "string", "description": "URL to the formatted report document" }, "filingUrl": { "type": "string", "description": "URL to the complete filing on SEC EDGAR" } } }, "GetAccountsResponse": { "description": "Response for GET /v2/users/me/accounts", "properties": { "accounts": { "items": { "$ref": "#/components/schemas/AccountItem" }, "type": "array" } }, "type": "object" }, "GetEarningsCalendarResponse": { "description": "Array of earnings releases for the requested date range. Use it to show upcoming or historical earnings events.", "items": { "$ref": "#/components/schemas/EarningRelease" }, "type": "array" }, "GetEconomicsCalendarResponse": { "description": "Economic calendar response for the requested date. Use it to show macroeconomic events that may affect markets.", "properties": { "events": { "items": { "$ref": "#/components/schemas/EconomicsCalendarEvent" }, "type": "array", "description": "List of economic calendar events for the requested date" }, "importantDates": { "items": { "type": "string" }, "type": "array", "description": "Optional list of notable dates" } }, "type": "object", "example": { "events": [ { "calendarID": "te_395222", "date": "2026-03-05", "time": "13:30:00", "country": "United States", "category": "Continuing Jobless Claims", "event": "Continuing Jobless Claims", "importance": 1, "reference": "Feb/21", "referenceDate": "2026-02-21T00:00:00", "previous": "1833K", "forecast": "1850K", "teForecast": "1840.0K", "source": "U.S. Department of Labor", "sourceUrl": "http://www.dol.gov", "unit": "K", "ticker": "UNITEDSTACONJOBCLA", "symbol": "UNITEDSTACONJOBCLA", "lastUpdate": "2026-03-03T10:49:26.58" } ] } }, "EquityDetailsDTO": { "description": "One equity detail object from GET /v1/marketdata/equities/details. Populated from the market-data cache with an automatic fallback. Fields are pointers in the service and omitted from JSON when unset; `hasOptions` and `isETF` are always serialized as booleans. JSON names match the Go tags (e.g. `nyseNetInflow`, `EPSDiluted`, `ytdHighDate`).", "type": "object", "properties": { "symbol": { "type": "string", "description": "Ticker symbol this detail record belongs to. Use it to match the response item back to your requested symbol." }, "type": { "type": "string", "description": "Provider-supplied market data type for this snapshot. Treat this as a feed classification string rather than an order type.", "example": "ETRADE" }, "price": { "type": "number", "description": "Primary display price from the market data feed. Use it for summary cards when you do not need bid/ask detail." }, "openPrice": { "type": "number", "description": "Price at the start of the current trading session. Use it to compare where the stock opened versus where it trades now." }, "highPrice": { "type": "number", "description": "Highest traded price during the current session. Use it for daily range displays." }, "lowPrice": { "type": "number", "description": "Lowest traded price during the current session. Use it for daily range displays." }, "lastPrice": { "type": "number", "description": "Most recent trade price reported by the feed. Use bid and ask instead when estimating immediate buy or sell execution cost." }, "closePrice": { "type": "number", "description": "Previous or latest close price from the feed. Use it as the baseline for daily change calculations." }, "netChange": { "type": "number", "description": "Price change versus the previous close. Use it for daily gain/loss displays." }, "tradeSeq": { "type": "integer", "format": "int64", "description": "Feed sequence number for the last trade. Use it only for advanced debugging or ordering feed updates." }, "size": { "type": "integer", "format": "int64", "description": "Number of shares or contracts in the last reported trade." }, "totalVolume": { "type": "integer", "format": "int64", "description": "Total shares or contracts traded during the current session. Use it to show liquidity and activity." }, "tick": { "type": "integer", "format": "int64", "description": "Feed tick direction or tick value when provided. Use it only when your UI needs trade direction indicators." }, "tradeTimestamp": { "type": "string", "description": "Trade timestamp string from feed" }, "tradeExchange": { "type": "string", "description": "Exchange or venue where the last trade was reported. Use it for advanced quote detail displays." }, "bidPrice": { "type": "number", "description": "Highest current price buyers are offering. Use this as the reference price when the user is selling." }, "askPrice": { "type": "number", "description": "Lowest current price sellers are asking. Use this as the reference price when the user is buying." }, "bidSize": { "type": "integer", "format": "int64", "description": "Number of shares or contracts available at the current bid price." }, "askSize": { "type": "integer", "format": "int64", "description": "Number of shares or contracts available at the current ask price." }, "bidExchange": { "type": "string", "description": "Exchange or venue currently showing the best bid. Use it for quote detail or market-structure displays." }, "askExchange": { "type": "string", "description": "Exchange or venue currently showing the best ask. Use it for quote detail or market-structure displays." }, "quoteTimestamp": { "type": "string", "description": "Time the bid/ask quote was reported by the feed. Use it to show quote freshness." }, "spread": { "type": "number", "description": "Difference between ask and bid. Use it to explain immediate trading cost on a market order." }, "midPrice": { "type": "number", "description": "Midpoint between bid and ask. Use it as a neutral reference price, not as a guaranteed execution price." }, "advancers": { "type": "integer", "format": "int32", "description": "Market breadth advancers (if present)" }, "decliners": { "type": "integer", "format": "int32", "description": "Number of symbols declining in the related market-breadth snapshot." }, "unchanged": { "type": "integer", "format": "int32", "description": "Number of symbols unchanged in the related market-breadth snapshot." }, "totalSymbols": { "type": "integer", "format": "int32", "description": "Total symbols counted in the market-breadth snapshot." }, "nasdaqNetInFlow": { "type": "number", "description": "Net buy versus sell flow for Nasdaq-listed activity when provided by the feed." }, "nasdaqBuyVolume": { "type": "integer", "format": "int64", "description": "Reported Nasdaq buy-side volume. Use it only for advanced market-flow displays." }, "nasdaqSellVolume": { "type": "integer", "format": "int64", "description": "Reported Nasdaq sell-side volume. Use it only for advanced market-flow displays." }, "nyseNetInflow": { "type": "number", "description": "Net buy versus sell flow for NYSE-listed activity when provided by the feed." }, "nyseBuyVolume": { "type": "integer", "format": "int64", "description": "Reported NYSE buy-side volume. Use it only for advanced market-flow displays." }, "nyseSellVolume": { "type": "integer", "format": "int64", "description": "Reported NYSE sell-side volume. Use it only for advanced market-flow displays." }, "instrumentType": { "type": "string", "description": "Instrument category returned by the market data provider, such as Equity or Option. Use it to choose the right UI treatment." }, "changeStatus": { "type": "string", "description": "Feed-provided status describing the latest price movement when available." }, "underlyingSymbol": { "type": "string", "description": "Underlying symbol (options)" }, "strikePrice": { "type": "number", "description": "Option strike price. Present for option instruments and empty for normal equities." }, "expirationDate": { "type": "string", "description": "Option expiration date. Present for option instruments and empty for normal equities." }, "putCall": { "type": "string", "description": "Option contract type. Empty for non-option instruments. Accepts long or short form:\n- `CALL` or `C` — call option (right to buy at strike).\n- `PUT` or `P` — put option (right to sell at strike).", "enum": [ "PUT", "CALL", "P", "C" ] }, "name": { "type": "string", "description": "Company or instrument name" }, "sicCode": { "type": "integer", "format": "int64", "description": "Standard Industrial Classification code for the company. Use it for industry classification or filtering." }, "hasOptions": { "type": "boolean", "description": "Whether the underlying has listed options" }, "isETF": { "type": "boolean", "description": "Whether the instrument is an ETF" }, "yearEndClose": { "type": "number", "description": "Closing price at the prior year end when available. Use it for year-to-date comparisons." }, "beta": { "type": "number", "description": "Measure of the stock's volatility relative to the broader market. Values above 1 usually move more than the market; below 1 usually move less." }, "sharesOutstanding": { "type": "integer", "format": "int64", "description": "Total company shares outstanding. Use it in market capitalization and ownership calculations." }, "shortInterest": { "type": "integer", "format": "int64", "description": "Shares currently sold short when available. Use it to show bearish positioning or short-interest analysis." }, "pctHeldByInstitution": { "type": "number", "description": "Percent held by institutions" }, "assets": { "type": "number", "description": "Total assets reported for the company. Use it for balance-sheet and financial-strength views." }, "liabilities": { "type": "number", "description": "Total liabilities reported for the company. Use it with assets to evaluate balance-sheet leverage." }, "longTermDebt": { "type": "number", "description": "Long-term debt reported for the company. Use it when evaluating leverage and financial risk." }, "EPSCurrentQtrMeanEst": { "type": "number", "description": "EPS current quarter mean estimate" }, "EPSCurrentYearMeanEst": { "type": "number", "description": "EPS current year mean estimate" }, "EPSDiluted": { "type": "number", "description": "Diluted earnings per share. Use it for profitability and valuation displays." }, "EPSLatest12Month": { "type": "number", "description": "Earnings per share over the latest 12 months. Use it for trailing profitability calculations." }, "EPS3YearGrowthRate": { "type": "number", "description": "Three-year earnings-per-share growth rate. Use it to show medium-term earnings growth." }, "EPS5YearGrowthRate": { "type": "number", "description": "Five-year earnings-per-share growth rate. Use it to show longer-term earnings growth." }, "avgVolume4Weeks": { "type": "integer", "format": "int64", "description": "Average trading volume over the last four weeks. Use it to judge liquidity versus today's volume." }, "marketCap": { "type": "integer", "format": "int64", "description": "Company market value. Use it for company size, peer comparison, and screening." }, "PE": { "type": "number", "description": "Price-to-earnings ratio. Use it as a valuation metric, especially when comparing companies in the same industry." }, "annualYield": { "type": "number", "description": "Annual yield, typically dividend yield when provided. Use it for income-oriented displays." }, "high52WeekDate": { "type": "string", "description": "Date when the instrument reached its 52-week high. Use it with `high52WeekPrice`." }, "low52WeekDate": { "type": "string", "description": "Date when the instrument reached its 52-week low. Use it with `low52WeekPrice`." }, "high52WeekPrice": { "type": "number", "description": "Highest price over the last 52 weeks. Use it to show how close the current price is to its yearly high." }, "low52WeekPrice": { "type": "number", "description": "Lowest price over the last 52 weeks. Use it to show how close the current price is to its yearly low." }, "ytdHighDate": { "type": "string", "description": "Date when the instrument reached its year-to-date high." }, "ytdLowDate": { "type": "string", "description": "Date when the instrument reached its year-to-date low." }, "ytdHigh": { "type": "number", "description": "Highest price since the start of the current calendar year." }, "ytdLow": { "type": "number", "description": "Lowest price since the start of the current calendar year." }, "openInterest": { "type": "integer", "format": "int64", "description": "Number of outstanding option contracts for this contract. Use it to gauge options liquidity." }, "dividend": { "type": "number", "description": "Dividend amount when provided. Use it in income and yield displays." }, "shortSaleRestricted": { "type": "integer", "format": "int64", "description": "Short sale restricted flag/value" } } }, "OptionDetailsDTO": { "type": "object", "description": "One option contract's pricing snapshot from GET /v1/marketdata/options/details. Numeric prices are returned as JSON numbers.", "properties": { "symbol": { "type": "string", "description": "OSI option symbol for the contract.", "example": "GOOG270115C00285000" }, "lastPrice": { "type": "number", "description": "Last traded price for the contract.", "example": 79.76 }, "bidPrice": { "type": "number", "description": "Current best bid price.", "example": 78.05 }, "askPrice": { "type": "number", "description": "Current best ask price.", "example": 80.9 }, "midPrice": { "type": "number", "description": "Midpoint between the bid and ask prices.", "example": 79.475 }, "closePrice": { "type": "number", "description": "Previous session's closing price.", "example": 93.5 } } }, "GetOptionDetailsResponse": { "description": "Wrapper for GET /v1/marketdata/options/details: `data` for successful symbols, `errors` when applicable.", "properties": { "data": { "description": "Option contracts that returned a pricing snapshot", "items": { "$ref": "#/components/schemas/OptionDetailsDTO" }, "type": "array" }, "errors": { "description": "Per-symbol error entries when a requested symbol cannot be included in `data`", "items": { "$ref": "#/components/schemas/SymbolError" }, "type": "array" } }, "type": "object", "example": { "data": [ { "symbol": "GOOG270115C00285000", "lastPrice": 79.76, "bidPrice": 78.05, "askPrice": 80.9, "midPrice": 79.475, "closePrice": 93.5 } ], "errors": [] } }, "GetEquityDetailsResponse": { "description": "Wrapper for GET /v1/marketdata/equities/details: `data` for successful symbols, `errors` when applicable.", "properties": { "data": { "description": "Symbols that returned a non-empty snapshot with valid quote data", "items": { "$ref": "#/components/schemas/EquityDetailsDTO" }, "type": "array" }, "errors": { "description": "Per-symbol error entries when a requested symbol cannot be included in `data`", "items": { "$ref": "#/components/schemas/SymbolError" }, "type": "array" } }, "type": "object", "example": { "data": [ { "symbol": "AAPL", "type": "ETRADE", "price": 267.53, "openPrice": 272.78, "highPrice": 273.06, "lowPrice": 269.65, "lastPrice": 271.06, "closePrice": 273.43, "netChange": -3.53, "tradeSeq": 1009904, "size": 1, "totalVolume": 300562, "tick": 0, "tradeTimestamp": "2026-04-27T05:38:10.674000-04:00", "tradeExchange": "PACF|NYSE ARCA (Pacific)", "bidPrice": 267.5, "askPrice": 268, "bidSize": 1400, "askSize": 500, "bidExchange": "EDGX|Direct Edge X", "askExchange": "BATS|BATS Trading", "quoteTimestamp": "2026-04-27T05:38:09.901000-04:00", "spread": 0.5, "midPrice": 267.75, "instrumentType": "Equity", "name": "Apple Inc.", "sicCode": 3663, "hasOptions": true, "isETF": false, "sharesOutstanding": 14681140, "assets": 379297000, "liabilities": 291107000, "longTermDebt": 905090000, "EPSDiluted": 2.84, "EPSLatest12Month": 18.3333, "EPS3YearGrowthRate": 17.6111, "EPS5YearGrowthRate": 11.0713, "avgVolume4Weeks": 38174153, "marketCap": 30064771072, "PE": 32.181, "high52WeekDate": "2025-12-03T00:00:00Z", "low52WeekDate": "2025-04-08", "high52WeekPrice": 288.62, "low52WeekPrice": 169.2101, "dividend": 0.26, "shortSaleRestricted": 0 } ], "errors": [] } }, "GetHistoricalDataResponse": { "description": "Historical economic indicator data returned as an array. Use it to chart macroeconomic time series.", "items": { "$ref": "#/components/schemas/EconomicsIndicator" }, "type": "array", "example": [ { "category": "Employment", "country": "US", "dateTime": "2026-01-15T08:30:00Z", "frequency": "monthly", "historicalDataSymbol": "USURTOT", "lastUpdate": "2026-01-15T08:30:00Z", "value": 3.7 } ] }, "GetMeResponse": { "description": "Current user profile for GET /v1/users/me. The API returns these user fields only; it does not include `account_application` (that object appears on account-oriented responses such as GET /v1/users/me/accounts). Optional fields may be omitted when empty.", "properties": { "avatar_url": { "type": "string", "description": "User avatar URL or identifier" }, "country": { "type": "string", "description": "User's country" }, "created_at": { "format": "date-time", "type": "string", "description": "Timestamp when user was created" }, "email": { "type": "string", "description": "User's email address" }, "email_verified": { "type": "boolean", "description": "Whether the email has been verified" }, "id": { "format": "int64", "type": "integer", "description": "Unique user identifier" }, "plaid_status": { "type": "string", "description": "Status of Plaid integration" }, "primary_phone_number": { "type": "string", "description": "User's primary phone number" }, "updated_at": { "format": "date-time", "type": "string", "description": "Timestamp when user was last updated" } }, "type": "object" }, "GetOrdersResponse": { "type": "object", "description": "Response for GET /v2/accounts/{id}/orders. Contains recent cached orders for the account plus data availability metadata.", "properties": { "orders": { "type": "array", "description": "Recent orders for the account", "items": { "$ref": "#/components/schemas/AccountOrder" } }, "availability": { "$ref": "#/components/schemas/DataAvailability" } }, "example": { "orders": [ { "orderId": "ord-7f3a9c2e-0001", "clOrdId": "clord-20260115-aapl-001", "accountId": "TEST-ACCOUNT-001", "clientId": "demo-oauth-client", "symbol": "AAPL", "side": "BUY", "orderType": "LIMIT", "status": "WORKING", "tif": "DAY", "quantity": "100", "filledQty": "0", "leavesQty": "100", "price": "175.50", "stopPrice": "", "avgPrice": "0", "currency": "USD", "destination": "NASDAQ", "instrument": "EQUITY", "category": "EQUITY", "text": "Demo order snapshot", "legs": [ { "symbol": "AAPL", "side": "BUY", "ratioQty": "1", "positionEffect": "OPEN", "securityType": "CS", "maturity": "", "strikePrice": "", "putCall": "" } ], "createdAt": "2026-01-15T14:30:00Z", "updatedAt": "2026-01-15T14:30:05Z" } ], "availability": { "available": true, "source": "cache" } } }, "GetPositionsResponse": { "type": "object", "description": "Response for GET /v1/accounts/{id}/positions. Cached positions for the account. Numeric amounts are returned as decimal strings.", "properties": { "positions": { "type": "array", "description": "Open positions for the account", "items": { "$ref": "#/components/schemas/AccountPosition" } } }, "example": { "positions": [ { "accountId": "TEST-ACCOUNT-001", "symbol": "AAPL", "securityType": "EQUITY", "quantity": "100", "averagePrice": "170.25", "todayRealizedPnL": "0", "unrealizedPl": "515.00", "todayPl": "125.00", "createdAt": "2026-01-10T16:00:00Z" } ] } }, "AnalystInsightItem": { "type": "object", "description": "Single analyst insight (GET /v1/analytics/insights).", "properties": { "id": { "type": "string", "description": "Unique insight identifier. Use it for linking, deduping, or storing this analyst insight." }, "date": { "type": "string", "description": "Date the analyst insight was published. Use it to sort or filter recent analyst changes." }, "updated": { "type": "integer", "format": "int64", "description": "Last updated timestamp from the data provider. Use it to know whether a stored insight has changed." }, "action": { "type": "string", "description": "Analyst action such as upgrade, downgrade, initiation, or reiteration. Use it to explain what changed." }, "rating": { "type": "string", "description": "Analyst rating label such as Buy, Hold, or Sell. Use it as the business recommendation text." }, "ratingId": { "type": "string", "description": "Provider identifier for the rating record. Use it for deduping or linking insight data to rating data." }, "pt": { "type": "string", "description": "Analyst price target as a decimal string. Use it to show expected upside or downside versus the current price." }, "firm": { "type": "string", "description": "Research firm that published the insight. Show this so users know the source." }, "firmId": { "type": "string", "description": "Provider identifier for the research firm. Use it for filtering or grouping by firm." }, "analystInsights": { "type": "string", "description": "Plain-English analyst note or summary. Show this as the explanation behind the rating action." }, "security": { "type": "object", "description": "Security metadata for the company or instrument this analyst insight covers.", "properties": { "cik": { "type": "string" }, "exchange": { "type": "string", "description": "Exchange code where the data originates. Format depends on the upstream data source and may use MIC, ISO 10383, or a vendor-specific code." }, "isin": { "type": "string" }, "name": { "type": "string" }, "symbol": { "type": "string" } } } }, "example": { "id": "insight-001", "date": "2026-01-10", "updated": 1736534400, "action": "Upgrade", "rating": "Buy", "ratingId": "r-8821", "pt": "210.00", "firm": "Demo Research", "firmId": "firm-42", "analystInsights": "Raised price target on stronger services revenue.", "security": { "cik": "0000320193", "exchange": "NASDAQ", "isin": "US0378331005", "name": "Apple Inc.", "symbol": "AAPL" } } }, "GetRatingsResponse": { "description": "Response for GET /v1/analytics/ratings. Only non-empty fields appear in each rating; notes and ratings_accuracy are omitted when empty.", "properties": { "ratings": { "description": "Array of analyst rating objects", "items": { "$ref": "#/components/schemas/Rating" }, "type": "array" } }, "type": "object", "example": { "ratings": [ { "id": "rate-1001", "date": "2026-01-12", "time": "09:45:00", "ticker": "AAPL", "exchange": "NASDAQ", "name": "Apple Inc.", "currency": "USD", "action_pt": "raised", "action_company": "maintain", "rating_current": "Buy", "rating_prior": "Hold", "pt_current": 210, "pt_current_adjusted": 208.5, "pt_prior": 195, "pt_prior_adjusted": 194, "analyst": "jdoe", "analyst_id": "an-9001", "analyst_name": "Jane Doe", "ratings_accuracy": { "smart_score": 72.5, "success_rate": 0.68, "total_ratings": 140, "gain_count_1m": 8, "loss_count_1m": 3, "avg_return_1m": 0.021, "std_dev_return_1m": 0.045, "gain_count_3m": 22, "loss_count_3m": 9, "avg_return_3m": 0.055, "std_dev_return_3m": 0.09, "gain_count_9m": 58, "loss_count_9m": 21, "avg_return_9m": 0.12, "std_dev_return_9m": 0.14, "gain_count_1y": 72, "loss_count_1y": 28, "avg_return_1y": 0.18, "std_dev_return_1y": 0.22, "gain_count_2y": 130, "loss_count_2y": 48, "avg_return_2y": 0.31, "std_dev_return_2y": 0.28, "gain_count_3y": 180, "loss_count_3y": 65, "avg_return_3y": 0.42, "std_dev_return_3y": 0.33 }, "importance": 2, "notes": "Services outlook improved.", "updated": "2026-01-12T09:45:00Z" } ] } }, "StockScreenerRequest": { "type": "object", "description": "Request body for POST /v1/stock/screener. At least one of clauses or groups must be non-empty.", "required": [ "operator" ], "properties": { "operator": { "type": "string", "description": "Logical operator for combining clauses: AND, OR, or NOT", "enum": [ "AND", "OR", "NOT" ] }, "clauses": { "type": "array", "description": "List of filter conditions (field, operator, value). Required unless groups is non-empty.", "items": { "$ref": "#/components/schemas/ScreenClause" } }, "groups": { "type": "array", "description": "Optional nested groups of clauses for complex logic", "items": { "$ref": "#/components/schemas/ScreenGroup" } } } }, "ScreenClause": { "type": "object", "description": "One filter condition: field name, comparison operator, and value (string).", "required": [ "field", "operator", "value" ], "properties": { "field": { "type": "string", "description": "Screener field name (e.g. marketcap, pricetoearnings, roe, volume, open_price, dilutedeps, cashandequivalents)" }, "operator": { "type": "string", "description": "Comparison: eq, gt, gte, lt, lte, contains", "enum": [ "eq", "gt", "gte", "lt", "lte", "contains" ] }, "value": { "type": "string", "description": "Value to compare against (e.g. 1000000000, 0.15)" } } }, "ScreenGroup": { "type": "object", "description": "Nested group of clauses with its own operator (AND, OR, NOT).", "properties": { "operator": { "type": "string", "enum": [ "AND", "OR", "NOT" ], "description": "How the clauses inside this group are combined:\n- `AND` — every clause in the group must match (logical AND).\n- `OR` — at least one clause in the group must match (logical OR).\n- `NOT` — negate the clause inside the group (logical NOT)." }, "clauses": { "type": "array", "items": { "$ref": "#/components/schemas/ScreenClause" } } } }, "StockScreenerResponse": { "type": "array", "description": "Array of screened securities; each element has security (identity and metadata) and data (array of tag/value pairs for screened fields)", "items": { "type": "object", "properties": { "security": { "type": "object", "description": "Security identity and metadata", "properties": { "id": { "type": "string", "description": "Security ID" }, "company_id": { "type": "string", "nullable": true }, "stock_exchange_id": { "type": "string", "nullable": true }, "exchange": { "type": "string", "nullable": true }, "exchange_mic": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "code": { "type": "string", "nullable": true }, "currency": { "type": "string", "nullable": true }, "ticker": { "type": "string", "nullable": true }, "composite_ticker": { "type": "string", "nullable": true }, "figi": { "type": "string", "nullable": true }, "composite_figi": { "type": "string", "nullable": true }, "share_class_figi": { "type": "string", "nullable": true }, "primary_listing": { "type": "boolean", "nullable": true } } }, "data": { "type": "array", "description": "Screened data-tag values (e.g. pricetoearnings, marketcap)", "items": { "type": "object", "properties": { "tag": { "type": "string", "description": "Data tag name (e.g. pricetoearnings, marketcap)" }, "number_value": { "type": "number", "nullable": true }, "text_value": { "type": "string", "nullable": true } } } } } } }, "HealthResponse": { "properties": { "status": { "description": "Service health indicator. Typical values: `healthy`, `degraded`, `unhealthy`.", "example": "healthy", "type": "string" } }, "type": "object" }, "InitAuthRequest": { "properties": { "email": { "description": "User email address", "example": "user@example.com", "type": "string" }, "password": { "description": "User password", "maxLength": 20, "minLength": 8, "pattern": "^(?=.*[a-z])(?=.*[A-Z])(?=.*\\d)(?=.*[@$!%*?&])[A-Za-z\\d@$!%*?&]{8,}$", "type": "string" } }, "required": [ "email", "password" ], "type": "object" }, "InitAuthResponse": { "properties": { "access_token": { "description": "JWT access token", "type": "string" }, "refresh_token": { "description": "JWT refresh token", "type": "string" }, "role": { "description": "User role", "type": "string" } }, "type": "object" }, "OAuth2TokenAuthorizationCodeRequest": { "title": "Authorization Code", "type": "object", "description": "Use this when your app has a backend server and can safely store a client secret. Exchange a one-time authorization code for tokens by sending `client_secret`.", "properties": { "client_id": { "type": "string", "description": "OAuth2 client identifier." }, "client_secret": { "type": "string", "description": "OAuth2 client secret for confidential server-side apps." }, "code": { "type": "string", "description": "Authorization code returned from the authorize or confirm flow." }, "grant_type": { "type": "string", "description": "Grant type for code exchange. The backend accepts `authorization_code` and normalizes it internally.", "enum": [ "code", "authorization_code" ], "example": "authorization_code" }, "redirect_uri": { "type": "string", "description": "Redirect URI used earlier in the login flow. Must match exactly.", "example": "https://yourapp.com/callback" } }, "required": [ "client_id", "client_secret", "code", "grant_type", "redirect_uri" ] }, "OAuth2TokenPkceRequest": { "title": "PKCE", "type": "object", "description": "Use this when your app runs in the browser or on a mobile device and cannot safely store a client secret. Exchange a one-time authorization code by sending `code_verifier` instead of `client_secret`.", "properties": { "client_id": { "type": "string", "description": "OAuth2 client identifier." }, "code": { "type": "string", "description": "Authorization code returned from the authorize or confirm flow." }, "grant_type": { "type": "string", "description": "Grant type for PKCE code exchange. The backend accepts `authorization_code` and normalizes it internally.", "enum": [ "code", "authorization_code" ], "example": "authorization_code" }, "redirect_uri": { "type": "string", "description": "Redirect URI used earlier in the login flow. Must match exactly.", "example": "https://yourapp.com/callback" }, "code_verifier": { "type": "string", "description": "Original PKCE verifier generated by your app before redirecting the user." } }, "required": [ "client_id", "code", "grant_type", "redirect_uri", "code_verifier" ] }, "OAuth2TokenRefreshRequest": { "title": "Refresh Token", "type": "object", "description": "Use this after you already have tokens and only need a fresh access token. Send the refresh token previously issued by Aries.", "properties": { "client_id": { "type": "string", "description": "OAuth2 client identifier." }, "client_secret": { "type": "string", "description": "OAuth2 client secret used for refresh requests." }, "grant_type": { "type": "string", "description": "Grant type for refreshing an expired access token.", "enum": [ "refresh_token" ], "example": "refresh_token" }, "refresh_token": { "type": "string", "description": "Refresh token previously issued by Aries." } }, "required": [ "client_id", "client_secret", "grant_type", "refresh_token" ] }, "OAuth2TokenResponse": { "type": "object", "description": "OAuth2 token response. Fields may vary slightly by flow and server behavior, so response properties are documented without a required list.", "properties": { "access_token": { "type": "string", "description": "OAuth2 access token used in the Authorization header." }, "refresh_token": { "type": "string", "description": "Refresh token used to obtain a new access token later." }, "token_type": { "type": "string", "description": "Token type returned by the server, typically Bearer.", "example": "Bearer" }, "expires_in": { "type": "integer", "description": "Access token lifetime in seconds.", "example": 3600 }, "refresh_token_expires_in": { "type": "integer", "description": "Refresh token lifetime in seconds.", "example": 2592000 }, "scope": { "type": "string", "description": "Space-separated scopes granted for this token.", "example": "read write" } } }, "Leg": { "description": "One leg in a multi-leg option order. Use this only when the order contains more than one contract or leg.", "properties": { "positionEffect": { "description": "Whether this leg opens a new position or closes an existing one. Use `OPEN` for new exposure and `CLOSE` when reducing or exiting a position.", "type": "string", "enum": [ "OPEN", "CLOSE" ] }, "ratioQuantity": { "description": "Quantity ratio for this leg. Use `1` for a standard one-to-one spread leg and larger values for uneven strategies.", "type": "string" }, "symbol": { "description": "Exact contract symbol for this leg. For options, enter the full option contract symbol from search or option-chain data.", "type": "string" }, "tradeAction": { "description": "Direction for this leg. BUY purchases the contract; SELL sells or writes the contract.", "type": "string", "enum": [ "BUY", "SELL", "SELL_SHORT", "BUY_TO_COVER" ] } }, "required": [ "symbol", "ratioQuantity", "tradeAction", "positionEffect" ], "type": "object" }, "MarketBreadth": { "description": "Market breadth snapshot showing how many symbols are rising, falling, or unchanged. Use it to summarize overall market participation.", "properties": { "advanceDeclineRatio": { "description": "Ratio of advancers to decliners", "type": "number" }, "advancers": { "description": "Number of advancing stocks", "format": "uint64", "type": "integer" }, "advancersPercent": { "description": "Percentage of tracked symbols that are advancing. Use this to show how broad the market move is.", "type": "number" }, "decliners": { "description": "Number of declining stocks", "format": "uint64", "type": "integer" }, "declinersPercent": { "description": "Percentage of tracked symbols that are declining. Use this with advancers percent for market breadth displays.", "type": "number" }, "timestamp": { "description": "Data timestamp in ISO 8601 format; fractional seconds may be present (for example microseconds).", "type": "string" }, "totalSymbols": { "description": "Total number of symbols included in the breadth calculation.", "format": "uint64", "type": "integer" }, "unchanged": { "description": "Number of unchanged stocks", "format": "uint64", "type": "integer" } }, "type": "object", "example": { "advanceDeclineRatio": 1.85, "advancers": 2840, "advancersPercent": 62.5, "decliners": 1532, "declinersPercent": 33.7, "timestamp": "2026-03-09T13:48:11.726532Z", "totalSymbols": 4544, "unchanged": 172 } }, "NetInflow": { "description": "Net market inflow snapshot for Nasdaq and NYSE. Use it to show whether reported flow is net buying or net selling.", "properties": { "nasdaqNetInflow": { "description": "Net inflow value for Nasdaq activity. Positive values indicate net buying flow; negative values indicate net selling flow.", "type": "number" }, "nasdaqTradeCount": { "description": "Number of Nasdaq trades included in the inflow calculation.", "format": "uint64", "type": "integer" }, "nyseNetInflow": { "description": "Net inflow value for NYSE activity. Positive values indicate net buying flow; negative values indicate net selling flow.", "type": "number" }, "nyseTradeCount": { "description": "Number of NYSE trades included in the inflow calculation.", "format": "uint64", "type": "integer" }, "timestamp": { "description": "Data timestamp in ISO 8601 format; fractional seconds may be present (for example microseconds).", "type": "string" } }, "type": "object", "example": { "nasdaqNetInflow": 125000000.5, "nasdaqTradeCount": 8500000, "nyseNetInflow": 98000000.25, "nyseTradeCount": 6200000, "timestamp": "2026-03-09T13:48:11.726532Z" } }, "DataAvailability": { "type": "object", "description": "Metadata for cached account data: whether values are available and their source.", "properties": { "available": { "type": "boolean", "description": "Whether the requested data is currently available" }, "source": { "$ref": "#/components/schemas/OrdersV2Source" }, "errorMessage": { "type": "string", "description": "Present when data could not be loaded. Omitted when empty (`omitempty` in the trading API)." } } }, "AccountOrderLeg": { "type": "object", "description": "Single leg of a multi-leg order (spreads, options, etc.).", "properties": { "symbol": { "type": "string", "description": "Symbol for this leg. For options, use the exact option contract symbol returned by symbol search or the order response." }, "side": { "$ref": "#/components/schemas/OrderSideEnum" }, "ratioQty": { "type": "string", "description": "Quantity ratio for this leg inside the strategy, returned as a decimal string. Use it to display spread structure such as 1-by-1 or 1-by-2." }, "positionEffect": { "type": "string", "description": "Whether this leg opens a new position or closes an existing one. Accepts long or short form:\n- `O` or `OPEN` — opens a new position (or increases an existing one).\n- `C` or `CLOSE` — closes an existing position (or reduces it).", "enum": [ "O", "C", "OPEN", "CLOSE" ] }, "securityType": { "type": "string", "description": "Instrument class for this leg:\n- `CS` — common stock (equity / ETF).\n- `OPT` — option contract.", "enum": [ "CS", "OPT" ] }, "maturity": { "type": "string", "description": "Option expiration date for this leg. Present for option legs and omitted or empty for stock legs." }, "strikePrice": { "type": "string", "description": "Option strike price for this leg, returned as a decimal string. Present only for option legs." }, "putCall": { "type": "string", "description": "Option type for this leg: PUT or CALL. Present only for option legs.", "enum": [ "PUT", "CALL", "P", "C" ] } } }, "AccountOrder": { "type": "object", "description": "One order in the account orders list. Numeric quantities and prices are returned as decimal strings.", "properties": { "orderId": { "type": "string", "description": "Platform or broker order identifier. Use this for support and reconciliation; for replace or cancel flows, prefer the client order ID when the endpoint asks for it." }, "clOrdId": { "type": "string", "description": "Client order ID assigned to the order. Store this value because replace, cancel, and streaming update flows commonly use it to match the same order." }, "accountId": { "type": "string", "description": "Account that owns this order. Match it to the user's selected account before showing order status or allowing order actions." }, "clientId": { "type": "string", "description": "Optional client/application identifier attached to the order. Use it to trace which app or internal workflow submitted the order." }, "symbol": { "type": "string", "description": "Primary symbol traded by the order. Use this to link the order to quotes, charts, and position data." }, "side": { "type": "string", "description": "Which direction this order was placed in:\n- `BUY` — bought shares or contracts (opens a long position or closes a short).\n- `SELL` — sold existing holdings (closes a long position).\n- `SELL_SHORT` — sold shares not owned (opens a short position).\n- `BUY_TO_COVER` — bought back shares to close an existing short position.", "enum": [ "BUY", "SELL", "SELL_SHORT", "BUY_TO_COVER" ] }, "orderType": { "type": "string", "description": "How the order is priced:\n- `MARKET` — executes immediately at the best available price (no price control, but guaranteed to fill while the market is open).\n- `LIMIT` — executes only at `price` or better. Uses `price`.\n- `STOP` — sits inactive until the market touches `stopPrice`, then becomes a market order. Uses `stopPrice`.\n- `STOP_LIMIT` — sits inactive until the market touches `stopPrice`, then becomes a limit order at `price`. Uses both `stopPrice` and `price`.", "enum": [ "MARKET", "LIMIT", "STOP", "STOP_LIMIT" ] }, "status": { "type": "string", "description": "High-level lifecycle bucket for the order. (For fine-grained states — NEW, FILLED, PARTIALLY_FILLED, etc. — see `ordStatus` on the v2 order shape.)\n- `active` — order is live and may still execute (working, partially filled, etc.).\n- `inactive` — order is done (filled, cancelled, rejected, or expired) and will not execute further.\n- `suspended` — order is temporarily halted by the broker or exchange (e.g. the symbol is in a trading halt).", "enum": [ "active", "inactive", "suspended" ] }, "tif": { "type": "string", "description": "How long the order stays alive before automatically cancelling (Time-in-Force):\n- `DAY` — active until the end of today's regular trading session. The most common choice.\n- `GTC` — Good 'Til Cancelled. Stays open across trading days until you cancel it (broker may cap at 60–90 days).\n- `IOC` — Immediate Or Cancel. Fill whatever you can right now; cancel the rest immediately. Partial fills allowed.\n- `FOK` — Fill Or Kill. Fill the entire order immediately or cancel it entirely. No partial fills.", "enum": [ "DAY", "GTC", "IOC", "FOK" ] }, "quantity": { "type": "string", "description": "Original order size as a decimal string. Use this with filled and remaining quantity to show progress." }, "filledQty": { "type": "string", "description": "Total quantity already executed, returned as a decimal string. Use this to show partial fills." }, "leavesQty": { "type": "string", "description": "Quantity still open and waiting to execute, returned as a decimal string. A value of zero usually means the order is fully filled or no longer active." }, "price": { "type": "string", "description": "Limit price or reference price for the order, returned as a decimal string. For a BUY limit order this is the maximum price the user agreed to pay; for SELL it is the minimum they agreed to receive." }, "stopPrice": { "type": "string", "description": "Trigger price for STOP or STOP_LIMIT orders, returned as a decimal string. Empty when the order type does not use a stop trigger." }, "avgPrice": { "type": "string", "description": "Average execution price across filled quantity, returned as a decimal string. Use this to calculate realized cost or proceeds." }, "currency": { "type": "string", "description": "Currency used for prices and costs on this order, usually USD for U.S. equities." }, "destination": { "type": "string", "description": "Exchange or routing destination selected by the broker or order router. Use this for advanced routing or support displays." }, "instrument": { "type": "string", "description": "Instrument or security type for the order. Use this to decide whether to display equity fields or option contract details." }, "category": { "type": "string", "description": "What kind of order this is. Tells your UI whether to render option contract details or just plain stock info.\n- `EQUITY` — a regular stock or ETF order; `legs` will be empty.\n- `SINGLE_LEG` — an option order with one contract; `legs` has one item.\n- `MULTI_LEG` — an option spread (e.g. vertical spread, iron condor); `legs` has 2–4 items.", "enum": [ "SINGLE_LEG", "MULTI_LEG", "EQUITY" ] }, "text": { "type": "string", "description": "Broker or platform message about the order. Show this when the order is rejected or needs explanation." }, "legs": { "type": "array", "description": "Per-leg details for option spreads or other multi-leg orders. Omitted or empty for normal single-symbol stock orders.", "items": { "$ref": "#/components/schemas/AccountOrderLeg" } }, "createdAt": { "format": "date-time", "type": "string", "description": "Time the order was created. Use this for sorting and audit displays." }, "updatedAt": { "format": "date-time", "type": "string", "description": "Time the order was last updated. Use this to show freshness of order status." } } }, "GetOrdersV2Response": { "type": "object", "description": "Paginated v2 orders response from **GET /v2/accounts/{id}/orders** and **GET /v2/accounts/{id}/orders/history**. Both fields are always present; `orders` may be an empty array when there are no matches.", "properties": { "orders": { "type": "array", "description": "Page of orders in v2 domain shape (`TradeOrderV2`). Never null — use an empty array when there are no results.", "items": { "$ref": "#/components/schemas/TradeOrderV2" } }, "nextCursor": { "type": "integer", "format": "int64", "description": "Opaque pagination cursor. Pass as `cursor` on the next request. Value `0` means the walk is exhausted." } } }, "TradeOrderLegV2": { "type": "object", "description": "Option leg on a v2 order (`order.Leg`). Multi-leg orders carry per-leg `avgPrice`; order-level `avgPrice` is zero when `legs` is non-empty.", "required": [ "symbol", "side", "ratioQty", "securityType", "maturity", "strikePrice", "positionEffect", "putCall" ], "properties": { "symbol": { "type": "string", "description": "Symbol for this leg. For options, use the exact contract symbol from search or the order response." }, "side": { "type": "string", "description": "Direction for this leg. BUY purchases the instrument; SELL sells it.", "enum": [ "BUY", "SELL" ] }, "ratioQty": { "type": "string", "description": "Quantity ratio for this leg, returned as a decimal string. Use it to display strategy structure." }, "securityType": { "type": "string", "description": "Instrument type for this leg. EQUITY is stock or ETF; OPTION is an options contract.", "enum": [ "EQUITY", "OPTION" ] }, "maturity": { "type": "string", "description": "Option expiration date in YYYY-MM-DD format. Present for option legs." }, "strikePrice": { "type": "string", "description": "Option strike price as a decimal string. Present for option legs." }, "positionEffect": { "type": "string", "description": "Whether this leg opens a new position or closes an existing one:\n- `OPEN` — opens a new position (or increases an existing one).\n- `CLOSE` — closes an existing position (or reduces it).", "enum": [ "OPEN", "CLOSE" ] }, "putCall": { "type": "string", "description": "Option contract type. CALL gives the right to buy; PUT gives the right to sell.", "enum": [ "CALL", "PUT" ] }, "avgPrice": { "type": "string", "description": "Average fill price for this leg (decimal string)" } } }, "TradeOrderV2": { "type": "object", "description": "Standard v2 order shape returned by the trading endpoints. Identical across **GET /v2/accounts/{id}/orders** (cache and DB), **GET /v2/accounts/{id}/orders/history**, and WebSocket `accUpdates` — merge live updates with REST by `clOrdId` without field remapping. Numeric quantities and prices are decimal strings. Fields marked optional in Go (`omitempty`) may be absent when empty; core quantity, price, and timestamp fields are always present on each order object.", "properties": { "clOrdId": { "type": "string", "description": "Client order ID — unique per account, used as the merge key with WebSocket order snapshots." }, "ordId": { "type": "string", "description": "Broker order ID. Always serialized; may be an empty string for cancel-rejects or before the broker accepts the order." }, "origClOrdId": { "type": "string", "description": "Original client order ID for replace/cancel chains. Omitted when not part of a chain." }, "accountId": { "type": "string", "description": "Account that owns this order." }, "clientId": { "type": "string", "description": "OAuth client / application identifier that submitted the order. Always serialized; may be empty." }, "symbol": { "type": "string", "description": "Primary symbol traded by the order." }, "side": { "$ref": "#/components/schemas/OrderSideEnum" }, "type": { "$ref": "#/components/schemas/OrderTypeEnum" }, "timeInForce": { "$ref": "#/components/schemas/TimeInForceEnum" }, "qty": { "type": "string", "description": "Original order size as a decimal string. Use this with filled and remaining quantities to show execution progress." }, "price": { "type": "string", "description": "Limit or reference price as a decimal string. Required for limit-style orders and empty or zero for pure market orders." }, "stopPrice": { "type": "string", "description": "Stop trigger price as a decimal string. Required for stop-style orders and empty or zero when not used." }, "ordStatus": { "type": "string", "description": "Current state of the order. Possible values:\n- `PENDING_NEW` — Submitted, waiting for exchange acknowledgement.\n- `NEW` — Accepted by the exchange and live in the order book; no fills yet.\n- `PARTIALLY_FILLED` — Some of the quantity has executed; the rest is still working. See `cumQty` and `leavesQty`.\n- `FILLED` — Fully executed. Order is complete.\n- `PENDING_CANCEL` — Cancel request submitted; waiting for exchange confirmation.\n- `CANCELED` — Order was cancelled and will not execute further.\n- `PENDING_REPLACE` — Replace/modify request submitted; waiting for exchange confirmation.\n- `REPLACED` — Order was successfully replaced/modified.\n- `REJECTED` — Order was refused (bad parameters, insufficient buying power, halted symbol, etc.). Check `ordRejReason` and `text`.\n- `EXPIRED` — Order reached its time-in-force limit without filling (e.g. a `DAY` order that didn't fill before close).\n- `DONE_FOR_DAY` — Order is no longer active for today's session but may resume on the next trading day (rare).\n- `STOPPED` — Trading was stopped on this order by an exchange action.\n- `SUSPENDED` — Order is temporarily suspended by the broker or exchange.\n- `CALCULATED` — End-of-day calculated status from FIX (rarely surfaced).\n- `ACCEPTED_FOR_BID` — Acknowledged for a bid (auction workflows).\n- `SUPERSEDED` — Replaced by a newer record; excluded from history responses server-side.\n\nOmitted when the broker has not yet reported a status.", "enum": [ "NEW", "PARTIALLY_FILLED", "FILLED", "DONE_FOR_DAY", "CANCELED", "REPLACED", "PENDING_CANCEL", "STOPPED", "REJECTED", "SUSPENDED", "PENDING_NEW", "CALCULATED", "EXPIRED", "ACCEPTED_FOR_BID", "PENDING_REPLACE", "SUPERSEDED" ] }, "cumQty": { "type": "string", "description": "Total quantity already filled, returned as a decimal string." }, "leavesQty": { "type": "string", "description": "Quantity still open and waiting to fill, returned as a decimal string." }, "avgPrice": { "type": "string", "description": "Average fill price at the order level. For multi-leg orders this may be zero; use each leg's `avgPrice` instead." }, "currency": { "type": "string", "description": "Currency for prices and amounts on this order, usually USD for U.S. securities." }, "exDestination": { "type": "string", "description": "Where the order was routed for execution. Useful for support diagnostics and advanced routing displays.\n- `MNGD` — Managed routing (Aries chooses the best venue automatically).\n- `MNGDFTE` — Managed routing with fill-then-end (extended) handling.", "enum": [ "MNGD", "MNGDFTE" ], "example": "MNGD" }, "text": { "type": "string", "description": "Broker or platform message about the order. Show this when status is rejected or when the user needs extra context." }, "ordRejReason": { "type": "string", "description": "Broker rejection reason code or text. Use this with `text` to explain why an order was rejected." }, "securityType": { "type": "string", "description": "Instrument type for the order. EQUITY is stock or ETF; OPTION is an options contract.", "enum": [ "EQUITY", "OPTION" ] }, "category": { "type": "string", "description": "What kind of trade this order represents.\n- `EQUITY` — Plain stock or ETF order.\n- `SINGLE_LEG` — One option contract (call or put).\n- `MULTI_LEG` — Two-to-four-leg option strategy (spread, condor, straddle, etc.). See the `legs` array.\n\nOmitted when the order has not been classified.", "enum": [ "SINGLE_LEG", "MULTI_LEG", "EQUITY" ] }, "legs": { "type": "array", "description": "Per-leg details for option spreads or other multi-leg orders. Empty or omitted for normal single-symbol orders.", "items": { "$ref": "#/components/schemas/TradeOrderLegV2" } }, "createdAt": { "format": "date-time", "type": "string", "description": "Time the order record was created. Use this for timeline and sorting displays." }, "updatedAt": { "format": "date-time", "type": "string", "description": "Time the order record was last updated. Use this to show status freshness." } } }, "PlaceOrderRequest": { "description": "Request body for submitting a live order. Use Preview Order first to estimate cost and catch validation issues before sending this request.", "properties": { "account": { "description": "Trading account identifier that should receive the order. Enter the account ID selected by the user.", "type": "string" }, "legs": { "description": "Leg definitions for multi-leg option strategies. Leave empty or omit for a normal single-symbol stock order.", "items": { "$ref": "#/components/schemas/Leg" }, "type": "array" }, "limitPrice": { "description": "Maximum price to pay when buying, or minimum price to accept when selling. Enter this for LIMIT and STOP_LIMIT orders.", "type": "string" }, "orderType": { "$ref": "#/components/schemas/OrderTypeEnum" }, "quantity": { "description": "Number of shares or contracts to trade. Enter a whole-number quantity for this request.", "format": "int64", "type": "integer" }, "route": { "description": "Optional routing destination. Use the default or smart route unless your integration has a broker-approved routing requirement.", "type": "string" }, "stopPrice": { "description": "Trigger price for STOP and STOP_LIMIT orders. Enter the market price level that should activate the order.", "type": "string" }, "symbol": { "description": "Exact uppercase symbol to trade. Confirm it with symbol search before placing the order.", "type": "string" }, "timeInForce": { "$ref": "#/components/schemas/TimeInForceEnum" }, "tradeAction": { "$ref": "#/components/schemas/OrderSideEnum" } }, "required": [ "account", "symbol", "quantity", "orderType", "tradeAction", "timeInForce" ], "type": "object" }, "PlaceOrderResponse": { "description": "Response returned immediately after submitting a live order. Use it as acknowledgement, then monitor order status until it reaches a final state.", "properties": { "orderId": { "description": "Order ID assigned to the submitted live order. Store it for status displays, support, and reconciliation.", "format": "int64", "type": "integer" }, "status": { "description": "Current order lifecycle state, mirroring FIX Tag 39 (OrdStatus). Most common values:\n- `PENDING_NEW` — broker has not yet acknowledged the order.\n- `NEW` — order is live on the exchange.\n- `PARTIALLY_FILLED` — some of `qty` has filled.\n- `FILLED` — entire order has executed.\n- `PENDING_CANCEL` / `CANCELED` — cancel in progress / completed.\n- `PENDING_REPLACE` / `REPLACED` — replace in progress / completed.\n- `REJECTED` — broker refused the order; see `ordRejReason` and `text`.\n- `EXPIRED` — order reached its time-in-force limit without filling.\n- Other FIX states: `STOPPED`, `SUSPENDED`, `DONE_FOR_DAY`, `CALCULATED`, `ACCEPTED_FOR_BID`, `SUPERSEDED`.", "type": "string", "enum": [ "NEW", "PARTIALLY_FILLED", "FILLED", "DONE_FOR_DAY", "CANCELED", "REPLACED", "PENDING_CANCEL", "STOPPED", "REJECTED", "SUSPENDED", "PENDING_NEW", "CALCULATED", "EXPIRED", "ACCEPTED_FOR_BID", "PENDING_REPLACE", "SUPERSEDED" ] } }, "type": "object" }, "AccountPosition": { "type": "object", "description": "One open position in the account positions list. Field names and types are stable across REST and WebSocket order updates.", "properties": { "accountId": { "type": "string", "description": "Account this position belongs to. Match it to the account selected by the user." }, "symbol": { "type": "string", "description": "Symbol for the held instrument. Use this to link the position to quotes, charts, and research." }, "securityType": { "type": "string", "description": "Indicates whether the position is an equity/stock position or an option position. Use this value to decide which position details and actions should be shown in the UI.\n- `EQUITY` — a stock or ETF position.\n- `OPTION` — an option contract position.", "enum": [ "EQUITY", "OPTION" ] }, "quantity": { "type": "string", "description": "Current position quantity, returned as a decimal string. Positive values represent long positions. Negative values may represent short positions, depending on brokerage conventions." }, "averagePrice": { "type": "string", "description": "Average entry price per share or contract, returned as a decimal string. This value can be used with quantity and current market price to calculate position-level profit/loss." }, "price": { "type": "string", "description": "Current market price per share or contract, returned as a decimal string. Omitted when unavailable (for example, on a closed position with zero quantity)." }, "todayRealizedPnL": { "type": "string", "description": "Profit or loss realized today from closed activity in this symbol, returned as a decimal string." }, "unrealizedPl": { "type": "string", "description": "Profit or loss on the open position at current market prices, returned as a decimal string." }, "todayPl": { "type": "string", "description": "Profit or loss for the current trading day, returned as a decimal string." }, "marketValue": { "type": "string", "description": "Current market value of the position (`quantity` × `price`), returned as a decimal string. Omitted when unavailable (for example, on a closed position with zero quantity)." }, "costBasis": { "type": "string", "description": "Total cost basis of the position, returned as a decimal string. Omitted when unavailable (for example, on a closed position with zero quantity)." }, "createdAt": { "type": "string", "format": "date-time", "description": "Timestamp when the current net position was established, returned in RFC3339 format. If the position is closed and reopened, this resets to the new establishment time rather than the first lot's open time. Omitted when not available." } } }, "PreviewOrderResponse": { "type": "object", "description": "Response schema for order preview (PreviewOrdResponse)", "properties": { "estimatedCost": { "type": "string", "description": "Estimated cash cost of the order before it is placed. Present in both equity and option previews. Use this to show the user the expected trade cost during review.", "example": "1500.00" }, "estimatedMargin": { "type": "string", "description": "Estimated margin requirement for the order. Present in both equity and option previews. Use this to explain how much margin capacity the order may consume.", "example": "0.00" }, "commission": { "type": "string", "description": "Estimated commission for the order. Present in both equity and option previews. Show this as part of the total trading cost.", "example": "0.00" }, "buyingPowerImpact": { "type": "string", "description": "Estimated reduction in available buying power if the order is submitted. Present in both equity and option previews. Use this before Place Order to confirm the account can support the trade.", "example": "1500.01" }, "fees": { "type": "string", "description": "Estimated regulatory and exchange fees. Present in both equity and option previews. Add this to commissions and order cost when showing total estimated cost.", "example": "0.01" }, "optionFees": { "type": "string", "description": "Estimated option-specific fees. Present only in the option preview. For equity previews this is typically omitted or zero.", "example": "0.70" }, "optionRequirement": { "type": "string", "description": "Estimated option requirement or margin requirement for the option strategy. Present only in the option preview. For equity previews this is typically omitted or zero.", "example": "0.00" }, "optionPremium": { "type": "string", "description": "Estimated premium paid or received for an option order. Present only in the option preview. For equity previews this is typically omitted or zero.", "example": "550.00" }, "numDayTrades": { "type": "integer", "description": "Estimated number of day trades this order would count toward. Present in both equity and option previews. Use this to warn pattern-day-trader-sensitive users.", "example": 0 }, "warnRuleId": { "type": "string", "description": "Identifier for a warning rule triggered by the preview. Present in both equity and option previews when applicable. Use with `warnings` when present.", "example": "0" }, "warnings": { "type": "array", "items": { "type": "string" }, "description": "Non-blocking warnings returned by preview. Can appear for either equity or option previews. Show these to the user before they submit the live order." }, "errors": { "type": "array", "items": { "type": "string" }, "description": "Blocking validation or risk errors returned by preview. Can appear for either equity or option previews. Do not call Place Order until these are resolved." } } }, "OptionSnapshotDayBar": { "type": "object", "description": "Most recent daily OHLCV bar for the contract (`OptionSnapshotDayBarDTO`).", "properties": { "change": { "type": "number" }, "changePercent": { "type": "number" }, "close": { "type": "number" }, "high": { "type": "number" }, "lastUpdated": { "type": "integer", "format": "int64" }, "low": { "type": "number" }, "open": { "type": "number" }, "previousClose": { "type": "number" }, "volume": { "type": "number" }, "vwap": { "type": "number" } } }, "OptionSnapshotContractDetails": { "type": "object", "description": "Static contract metadata (`OptionSnapshotDetailsDTO`).", "properties": { "contractType": { "type": "string", "description": "Contract type (for example call or put)." }, "exerciseStyle": { "type": "string" }, "expirationDate": { "type": "string", "description": "Expiration date (ISO date string)." }, "sharesPerContract": { "type": "number" }, "strikePrice": { "type": "number" }, "ticker": { "type": "string", "description": "OCC-format options ticker." } } }, "OptionSnapshotGreeks": { "type": "object", "description": "Greeks when available (`OptionSnapshotGreeksDTO`).", "properties": { "delta": { "type": "number", "nullable": true }, "gamma": { "type": "number", "nullable": true }, "theta": { "type": "number", "nullable": true }, "vega": { "type": "number", "nullable": true } } }, "OptionSnapshotLastQuote": { "type": "object", "description": "Latest NBBO quote when included (`OptionSnapshotLastQuoteDTO`).", "properties": { "ask": { "type": "number" }, "askExchange": { "type": "integer", "nullable": true }, "askSize": { "type": "number" }, "bid": { "type": "number" }, "bidExchange": { "type": "integer", "nullable": true }, "bidSize": { "type": "number" }, "lastUpdated": { "type": "integer", "format": "int64" }, "midpoint": { "type": "number" }, "timeframe": { "type": "string" } } }, "OptionSnapshotLastTrade": { "type": "object", "description": "Latest trade when included (`OptionSnapshotLastTradeDTO`).", "properties": { "conditions": { "type": "array", "items": { "type": "integer" } }, "decimalSize": { "type": "string", "nullable": true }, "exchange": { "type": "string", "description": "Exchange code where the data originates. Format depends on the upstream data source and may use MIC, ISO 10383, or a vendor-specific code." }, "price": { "type": "number" }, "sipTimestamp": { "type": "integer", "format": "int64" }, "size": { "type": "number" }, "timeframe": { "type": "string" } } }, "OptionSnapshotUnderlying": { "type": "object", "description": "Underlying equity snapshot (`OptionSnapshotUnderlyingDTO`).", "properties": { "changeToBreakEven": { "type": "number", "nullable": true }, "lastUpdated": { "type": "integer", "format": "int64", "nullable": true }, "price": { "type": "number", "nullable": true }, "ticker": { "type": "string" }, "timeframe": { "type": "string" } } }, "OptionContractSnapshotRow": { "type": "object", "description": "One option contract row in a snapshot response (`OptionContractSnapshotDataDTO`). Optional fields are omitted when absent.", "properties": { "breakEvenPrice": { "type": "number", "nullable": true }, "day": { "$ref": "#/components/schemas/OptionSnapshotDayBar" }, "details": { "$ref": "#/components/schemas/OptionSnapshotContractDetails" }, "fmv": { "type": "number", "nullable": true }, "fmvLastUpdated": { "type": "integer", "format": "int64", "nullable": true }, "greeks": { "$ref": "#/components/schemas/OptionSnapshotGreeks" }, "impliedVolatility": { "type": "number", "nullable": true }, "lastQuote": { "$ref": "#/components/schemas/OptionSnapshotLastQuote" }, "lastTrade": { "$ref": "#/components/schemas/OptionSnapshotLastTrade" }, "openInterest": { "type": "number", "nullable": true }, "underlyingAsset": { "$ref": "#/components/schemas/OptionSnapshotUnderlying" } } }, "OptionChainSnapshotResponse": { "type": "object", "description": "Paginated option chain snapshot for an underlying (`OptionChainSnapshotResponse`).", "properties": { "requestId": { "type": "string", "description": "Request identifier from upstream data." }, "status": { "type": "string", "description": "Status string from the upstream data provider — typically `OK` for a successful response. Treat any other value as an error indicator alongside the HTTP status code." }, "results": { "type": "array", "description": "Option contract rows for the underlying, subject to filters and pagination.", "items": { "$ref": "#/components/schemas/OptionContractSnapshotRow" } }, "nextUrl": { "type": "string", "description": "URL for the next page of results (masked to this API); omitted when there is no next page." } } }, "OptionContractSnapshotResponse": { "type": "object", "description": "Single option contract snapshot (`OptionContractSnapshotResponse`). Responses may be cached for about five minutes.", "properties": { "requestId": { "type": "string", "description": "Request identifier from upstream data." }, "status": { "type": "string", "description": "Status string from the upstream data provider — typically `OK` for a successful response. Treat any other value as an error indicator alongside the HTTP status code." }, "results": { "$ref": "#/components/schemas/OptionContractSnapshotRow" }, "nextUrl": { "type": "string", "description": "Pagination URL when applicable; omitted when not used." } } }, "QuoteData": { "description": "One quote record in a quote response. Use `s` to match each record back to the requested symbol.", "properties": { "n": { "description": "Display name returned for the quoted instrument or venue.", "type": "string" }, "s": { "description": "Symbol this quote record belongs to. Match this against the symbol requested in the `symbols` query.", "type": "string" }, "v": { "description": "Quote values for this symbol, including bid, ask, last price, daily change, and volume.", "$ref": "#/components/schemas/QuoteValues" } }, "type": "object" }, "QuoteValues": { "description": "Market quote values for a symbol. Use bid/ask for trading decisions and last price for display context.", "properties": { "ask": { "description": "Lowest price sellers are currently willing to accept. Buyers usually compare their limit price to the ask.", "type": "number" }, "bid": { "description": "Highest price buyers are currently offering. Sellers usually compare their limit price to the bid.", "type": "number" }, "ch": { "description": "Dollar price change from the previous close. Use this for quote tiles and daily move displays.", "type": "number" }, "chp": { "description": "Percent change from the previous close. Use this to show the daily move as a percentage.", "type": "number" }, "description": { "description": "Full company or instrument description. Show it when users need to confirm the symbol they are viewing.", "type": "string" }, "exchange": { "type": "string", "description": "Exchange code where the data originates. Format depends on the upstream data source and may use MIC, ISO 10383, or a vendor-specific code." }, "high_price": { "description": "Highest price for the day", "type": "number" }, "low_price": { "description": "Lowest traded price during the current session. Use it for daily range displays.", "type": "number" }, "lp": { "description": "Last traded price. Use this as the current reference price, but use bid and ask when estimating immediate buy or sell cost.", "type": "number" }, "open_price": { "description": "Opening price for the day", "type": "number" }, "prev_close_price": { "description": "Previous day's closing price", "type": "number" }, "short_name": { "description": "Short name of the company", "type": "string" }, "volume": { "description": "Number of shares or contracts traded during the current session, when available.", "type": "number" } }, "type": "object" }, "QuotesResponse": { "description": "Response body for quote requests. Use it to render current market prices for one or more symbols.", "properties": { "d": { "description": "Quote records for the requested symbols. Iterate this array and use each record's `s` value to match the symbol.", "items": { "$ref": "#/components/schemas/QuoteData" }, "type": "array" }, "s": { "description": "Overall quote response status. `ok` means quote data was returned; `error` means the request could not be fulfilled.", "enum": [ "ok", "error" ], "type": "string" } }, "type": "object" }, "Rating": { "description": "Single analyst rating. Fields use snake_case; some fields may be absent when empty.", "properties": { "id": { "type": "string" }, "date": { "type": "string" }, "time": { "type": "string" }, "ticker": { "type": "string" }, "exchange": { "type": "string", "description": "Exchange code where the data originates. Format depends on the upstream data source and may use MIC, ISO 10383, or a vendor-specific code." }, "name": { "type": "string" }, "currency": { "type": "string" }, "action_pt": { "type": "string" }, "action_company": { "type": "string" }, "rating_current": { "type": "string" }, "rating_prior": { "type": "string" }, "pt_current": { "type": "number", "nullable": true }, "pt_current_adjusted": { "type": "number", "nullable": true }, "pt_prior": { "type": "number", "nullable": true }, "pt_prior_adjusted": { "type": "number", "nullable": true }, "analyst": { "type": "string" }, "analyst_id": { "type": "string" }, "analyst_name": { "type": "string" }, "ratings_accuracy": { "$ref": "#/components/schemas/RatingsAccuracy" }, "importance": { "type": "integer", "format": "int64" }, "notes": { "type": "string" }, "updated": { "type": "string" } }, "type": "object" }, "RatingsAccuracy": { "description": "Analyst accuracy metrics. Fields use snake_case; some fields may be absent when empty.", "properties": { "smart_score": { "type": "number", "nullable": true }, "success_rate": { "type": "number", "nullable": true }, "total_ratings": { "type": "integer", "nullable": true }, "gain_count_1m": { "type": "integer", "nullable": true }, "loss_count_1m": { "type": "integer", "nullable": true }, "avg_return_1m": { "type": "number", "nullable": true }, "std_dev_return_1m": { "type": "number", "nullable": true }, "gain_count_3m": { "type": "integer", "nullable": true }, "loss_count_3m": { "type": "integer", "nullable": true }, "avg_return_3m": { "type": "number", "nullable": true }, "std_dev_return_3m": { "type": "number", "nullable": true }, "gain_count_9m": { "type": "integer", "nullable": true }, "loss_count_9m": { "type": "integer", "nullable": true }, "avg_return_9m": { "type": "number", "nullable": true }, "std_dev_return_9m": { "type": "number", "nullable": true }, "gain_count_1y": { "type": "integer", "nullable": true }, "loss_count_1y": { "type": "integer", "nullable": true }, "avg_return_1y": { "type": "number", "nullable": true }, "std_dev_return_1y": { "type": "number", "nullable": true }, "gain_count_2y": { "type": "integer", "nullable": true }, "loss_count_2y": { "type": "integer", "nullable": true }, "avg_return_2y": { "type": "number", "nullable": true }, "std_dev_return_2y": { "type": "number", "nullable": true }, "gain_count_3y": { "type": "integer", "nullable": true }, "loss_count_3y": { "type": "integer", "nullable": true }, "avg_return_3y": { "type": "number", "nullable": true }, "std_dev_return_3y": { "type": "number", "nullable": true } }, "type": "object" }, "ReauthRequest": { "properties": { "password": { "description": "User password for reauthentication", "type": "string" } }, "required": [ "password" ], "type": "object" }, "RefreshAuthRequest": { "properties": { "email": { "type": "string" }, "refresh_token": { "description": "Valid JWT refresh token", "type": "string" } }, "required": [ "email", "refresh_token" ], "type": "object" }, "RefreshAuthResponse": { "properties": { "access_token": { "description": "New JWT access token", "type": "string" } }, "type": "object" }, "SearchSymbolItem": { "properties": { "description": { "description": "Full description of the symbol/company", "type": "string" }, "exchange": { "type": "string", "description": "Exchange code where the data originates. Format depends on the upstream data source and may use MIC, ISO 10383, or a vendor-specific code." }, "symbol": { "description": "Symbol identifier", "type": "string" }, "ticker": { "description": "Symbol ticker", "type": "string" }, "type": { "type": "string", "description": "Instrument class returned by symbol search.", "enum": [ "stock", "option" ], "example": "stock" } }, "type": "object" }, "SearchSymbolResponse": { "description": "HTTP response body for GET /v1/marketdata/search: a **JSON array** of `SearchSymbolResponseItem`. The handler writes the array directly (no `results` wrapper).", "items": { "$ref": "#/components/schemas/SearchSymbolResponseItem" }, "type": "array", "example": [ { "symbol": "AAPL", "description": "Apple Inc.", "tag": "XNAS", "type": "stock" }, { "symbol": "AAPL240119C00190000", "description": "AAPL Jan 19 2024 190 Call", "tag": "OPRA", "type": "option" } ] }, "SearchSymbolResponseItem": { "description": "One symbol search result. Use it to let users choose the exact instrument before fetching quotes, research data, or placing orders.", "properties": { "description": { "description": "Human-readable company or security name. Show this next to the symbol so users can confirm they selected the intended instrument.", "type": "string" }, "symbol": { "description": "Symbol value to pass into quote, chart, research, or order endpoints. Use the exact case returned here.", "type": "string" }, "tag": { "description": "Exchange or source tag, such as `XNAS` for Nasdaq or `OPRA` for options. Use it for display or filtering when multiple instruments share similar symbols.", "type": "string" }, "type": { "type": "string", "description": "Instrument class returned by symbol search.", "enum": [ "stock", "option" ], "example": "stock" } }, "type": "object" }, "SectorAvgChange": { "description": "Average percentage move by sector. Use it to compare which sectors are leading or lagging the market.", "properties": { "avgChange": { "description": "Average percentage change for the sector", "type": "number" }, "sector": { "description": "Sector name, such as Technology or Financials. Use it as the label in sector performance views.", "type": "string" } }, "type": "object", "example": { "sector": "TECHNOLOGY", "avgChange": 1.25 } }, "SetJointUserPasswordRequest": { "properties": { "confirm_password": { "description": "Password confirmation (must match password)", "example": "SecurePass123!", "format": "password", "maxLength": 64, "minLength": 8, "type": "string" }, "password": { "description": "New password for the account (8-64 characters)", "example": "SecurePass123!", "format": "password", "maxLength": 64, "minLength": 8, "type": "string" }, "token": { "description": "Temporary token received via email invitation", "example": "clxyz123abc456def789", "minLength": 1, "type": "string" } }, "required": [ "token", "password", "confirm_password" ], "type": "object" }, "SetJointUserPasswordResponse": { "properties": { "access_token": { "description": "JWT access token for API authentication", "example": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...", "type": "string" }, "refresh_token": { "description": "Refresh token for obtaining new access tokens", "example": "eyJjdHkiOiJKV1QiLCJlbmMiOiJBMjU2R0NNIiwiYWxnIjoiUlNBLU9BRVAifQ...", "type": "string" }, "user_id": { "description": "User ID of the authenticated joint user", "example": 12345, "format": "int64", "type": "integer" } }, "type": "object" }, "SymbolDetails": { "description": "Compact symbol summary returned by top movers and activity endpoints. Use it for market lists such as gainers, losers, and most active.", "properties": { "change": { "description": "Price change from previous close", "type": "number" }, "changePercent": { "description": "Percentage change from previous close", "type": "number" }, "isETF": { "description": "Whether the symbol is an ETF", "type": "boolean" }, "lastPrice": { "description": "Most recent trading price", "type": "number" }, "logoUrl": { "description": "URL to the company or ETF logo. Use it for visual identification in symbol lists.", "type": "string" }, "previousClose": { "description": "Previous session close price. Use it as the baseline for change and changePercent.", "type": "number" }, "sector": { "description": "Sector classification for the asset. Use it for grouping and filtering symbol lists.", "type": "string" }, "sicCode": { "description": "Standard Industrial Classification code", "type": "string" }, "symbol": { "description": "Trading symbol for the asset. Use this exact value when fetching quotes, charts, or research.", "type": "string" }, "timestamp": { "description": "Timestamp of the last update", "type": "number" }, "type": { "type": "string", "description": "Instrument class or provider category returned by the market data service. This value is not the trading order type.", "example": "stock" }, "volume": { "description": "Shares or contracts traded during the session. Use it to rank activity and liquidity.", "type": "number" } }, "type": "object", "example": { "symbol": "AAPL", "type": "stock", "change": 1.25, "changePercent": 0.72, "isETF": false, "lastPrice": 175.43, "logoUrl": "https://cdn.example.com/logos/AAPL.png", "previousClose": 174.18, "sector": "Technology", "sicCode": "3571", "timestamp": 1736956800, "volume": 52000000 } }, "SymbolError": { "properties": { "error": { "description": "Error detail as a string. Exact message content is not fixed and should not be hard-coded.", "example": "string", "type": "string" }, "symbol": { "description": "Symbol that had an error", "example": "string", "type": "string" } }, "type": "object" }, "SymbolInfo": { "properties": { "daily_multipliers": { "description": "Available daily time multipliers", "items": { "type": "string" }, "type": "array" }, "description": { "description": "Full description of the symbol/company", "type": "string" }, "exchange": { "type": "string", "description": "Exchange code where the data originates. Format depends on the upstream data source and may use MIC, ISO 10383, or a vendor-specific code." }, "format": { "description": "Price format (usually 'price')", "type": "string" }, "has_daily": { "description": "Whether daily data is available", "type": "boolean" }, "has_intraday": { "description": "Whether intraday data is available", "type": "boolean" }, "has_seconds": { "description": "Whether seconds resolution is available", "type": "boolean" }, "has_ticks": { "description": "Whether tick data is available", "type": "boolean" }, "has_weekly_and_monthly": { "description": "Whether weekly and monthly data is available", "type": "boolean" }, "intraday_multipliers": { "description": "Available intraday time multipliers", "items": { "type": "string" }, "type": "array" }, "listed_exchange": { "description": "Primary exchange where the symbol is listed", "type": "string" }, "minmov": { "description": "Minimum price movement", "type": "number" }, "monthly_multipliers": { "description": "Available monthly time multipliers", "items": { "type": "string" }, "type": "array" }, "name": { "description": "Symbol name", "type": "string" }, "pricescale": { "description": "Price scale (e.g., 100 means divide price by 100)", "type": "integer" }, "session": { "description": "Trading session hours (e.g., '0930-1600')", "type": "string" }, "subsession_id": { "description": "Identifier of the active subsession. Empty string when the symbol has no subsessions.", "type": "string" }, "subsessions": { "description": "Subsession definitions for the symbol. Null when the symbol has no subsessions.", "items": { "type": "object" }, "type": "array", "nullable": true }, "supported_resolutions": { "description": "Resolutions supported for this symbol", "items": { "type": "string" }, "type": "array" }, "ticker": { "description": "Symbol ticker", "type": "string" }, "timezone": { "description": "Timezone of the exchange (e.g., 'America/New_York')", "type": "string" }, "type": { "type": "string", "description": "Instrument class or provider category returned by the market data service. This value is not the trading order type.", "example": "stock" }, "visible_plots_set": { "description": "Visible plots (e.g., 'ohlcv' for OHLC + Volume)", "type": "string" }, "volume_precision": { "description": "Volume precision (decimal places)", "type": "number" }, "weekly_multipliers": { "description": "Available weekly time multipliers", "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "UpdateApplicationRequest": { "properties": { "submit": { "description": "Set to true to finalize and submit the application", "type": "boolean" } }, "type": "object" }, "UpdateOrderRequest": { "description": "Request body for updating an existing open order. Use only when your integration exposes an update flow; otherwise use the replace-order endpoint documented in Trade.", "properties": { "account": { "description": "Trading account that owns the existing order. Enter the same account used for the original order.", "type": "string" }, "legs": { "description": "Leg definitions for multi-leg option orders. Leave empty or omit for a normal single-symbol stock order.", "items": { "$ref": "#/components/schemas/Leg" }, "type": "array" }, "limitPrice": { "description": "New limit price. Use this for LIMIT and STOP_LIMIT updates; for buys it is the maximum price, and for sells it is the minimum price.", "type": "string" }, "orderId": { "description": "Order ID of the existing order to update. Enter the ID returned when the order was created or listed.", "format": "int64", "type": "integer" }, "orderType": { "description": "Updated execution style. MARKET prioritizes speed, LIMIT uses `limitPrice`, STOP uses `stopPrice`, and STOP_LIMIT uses both.", "type": "string", "enum": [ "MARKET", "LIMIT", "STOP", "STOP_LIMIT" ] }, "quantity": { "description": "Updated total order quantity. Enter the new desired total size, not the difference from the previous size.", "format": "int64", "type": "integer" }, "route": { "description": "Optional routing destination. Use the default or smart route unless your integration has a broker-approved routing requirement.", "type": "string" }, "stopPrice": { "description": "Updated stop trigger price. Use this for STOP and STOP_LIMIT updates.", "type": "string" }, "symbol": { "description": "Symbol on the existing order. Enter the exact symbol from the original order.", "type": "string" }, "timeInForce": { "$ref": "#/components/schemas/TimeInForceEnum" }, "tradeAction": { "description": "Updated trade direction. BUY purchases the symbol; SELL sells shares or contracts the account owns.", "type": "string", "enum": [ "BUY", "SELL", "SELL_SHORT", "BUY_TO_COVER" ] } }, "required": [ "orderId", "account", "symbol", "quantity", "orderType", "tradeAction", "timeInForce" ], "type": "object" }, "UpdateOrderResponse": { "description": "Response returned after an order update request. Use it to confirm the update result and continue monitoring order status.", "properties": { "orderId": { "description": "Order ID for the updated order. Store it for status displays, support, and reconciliation.", "format": "int64", "type": "integer" }, "status": { "description": "Order status after the update/replace request. Typical values:\n- `PENDING_REPLACE` — replace accepted but not yet final.\n- `REPLACED` — modification took effect; use the new `clOrdId` going forward.\n- `REJECTED` — replace was refused. The original order is unchanged.\n\nThe full FIX OrdStatus enum is supported — see the Place Order response for all possible values.", "type": "string", "enum": [ "NEW", "PARTIALLY_FILLED", "FILLED", "DONE_FOR_DAY", "CANCELED", "REPLACED", "PENDING_CANCEL", "STOPPED", "REJECTED", "SUSPENDED", "PENDING_NEW", "CALCULATED", "EXPIRED", "ACCEPTED_FOR_BID", "PENDING_REPLACE", "SUPERSEDED" ] } }, "type": "object" }, "UpdateUserRequest": { "properties": { "account_application": { "$ref": "#/components/schemas/UpdateApplicationRequest" }, "plaid_status": { "description": "Must be 'PENDING'", "enum": [ "PENDING" ], "type": "string" } }, "type": "object" }, "UpdateUserResponse": { "properties": { "account_application": { "$ref": "#/components/schemas/ApplicationResponse" }, "country": { "type": "string" }, "created_at": { "format": "date-time", "type": "string" }, "email": { "type": "string" }, "id": { "format": "int64", "type": "integer" }, "plaid_status": { "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "type": "object" }, "VerifyJointUserTokenRequest": { "properties": { "token": { "description": "Temporary token received via email invitation", "example": "clxyz123abc456def789", "minLength": 1, "type": "string" } }, "required": [ "token" ], "type": "object" }, "VerifyJointUserTokenResponse": { "properties": { "email": { "description": "Email address of the joint user (only present if token is valid)", "example": "jointuser@example.com", "format": "email", "type": "string" }, "user_id": { "description": "User ID of the joint user (only present if token is valid)", "example": 12345, "format": "int64", "type": "integer" }, "valid": { "description": "Whether the token is valid and not expired", "example": true, "type": "boolean" } }, "type": "object" }, "Watchlist": { "description": "Saved list of symbols a user wants to monitor. Watchlists are read-only from a trading-risk perspective and do not place orders.", "properties": { "id": { "description": "Watchlist identifier. Use this value when reading, updating, or deleting a specific watchlist.", "format": "int64", "type": "integer" }, "name": { "description": "User-facing watchlist name, such as Tech Stocks or Dividend Ideas. Show this as the list label in your app.", "type": "string" }, "symbols": { "description": "Symbols saved in the watchlist. Use exact uppercase ticker symbols and confirm unfamiliar symbols with symbol search.", "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "WatchlistAccountRequest": { "description": "One watchlist to create or update for an account. Use this when saving the user's named group of symbols.", "properties": { "name": { "description": "Unique watchlist name within the account. Enter a short user-facing label; names must be unique among all watchlists in the request array.", "example": "Tech Stocks", "type": "string" }, "symbols": { "description": "Stock ticker symbols to save in this watchlist. Enter exact uppercase symbols, keep each symbol unique, and use an empty array when creating an empty list.", "example": [ "AAPL", "GOOGL", "MSFT" ], "items": { "type": "string" }, "type": "array" } }, "required": [ "name", "symbols" ], "type": "object" }, "WatchlistAccountResponse": { "description": "Response body containing watchlists associated with a user or account.", "example": { "user_id": 98765, "watchlist": [ { "id": 1, "name": "Tech Stocks", "symbols": [ "AAPL", "GOOGL", "MSFT" ] }, { "id": 2, "name": "Finance", "symbols": [ "JPM", "BAC", "GS" ] } ] }, "properties": { "user_id": { "description": "User ID that owns these watchlists. Use it to confirm the response belongs to the expected connected user.", "format": "int64", "type": "integer" }, "watchlist": { "description": "Watchlists associated with the account or user. Render each item as a separate named symbol list.", "items": { "$ref": "#/components/schemas/Watchlist" }, "type": "array" } }, "type": "object" }, "WatchlistItem": { "description": "Single watchlist item returned by watchlist endpoints.", "example": { "id": 1, "name": "Tech Stocks", "symbols": [ "AAPL", "GOOGL", "MSFT", "TSLA" ] }, "properties": { "id": { "description": "Unique identifier for the watchlist", "format": "int64", "type": "integer" }, "name": { "description": "User-facing watchlist name. Show this as the list label in your app.", "type": "string" }, "symbols": { "description": "Symbols saved in this watchlist. Use these to fetch quotes, charts, or research for the user's saved list.", "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "WatchlistRequest": { "description": "Request body for creating or updating one watchlist.", "properties": { "name": { "description": "Unique user-facing name for the watchlist. Enter a short label the user will recognize.", "type": "string" }, "symbols": { "description": "Stock symbols to include. Enter exact uppercase symbols and avoid duplicates.", "example": [ "AAPL", "GOOGL", "MSFT" ], "items": { "type": "string" }, "type": "array" } }, "required": [ "name", "symbols" ], "type": "object" }, "WatchlistResponse": { "description": "Response body containing the user's saved watchlists.", "properties": { "user_id": { "description": "User ID that owns these watchlists. Use it to confirm the response belongs to the expected connected user.", "format": "int64", "type": "integer" }, "watchlist": { "description": "Saved watchlists for the user. Render each item as a named list of symbols.", "items": { "$ref": "#/components/schemas/Watchlist" }, "type": "array" } }, "type": "object" }, "PlaceOrdRequest": { "type": "object", "description": "Request body for placing a live order through the core trading API. Use Preview Order first when available, then submit this only after the user confirms the trade.", "required": [ "tradingAccountId", "symbol", "side", "type", "qty", "timeInForce" ], "properties": { "tradingAccountId": { "type": "string", "description": "Trading account identifier that should receive the order. Enter the tradingAccountId selected by the user.", "minLength": 1, "maxLength": 50, "example": "TEST-ACCOUNT-001" }, "clientId": { "type": "string", "description": "Optional identifier from your app. Send this when you want to tag orders by app, user, strategy, or integration for your own reconciliation.", "maxLength": 50, "example": "CLIENT-001" }, "symbol": { "type": "string", "description": "Ticker or underlying symbol to trade. Confirm the exact uppercase value with symbol search before placing an order.", "minLength": 1, "maxLength": 21, "example": "AAPL" }, "side": { "$ref": "#/components/schemas/OrderSideEnum" }, "type": { "$ref": "#/components/schemas/OrderTypeEnum" }, "qty": { "type": "string", "description": "Number of shares or contracts to trade, sent as a decimal string. Example: \"10\" for ten shares or \"1\" for one option contract.", "example": "10" }, "price": { "type": "string", "description": "Limit price as a decimal string. Required for LIMIT and STOP_LIMIT orders. For buys, this is the maximum price you will pay; for sells, it is the minimum price you will accept.", "example": "150.00" }, "stopPrice": { "type": "string", "description": "Trigger price as a decimal string. Required for STOP and STOP_LIMIT orders. When the market reaches this price, the stop order becomes active.", "example": "145.00" }, "timeInForce": { "$ref": "#/components/schemas/TimeInForceEnum" }, "currency": { "type": "string", "description": "Three-letter currency code for the order. Use USD for U.S. dollar orders unless your integration supports another currency.", "minLength": 3, "maxLength": 3, "example": "USD" }, "legs": { "type": "array", "description": "Option legs for single-leg or multi-leg option orders. Omit this field for equity orders. Send 1 leg for a single option contract or 2 to 4 legs for a spread or other multi-leg strategy.", "maxItems": 4, "items": { "$ref": "#/components/schemas/OrdLeg" } } } }, "OrdLeg": { "type": "object", "description": "One option leg inside a single-leg or multi-leg order. Use this only for option orders; omit `legs` for normal stock orders.", "required": [ "side", "ratioQty", "securityType", "positionEffect" ], "properties": { "symbol": { "type": "string", "description": "Underlying symbol for this option leg. Omit it when the leg uses the same underlying as the order-level symbol.", "maxLength": 21, "example": "AAPL" }, "side": { "type": "string", "description": "Direction for this option leg. Use `BUY` when buying the leg and `SELL` when selling the leg.", "enum": [ "BUY", "SELL" ], "example": "BUY" }, "ratioQty": { "type": "string", "description": "Leg ratio quantity as a decimal string. Use \"1\" for a standard one-to-one leg; use other ratios for spreads that require uneven leg sizing.", "example": "1" }, "cfiCode": { "type": "string", "description": "Optional CFI code if your system uses ISO instrument classification. Most integrations can omit this unless their option workflow requires it.", "maxLength": 10 }, "securityType": { "$ref": "#/components/schemas/SecurityTypeEnum" }, "maturity": { "type": "string", "description": "Option expiration date in YYYY-MM-DD format. Required for option legs when the contract is not fully identified elsewhere.", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "example": "2025-01-17" }, "strikePrice": { "type": "string", "description": "Option strike price as a decimal string. Required for option legs when the contract is not fully identified elsewhere.", "example": "150.00" }, "positionEffect": { "type": "string", "description": "Whether this leg opens or closes a position. Use `OPEN` for a new position and `CLOSE` when closing an existing position.", "enum": [ "OPEN", "CLOSE" ], "example": "OPEN" }, "putCall": { "type": "string", "description": "Option contract type. Use `CALL` for call options and `PUT` for put options.", "enum": [ "PUT", "CALL" ], "example": "CALL" } } }, "CancelOrdRequest": { "type": "object", "description": "Request body for canceling an open order through the core trading API. Use this when the user wants to stop an order that has not fully filled.", "required": [ "origClOrdId", "tradingAccountId", "symbol", "side" ], "properties": { "origClOrdId": { "type": "string", "description": "Client order ID of the original order you want to cancel. Use the `clOrdId` returned by Place Order or List active orders.", "minLength": 1, "maxLength": 100, "example": "ORDER-123456" }, "tradingAccountId": { "type": "string", "description": "Trading account identifier that owns the order being canceled. It must match the account on the original order.", "minLength": 1, "maxLength": 50, "example": "TEST-ACCOUNT-001" }, "symbol": { "type": "string", "description": "Symbol on the original order. Use the exact symbol from the order record.", "minLength": 1, "maxLength": 21, "example": "AAPL" }, "side": { "$ref": "#/components/schemas/OrderSideEnum" }, "securityType": { "$ref": "#/components/schemas/SecurityTypeEnum" }, "putCall": { "type": "string", "description": "Option contract type for option cancels. Use `CALL` for calls and `PUT` for puts. Omit for equity cancels.", "enum": [ "PUT", "CALL" ], "example": "CALL" }, "strikePrice": { "type": "string", "description": "Option strike price as a decimal string. Send this for option cancels when the original order was an option order.", "example": "150.00" }, "maturity": { "type": "string", "description": "Option expiration date in YYYY-MM-DD format. Send this for option cancels when the original order was an option order.", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "example": "2025-01-17" } } }, "ReplaceOrdRequest": { "type": "object", "description": "Request body for replacing an open order through the core trading API. Use this when the user changes price, quantity, stop price, or time-in-force before the order fully fills.", "required": [ "origClOrdId", "tradingAccountId", "symbol" ], "properties": { "origClOrdId": { "type": "string", "description": "Client order ID of the original open order you want to replace. Use the `clOrdId` returned by Place Order or List active orders. **Important — ID cycling:** each successful replace returns a new `clOrdId` in the response. For any subsequent replace of the same order, send this new `clOrdId` as `origClOrdId` — not the ID from the original placement. Reusing the old ID will be rejected.", "minLength": 1, "maxLength": 100, "example": "ORDER-123456" }, "tradingAccountId": { "type": "string", "description": "Trading account identifier that owns the order being replaced. It must match the account on the original order.", "minLength": 1, "maxLength": 50, "example": "TEST-ACCOUNT-001" }, "clientId": { "type": "string", "description": "Optional new client identifier from your app for the replacement order. Use this when you need to track replacement attempts separately.", "maxLength": 50 }, "symbol": { "type": "string", "description": "Symbol on the original order. Use the exact symbol from the order record.", "minLength": 1, "maxLength": 21, "example": "AAPL" }, "side": { "$ref": "#/components/schemas/OrderSideEnum" }, "type": { "$ref": "#/components/schemas/OrderTypeEnum" }, "qty": { "type": "string", "description": "Replacement order quantity as a decimal string. Send it when changing order size.", "example": "20" }, "price": { "type": "string", "description": "Replacement limit price as a decimal string. Send it when changing a LIMIT or STOP_LIMIT order price.", "example": "148.50" }, "stopPrice": { "type": "string", "description": "Replacement stop trigger as a decimal string. Send it when changing a STOP or STOP_LIMIT order trigger.", "example": "145.00" }, "timeInForce": { "$ref": "#/components/schemas/TimeInForceEnum" }, "currency": { "type": "string", "description": "Three-letter currency code for the replacement order. Use USD for U.S. dollar orders unless your integration supports another currency.", "minLength": 3, "maxLength": 3, "example": "USD" }, "legs": { "type": "array", "description": "Option legs to replace, for single-leg or multi-leg option orders. Omit this field for equity orders. Send 1 leg for a single option contract or 2 to 4 legs for a spread/multi-leg strategy. The instrument is identified from the legs (single leg) or auto-parsed from an OSI symbol when `legs` is omitted.", "maxItems": 4, "items": { "$ref": "#/components/schemas/OrdLeg" } } } }, "OrdResponse": { "type": "object", "description": "Response returned after submitting an order request. Treat it as acknowledgement and continue monitoring order status until final fill, cancel, or rejection.", "properties": { "success": { "type": "boolean", "description": "Whether the order request was accepted by Aries for processing. This does not guarantee a final fill.", "example": true }, "clOrdId": { "type": "string", "description": "Client order ID assigned to this order. Store this value to look up, replace, or cancel the order later.", "example": "ORDER-123456" }, "status": { "type": "string", "description": "Current order lifecycle state, mirroring FIX Tag 39 (OrdStatus). Most common values you'll see:\n- `PENDING_NEW` — broker has not yet acknowledged the order.\n- `NEW` — order is live on the exchange (working, not yet executing).\n- `PARTIALLY_FILLED` — some of `qty` has filled; check `cumQty` and `leavesQty`.\n- `FILLED` — the entire order has executed.\n- `PENDING_CANCEL` / `CANCELED` — cancel request in progress / completed.\n- `PENDING_REPLACE` / `REPLACED` — replace request in progress / completed.\n- `REJECTED` — broker refused the order; see `ordRejReason` and `text`.\n- `EXPIRED` — order reached its time-in-force limit without filling.\n- `STOPPED`, `SUSPENDED`, `DONE_FOR_DAY`, `CALCULATED`, `ACCEPTED_FOR_BID`, `SUPERSEDED` — additional FIX states; rare in normal flows.", "example": "NEW", "enum": [ "NEW", "PARTIALLY_FILLED", "FILLED", "DONE_FOR_DAY", "CANCELED", "REPLACED", "PENDING_CANCEL", "STOPPED", "REJECTED", "SUSPENDED", "PENDING_NEW", "CALCULATED", "EXPIRED", "ACCEPTED_FOR_BID", "PENDING_REPLACE", "SUPERSEDED" ] }, "symbol": { "type": "string", "description": "Symbol submitted on the order.", "example": "AAPL" }, "side": { "$ref": "#/components/schemas/OrderSideEnum" }, "qty": { "type": "string", "description": "Original order quantity as a decimal string.", "example": "10" }, "cumQty": { "type": "string", "description": "Quantity already filled. Compare this with qty to understand partial fills.", "example": "0" }, "leavesQty": { "type": "string", "description": "Quantity still open and eligible to fill. Value becomes 0 when the order is fully filled or no longer active.", "example": "10" }, "avgPrice": { "type": "string", "description": "Average execution price for filled quantity. This is 0 until fills occur.", "example": "0" }, "text": { "type": "string", "description": "Broker or system message. Show this to users when it explains a status or warning." }, "ordRejReason": { "type": "string", "description": "Reason the order was rejected, when available. Use this to explain what the user needs to fix." }, "transactTime": { "type": "string", "format": "date-time", "description": "Time Aries or the broker recorded the order transaction." } }, "example": { "success": true, "clOrdId": "ORDER-20260115-001", "status": "NEW", "symbol": "AAPL", "side": "BUY", "qty": "10", "cumQty": "0", "leavesQty": "10", "avgPrice": "0", "text": "Order accepted", "ordRejReason": "", "transactTime": "2026-01-15T14:30:05Z" } }, "CancelOrdResponse": { "type": "object", "description": "Response returned after requesting an order cancel. Treat it as the cancel result and continue monitoring if the status is pending.", "properties": { "success": { "type": "boolean", "description": "Whether Aries or the broker accepted the cancel request for processing.", "example": true }, "clOrdId": { "type": "string", "description": "Client order ID associated with the cancel action. Store it for audit and status matching.", "example": "ORDER-123456" }, "origClOrdId": { "type": "string", "description": "Client order ID of the original order being canceled. Use it to connect this cancel result to the user's order.", "example": "ORDER-123456" }, "status": { "type": "string", "description": "Order status after the cancel request. Typical values after a successful cancel:\n- `PENDING_CANCEL` — cancel request accepted by the broker but not yet final. Keep monitoring; will move to `CANCELED` once confirmed.\n- `CANCELED` — order is fully cancelled; no further fills will occur.\n- `REJECTED` — the cancel was refused (e.g. the order had already fully filled). The original order is unchanged.\n\nThe full FIX OrdStatus enum is supported — see the Place Order response for the complete list of possible values.", "example": "CANCELED", "enum": [ "NEW", "PARTIALLY_FILLED", "FILLED", "DONE_FOR_DAY", "CANCELED", "REPLACED", "PENDING_CANCEL", "STOPPED", "REJECTED", "SUSPENDED", "PENDING_NEW", "CALCULATED", "EXPIRED", "ACCEPTED_FOR_BID", "PENDING_REPLACE", "SUPERSEDED" ] }, "text": { "type": "string", "description": "Broker or platform message about the cancel result. Show it when the cancel is rejected or needs explanation." } }, "example": { "success": true, "clOrdId": "ORDER-20260115-002", "origClOrdId": "ORDER-20260115-001", "status": "CANCELED", "text": "Cancel request processed" } }, "ReplaceOrdResponse": { "type": "object", "description": "Response returned after requesting an order replacement. Treat it as the replacement result and monitor the new client order ID going forward.", "properties": { "success": { "type": "boolean", "description": "Whether Aries or the broker accepted the replace request for processing.", "example": true }, "clOrdId": { "type": "string", "description": "New client order ID assigned to the replacement order. Store this for future status, replace, or cancel operations.", "example": "ORDER-123457" }, "origClOrdId": { "type": "string", "description": "Client order ID of the order that was replaced. Use it to connect the replacement back to the original order.", "example": "ORDER-123456" }, "status": { "type": "string", "description": "Order status after the replace request. Typical values after a successful replace:\n- `PENDING_REPLACE` — replace request accepted by the broker but not yet final. Keep monitoring; will move to `REPLACED` once confirmed.\n- `REPLACED` — the modification took effect. From now on, refer to the order by the new `clOrdId`.\n- `REJECTED` — the replace was refused (e.g. the order had already fully filled). The original order is unchanged.\n\nThe full FIX OrdStatus enum is supported — see the Place Order response for the complete list of possible values.", "example": "REPLACED", "enum": [ "NEW", "PARTIALLY_FILLED", "FILLED", "DONE_FOR_DAY", "CANCELED", "REPLACED", "PENDING_CANCEL", "STOPPED", "REJECTED", "SUSPENDED", "PENDING_NEW", "CALCULATED", "EXPIRED", "ACCEPTED_FOR_BID", "PENDING_REPLACE", "SUPERSEDED" ] }, "qty": { "type": "string", "description": "Replacement order quantity as a decimal string. Display this as the current order size after a successful replace.", "example": "20" }, "price": { "type": "string", "description": "Replacement order price as a decimal string. Display this as the current limit or reference price after a successful replace.", "example": "150.00" }, "text": { "type": "string", "description": "Broker or platform message about the replace result. Show it when replacement is rejected or pending." }, "transactTime": { "type": "string", "format": "date-time", "description": "Time the replace action was processed. Use it for order timelines and audit logs." } }, "example": { "success": true, "clOrdId": "ORDER-20260115-003", "origClOrdId": "ORDER-20260115-001", "status": "REPLACED", "qty": "200", "price": "175.50", "text": "Replace accepted", "transactTime": "2026-01-15T14:31:00Z" } }, "CancelResponse": { "type": "object", "description": "Response body for cancel order operation. Use it to confirm whether the cancel was accepted, rejected, or still pending.", "properties": { "success": { "type": "boolean", "description": "Whether Aries or the broker accepted the cancel request for processing.", "example": true }, "clientOrderId": { "type": "string", "description": "Client order ID associated with the cancel action. Store it for audit and status matching.", "example": "ORDER-123456" }, "origClientOrderId": { "type": "string", "description": "Client order ID of the original order being canceled. Use it to connect the cancel result to the user's order.", "example": "ORDER-123456" }, "orderStatus": { "type": "string", "description": "Order status after cancellation. CANCELED means no further fills should occur; PENDING_CANCEL means keep monitoring; REJECTED means the order was not canceled.", "enum": [ "CANCELED", "PENDING_CANCEL", "REJECTED" ], "example": "CANCELED" }, "text": { "type": "string", "description": "Broker or platform message about the cancel result. Show this when cancellation is rejected or pending.", "example": "Order canceled successfully" } } }, "ReplaceOrderRequest": { "type": "object", "description": "Request body for changing an open order. Use replace when the user wants to update price, quantity, or time-in-force before the original order is fully filled.", "required": [ "origClientOrderId", "accountId", "symbol" ], "properties": { "origClientOrderId": { "type": "string", "description": "Client order ID of the existing order to replace. Enter the ID returned when the order was placed or from order history.", "minLength": 1, "maxLength": 100, "example": "ORDER-123456" }, "accountId": { "type": "string", "description": "Trading account that owns the existing order. Enter the same account ID used for the original order.", "minLength": 1, "maxLength": 50, "example": "TEST-ACCOUNT-001" }, "clientId": { "type": "string", "description": "Optional new client/application identifier for the replacement request. Use this only if your system tracks replacements with a separate client tag.", "maxLength": 50, "example": "CLIENT-001" }, "symbol": { "type": "string", "description": "Symbol on the existing order. Enter the exact symbol from the original order.", "minLength": 1, "maxLength": 20, "example": "AAPL" }, "side": { "$ref": "#/components/schemas/OrderSideEnum" }, "priceType": { "$ref": "#/components/schemas/OrderTypeEnum" }, "quantity": { "type": "string", "description": "New total order quantity as a decimal string. Enter the desired replacement size, not just the difference from the old order.", "pattern": "^\\d+(\\.\\d+)?$", "example": "20" }, "price": { "type": "string", "description": "New limit price. Required when replacing a LIMIT or STOP_LIMIT order; for buys this is the maximum price, and for sells this is the minimum price.", "pattern": "^\\d+(\\.\\d{1,4})?$", "example": "148.50" }, "stopPrice": { "type": "string", "description": "New stop trigger price. Required when replacing a STOP or STOP_LIMIT order.", "pattern": "^\\d+(\\.\\d{1,4})?$", "example": "145.00" }, "timeInForce": { "$ref": "#/components/schemas/TimeInForceEnum" } } }, "ReplaceResponse": { "type": "object", "description": "Response body for replace order operation", "properties": { "success": { "type": "boolean", "description": "Whether the replace request was accepted for processing. Continue monitoring the order status until the replacement is confirmed or rejected.", "example": true }, "clientOrderId": { "type": "string", "description": "New client order ID assigned to the replacement order. Store this for future status, replace, or cancel operations.", "example": "ORDER-123457" }, "origClientOrderId": { "type": "string", "description": "Client order ID of the order that was replaced. Use this to connect the replacement back to the user's original order.", "example": "ORDER-123456" }, "orderStatus": { "type": "string", "description": "Order status after the replacement request. REPLACED means the change took effect; PENDING_REPLACE means it is still processing; REJECTED means the original order was not changed.", "enum": [ "REPLACED", "PENDING_REPLACE", "REJECTED" ], "example": "REPLACED" }, "orderQty": { "type": "string", "description": "Replacement order quantity as a decimal string. Display this as the current order size after a successful replace.", "example": "20" }, "price": { "type": "string", "description": "Replacement order price as a decimal string. Display this as the current limit or reference price after a successful replace.", "example": "150.00" }, "text": { "type": "string", "description": "Broker or platform message about the replace result. Show this when replacement is rejected or pending.", "example": "Order replaced successfully" }, "transactTime": { "type": "string", "format": "date-time", "description": "Time the replace action was processed, in ISO 8601 format. Use it for order timelines and audit logs.", "example": "2025-12-22T14:30:00Z" } } }, "CompanyProfile": { "type": "object", "description": "Company profile data for research pages. Use it to explain what the company does, where it is listed, and how it is classified.", "properties": { "address": { "type": "string", "description": "Company headquarters street address. Use it for company profile and issuer detail pages." }, "alias": { "type": "string", "description": "Comma-separated list of alternative names or aliases for the company" }, "city": { "type": "string", "description": "City where the company is headquartered" }, "country": { "type": "string", "description": "Country where the company is headquartered" }, "currency": { "type": "string", "description": "Currency used for financial reporting (e.g., USD, EUR)" }, "cusip": { "type": "string", "description": "CUSIP security identifier used in U.S. settlement and reference-data workflows." }, "description": { "type": "string", "description": "Detailed business description" }, "employeeTotal": { "type": "integer", "description": "Total number of employees" }, "estimateCurrency": { "type": "string", "description": "Currency for earnings estimates" }, "exchange": { "$ref": "#/components/schemas/ExchangeCode" }, "sector": { "type": "string", "description": "Industry sector classification" }, "ggroup": { "type": "string", "description": "GICS group classification" }, "gind": { "type": "string", "description": "GICS industry classification" }, "gsector": { "type": "string", "description": "GICS sector classification" }, "gsubind": { "type": "string", "description": "GICS sub-industry classification" }, "ipo": { "type": "string", "description": "Initial public offering date in YYYY-MM-DD format" }, "irUrl": { "type": "string", "description": "Investor relations website URL" }, "isin": { "type": "string", "description": "International Securities Identification Number. Use it for global security identification and reconciliation." }, "lei": { "type": "string", "description": "Legal Entity Identifier for the company. Use it for institutional reference-data and compliance workflows." }, "logo": { "type": "string", "description": "URL to the company's logo image (proxied through Aries API)" }, "marketCapCurrency": { "type": "string", "description": "Currency for market capitalization" }, "marketCapitalization": { "type": "number", "description": "Current market capitalization" }, "naics": { "type": "string", "description": "NAICS industry classification code. Use it for industry screening or peer grouping." }, "naicsNationalIndustry": { "type": "string", "description": "NAICS national industry classification" }, "naicsSector": { "type": "string", "description": "NAICS sector classification" }, "naicsSubsector": { "type": "string", "description": "NAICS subsector classification" }, "name": { "type": "string", "description": "Official company name. Show this beside the ticker so users can confirm the company." }, "phone": { "type": "string", "description": "Company's primary contact phone number" }, "sedol": { "type": "string", "description": "SEDOL security identifier used in global market reference data." }, "shareOutstanding": { "type": "number", "description": "Total number of outstanding shares" }, "state": { "type": "string", "description": "State where the company is headquartered" }, "ticker": { "type": "string", "description": "Primary stock ticker symbol for the company. Use it to connect profile data to quotes, filings, and financials." }, "weburl": { "type": "string", "description": "Company's official website URL" } } }, "CompanyExecutive": { "type": "object", "properties": { "age": { "type": "integer", "description": "Executive's current age" }, "compensation": { "type": "number", "description": "Executive compensation amount" }, "currency": { "type": "string", "description": "Currency code for compensation" }, "name": { "type": "string", "description": "Executive's full name" }, "position": { "type": "string", "description": "Executive position/title" }, "sex": { "type": "string", "description": "Executive's sex" }, "since": { "type": "string", "description": "Year when the executive joined" } } }, "CompanyExecutiveResponse": { "type": "object", "description": "Response containing executive leadership data for a company.", "properties": { "executives": { "type": "array", "description": "List of company executives and their details", "items": { "$ref": "#/components/schemas/CompanyExecutive" } } } }, "CompanyPeersResponse": { "type": "object", "description": "Response containing peer company tickers for comparison and competitor research.", "properties": { "peers": { "type": "array", "description": "List of ticker symbols for companies in the same industry or sector", "items": { "type": "string" } } } }, "MetricSeriesPoint": { "type": "object", "properties": { "period": { "type": "string", "description": "Time period for the metric value (e.g., 2023-12-31)" }, "v": { "type": "number", "description": "Metric value for the period" } } }, "BasicFinancials": { "type": "object", "description": "Basic financial metrics for company research. Use these values for valuation, profitability, and balance-sheet trend displays.", "properties": { "series": { "type": "object", "description": "Time series data for various financial metrics", "properties": { "annual": { "type": "object", "description": "Annual financial metrics organized by type", "properties": { "currentRatio": { "type": "array", "description": "Current ratio values over time (current assets / current liabilities)", "items": { "$ref": "#/components/schemas/MetricSeriesPoint" } }, "salesPerShare": { "type": "array", "description": "Sales per share values over time", "items": { "$ref": "#/components/schemas/MetricSeriesPoint" } }, "netMargin": { "type": "array", "description": "Net profit margin values over time", "items": { "$ref": "#/components/schemas/MetricSeriesPoint" } } } } } }, "metric": { "type": "object", "description": "Current financial metrics and ratios (dynamic object with various metric keys)", "properties": { "10DayAverageTradingVolume": { "type": "number", "description": "Average daily trading volume over the last 10 days" }, "52WeekHigh": { "type": "number", "description": "Highest stock price in the last 52 weeks" }, "52WeekLow": { "type": "number", "description": "Lowest stock price in the last 52 weeks" }, "52WeekLowDate": { "type": "string", "description": "Date when the 52-week low was reached" }, "52WeekPriceReturnDaily": { "type": "number", "description": "Price return over the last 52 weeks (daily calculation)" }, "beta": { "type": "number", "description": "Stock's beta coefficient measuring volatility relative to the market" } }, "additionalProperties": { "type": "number" } }, "metricType": { "type": "string", "description": "Type of metrics returned (all, price, valuation, margin)" }, "symbol": { "type": "string", "description": "Stock ticker symbol these financial metrics belong to. Use it to match the metrics back to the requested company." } } }, "ErrorEnvelope": { "type": "object", "description": "Prediction-market error envelope. Returned by historical-data and prediction-market reference endpoints on 400/404/500/502.", "properties": { "success": { "type": "boolean", "example": false }, "error": { "$ref": "#/components/schemas/AppError" } }, "required": [ "success", "error" ] }, "AppError": { "type": "object", "description": "Structured application error returned inside an `ErrorEnvelope`.", "properties": { "type": { "type": "string", "description": "Categorical error type. Use this for branching error-handling logic; the values are stable across endpoints:\n- `VALIDATION` — request body or query parameters failed validation.\n- `AUTHENTICATION` — missing, invalid, or expired token.\n- `AUTHORIZATION` — token is valid but lacks the required scope/permission.\n- `NOT_FOUND` — the requested resource does not exist.\n- `CONFLICT` — request conflicts with current state (e.g. duplicate).\n- `INTERNAL` — server-side error; retry or contact support.\n- `TIMEOUT` — operation took too long.\n- `UNKNOWN` — uncategorized error; check `message`.\n(Additional categorical values may appear in service-specific responses.)", "enum": [ "UNKNOWN", "VALIDATION", "AUTHENTICATION", "AUTHORIZATION", "NOT_FOUND", "CONFLICT", "INTERNAL", "TIMEOUT", "RATE_LIMIT", "BAD_REQUEST", "DATABASE", "EXTERNAL_SERVICE", "PRECONDITION_FAILED", "SERVICE_UNAVAILABLE", "GRPC", "QUEUE", "JSON_PARSING" ] }, "code": { "type": "string", "description": "Machine-readable code, e.g. `SYMBOL_REQUIRED`, `EVENT_NOT_FOUND`.", "example": "SYMBOL_REQUIRED" }, "message": { "type": "string", "description": "Error detail as a string. Exact message content is not fixed and should not be hard-coded.", "example": "string" }, "details": { "type": "object", "additionalProperties": true }, "service": { "type": "string" }, "operation": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "type", "code", "message" ] }, "InvestmentThemeId": { "type": "string", "description": "Investment theme identifier. Pick a theme to filter or look up stocks tied to that thesis (e.g. AI, fintech, clean energy).", "enum": [ "financialExchangesData", "futureFood", "3dPrinting", "ageingPopulation", "ai", "bigData", "cloud", "cyberSecurity", "digitalisation", "drones", "fintech", "founder", "futureEntertainment", "futureVehicles", "gaming", "globalCleanEnergy", "globalWater", "healthcareInnovation", "hr", "mobilePayment", "organicFood", "robotics", "tobaccoAlcoholGambling", "windEnergy" ], "example": "ai" }, "ReportingFrequency": { "type": "string", "enum": [ "annual", "quarterly" ], "example": "quarterly", "description": "How often the underlying data is reported:\n- `annual` — once per fiscal year (10-K, full-year statements).\n- `quarterly` — once per fiscal quarter (10-Q, quarterly statements)." }, "ChartResolution": { "type": "string", "description": "How long each candle/bar on the chart should cover. Three families of values are supported:\n\n**Intraday (minute bars)** — `1`, `3`, `5`, `15`, `30`, `45`, `60`, `120`, `180`, `240` — the number is the bar's length in minutes (e.g. `5` = five-minute bars, `60` = hourly).\n\n**Daily and longer** — `D` / `1D` = daily, `W` / `1W` = weekly, `M` / `1M` = monthly, `3M` / `6M` / `12M` = three-/six-/twelve-month bars.\n\n**Tick-based** — `1T`, `5T`, `10T`, `25T`, `50T`, `100T`, `250T`, `500T`, `1000T` — bars that close every N **trades** instead of every N minutes. Useful for fast-moving markets where time-based bars are too noisy.", "enum": [ "1", "3", "5", "15", "30", "45", "60", "120", "180", "240", "D", "W", "M", "1D", "1W", "1M", "3M", "6M", "12M", "1T", "5T", "10T", "25T", "50T", "100T", "250T", "500T", "1000T" ], "example": "D" }, "TechnicalIndicatorType": { "type": "string", "description": "Technical indicator slug (e.g. `sma`, `ema`, `rsi`, `macd`, `bbands`). Pass this with the indicator endpoint to compute that indicator over the requested bars.", "enum": [ "sma", "ema", "rsi", "macd", "bbands", "stoch", "adx", "cci", "willr", "mfi" ], "example": "rsi" }, "TenderOfferIdentifierType": { "type": "string", "enum": [ "Symbol", "CUSIP", "ISIN", "SEDOL", "Valoren", "FIGI", "CompositeFIGI" ], "example": "Symbol", "description": "Which kind of identifier you are filtering by. Provide the matching value in the identifier field:\n- `Symbol` — exchange ticker (e.g. `AAPL`).\n- `CUSIP` — 9-character U.S./Canadian security identifier.\n- `ISIN` — 12-character international identifier.\n- `SEDOL` — 7-character UK identifier.\n- `Valoren` — Swiss identifier.\n- `FIGI` — Bloomberg Financial Instrument Global Identifier.\n- `CompositeFIGI` — country-level composite FIGI." }, "OrdersV2Source": { "type": "string", "enum": [ "cache", "db" ], "default": "cache", "description": "Where to read orders from:\n- `cache` — fast in-memory cache (default; best for live screens and order tickets).\n- `db` — database read (use when you need the most authoritative answer for back-office tools)." }, "SortDirection": { "type": "string", "enum": [ "asc", "desc" ], "description": "Direction to sort results in:\n- `asc` — ascending (oldest or smallest first).\n- `desc` — descending (newest or largest first)." }, "LogosSearchKeysType": { "type": "string", "enum": [ "symbol", "cik", "cusip", "isin" ], "description": "How to interpret the value you send in `searchKeys`:\n- `symbol` — exchange ticker (e.g. `AAPL`).\n- `cik` — SEC Central Index Key.\n- `cusip` — 9-character U.S./Canadian security identifier.\n- `isin` — 12-character international identifier." }, "AnalystSearchKeysType": { "type": "string", "enum": [ "firm_id", "firm" ], "description": "How to interpret the value you send in `searchKeys`:\n- `firm_id` — internal firm/company identifier.\n- `firm` — firm/company name." }, "ExchangeCode": { "type": "string", "description": "Two-to-three-letter exchange code identifying a global stock exchange (e.g. `US` = U.S. exchanges, `L` = London, `HK` = Hong Kong, `T` = Tokyo, `PA` = Paris). Used as the `exchange` query parameter for market-status and market-holiday endpoints. Other endpoints may return a different exchange-code format depending on the upstream data source.", "enum": [ "AD", "AS", "AT", "AX", "BA", "BC", "BD", "BE", "BH", "BK", "BO", "BR", "CA", "CN", "CO", "CR", "CS", "DB", "DE", "DU", "F", "HA", "HE", "HK", "HM", "IC", "IR", "IS", "JK", "JO", "KL", "KQ", "KS", "KW", "L", "LS", "MC", "ME", "MI", "MT", "MU", "MX", "NE", "NL", "NS", "NZ", "OL", "OM", "PA", "PK", "PM", "PR", "QA", "RG", "RO", "SA", "SC", "SG", "SI", "SN", "SR", "SS", "ST", "SW", "SX", "SZ", "T", "TA", "TG", "TL", "TO", "TW", "TWO", "US", "V", "VI", "VN", "VS", "WA" ], "default": "US", "example": "US" }, "FinancialStatementType": { "type": "string", "description": "Statement: bs (balance sheet), ic (income), cf (cash flow).", "enum": [ "bs", "ic", "cf" ], "example": "ic" }, "IndicesIdentifierType": { "type": "string", "description": "Which kind of identifier you are sending in `identifier` / `identifiers`. Provide the matching value:\n- `Symbol` — index ticker (e.g. `SPX.IND_CBOM`). Default.\n- `CIK` — SEC Central Index Key.\n- `CUSIP` — 9-character U.S./Canadian security identifier.\n- `ISIN` — 12-character international identifier.\n- `Valoren` — Swiss security identifier.\n- `SEDOL` — 7-character UK identifier.\n- `FIGI` — Bloomberg Financial Instrument Global Identifier.\n- `CompositeFIGI` — country-level composite FIGI.", "enum": [ "Symbol", "CIK", "CUSIP", "ISIN", "Valoren", "SEDOL", "FIGI", "CompositeFIGI" ], "default": "Symbol", "example": "Symbol" }, "IndexGroup": { "type": "string", "description": "Identifier of an index data group. Each group is a publisher / index family. Use [GET /v1/indices/groups](/api-reference/supplemental/indices-groups) at runtime to get the live list — the list below is the current published set:\n- `IND_CBOC` — CBOE Data Services CMSI – Crypto Feed\n- `IND_CBOCGI` — CBOE Global Indices\n- `IND_CBOF` — CBOE Data Services CMSI – FTSE\n- `IND_CBOI` — CBOE Data Services CMSI – iNAV\n- `IND_CBOM` — CBOE Data Services CSMI (S&P 500, NASDAQ Composite, etc.)\n- `IND_CBOMSTAR` — CBOE Data Services CSMI – Morningstar\n- `IND_DJI` — Dow Jones Indices\n- `IND_GIDS` — Nasdaq Global Index Data Service\n- `IND_GIF` — NYSE Global Indices\n- `IND_SPF` — S&P Complete Indices\n- `INDBVMF` — B3 / Brazil (Bm_Fbovespa)\n- `INDXNSE` — National Stock Exchange of India\n- `INDXSTU` — Borse Stuttgart\n- `INDXTSE` — Toronto Stock Exchange", "example": "IND_CBOM" } }, "securitySchemes": { "BearerAuth": { "type": "http", "scheme": "bearer", "bearerFormat": "JWT", "description": "OAuth2 access token (JWT). Obtain via Authorization Code or PKCE: 1) Redirect user to https://app.aries.com/oauth2/authorize 2) Exchange the callback code at POST https://api.aries.com/v1/oauth2/token 3) Use the response access_token here. Send header: Authorization: Bearer . Refresh using the same token endpoint with grant_type=refresh_token and refresh_token." }, "OAuth2": { "type": "oauth2", "description": "OAuth2 Bearer token: obtain an access token from the token endpoint and send it in the Authorization header.", "flows": { "clientCredentials": { "tokenUrl": "https://api.aries.com/v1/oauth2/token", "refreshUrl": "https://api.aries.com/v1/oauth2/token", "scopes": { "user:information": "View user profile and personal details", "account:information": "View account balances, positions, and transaction history", "order:execution": "Place, modify, and cancel orders", "order:information": "View order history and status", "position:information": "View current positions and holdings", "market:information": "Access live and historical market data", "calendar:information": "Access earnings, economic, and market schedule data", "options:information": "Access options chains and expiration data", "analytics:information": "View analytics, ratings, and market insights", "market:supplemental": "News, company profiles, financials, filings, ETF data, technical analysis", "user:management": "Manage user-scoped resources such as watchlists and other saved configuration." } }, "authorizationCode": { "authorizationUrl": "https://app.aries.com/oauth2/authorize", "tokenUrl": "https://api.aries.com/v1/oauth2/token", "refreshUrl": "https://api.aries.com/v1/oauth2/token", "scopes": { "user:information": "View user profile and personal details", "account:information": "View account balances, positions, and transaction history", "order:execution": "Place, modify, and cancel orders", "order:information": "View order history and status", "position:information": "View current positions and holdings", "market:information": "Access live and historical market data", "calendar:information": "Access earnings, economic, and market schedule data", "options:information": "Access options chains and expiration data", "analytics:information": "View analytics, ratings, and market insights", "market:supplemental": "News, company profiles, financials, filings, ETF data, technical analysis", "user:management": "Manage user-scoped resources such as watchlists and other saved configuration." } } } }, "ApiKeyAuth": { "in": "header", "name": "X-API-Key", "type": "apiKey", "description": "Optional API key (if applicable). Most calls use OAuth2 (Bearer token)." } } } }