{ "item": [ { "name": "API version", "description": "Endpoints for API service metadata.", "item": [ { "id": "bc4c4e0b-07bb-46f3-947c-4f593c61bdcf", "name": "Get the API version.", "request": { "name": "Get the API version.", "description": { "content": "Returns the current version string for this API endpoint.", "type": "text/plain" }, "url": { "path": [ "v1", "version" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "8ee31498-14c5-49d8-8083-d8cd880fa809", "name": "API version information", "originalRequest": { "url": { "path": [ "v1", "version" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"version\": \"\"\n },\n \"metadata\": {\n \"request_id\": \"\",\n \"next_page_token\": \"\",\n \"page_number\": \"\",\n \"previous_page_token\": \"\",\n \"total_items\": \"\",\n \"total_pages\": \"\"\n },\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ef6f2fd5-9ac2-4d7b-883b-c565a787127e", "name": "Internal server error", "originalRequest": { "url": { "path": [ "v1", "version" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"sunt_f\": false,\n \"magnae59\": 67421727\n },\n {\n \"minim48\": false,\n \"fugiat94d\": -43856089.03091218\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Accounts", "description": "Manage trading accounts, balances, and portfolio history.", "item": [ { "id": "fb634cfc-61a9-47a6-8c3a-eeef3a9a1774", "name": "Get Accounts", "request": { "name": "Get Accounts", "description": { "content": "List accounts the authenticated user has permission to access.\n\nResults can be narrowed with the optional `account_id` and `account_name`\nfilters. `account_id` is a lexicographic prefix match on the decimal account\nid (e.g. `100` matches `100345` and `100567`); `account_name` is a\ncase-insensitive substring match on the account's full name. When both are\nsupplied an account must match both. When neither is supplied every\naccessible account is returned.", "type": "text/plain" }, "url": { "path": [ "v1", "accounts" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The number of items to return per page. Only used when page_token is not provided.", "type": "text/plain" }, "key": "page_size", "value": "1000" }, { "disabled": false, "description": { "content": "Token for retrieving the next or previous page of results. Contains encoded pagination state; when provided, page_size is ignored.", "type": "text/plain" }, "key": "page_token", "value": "" }, { "disabled": false, "description": { "content": "Filter to accounts whose id starts with this value (lexicographic prefix match on the decimal id, e.g. `100` matches `100345`).", "type": "text/plain" }, "key": "account_id", "value": "" }, { "disabled": false, "description": { "content": "Filter to accounts whose full name contains this value (case-insensitive substring match).", "type": "text/plain" }, "key": "account_name", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "c0b8b751-9d15-48c9-97f3-e32af9237758", "name": "List of accounts", "originalRequest": { "url": { "path": [ "v1", "accounts" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The number of items to return per page. Only used when page_token is not provided.", "type": "text/plain" }, "key": "page_size", "value": "1000" }, { "disabled": false, "description": { "content": "Token for retrieving the next or previous page of results. Contains encoded pagination state; when provided, page_size is ignored.", "type": "text/plain" }, "key": "page_token", "value": "" }, { "disabled": false, "description": { "content": "Filter to accounts whose id starts with this value (lexicographic prefix match on the decimal id, e.g. `100` matches `100345`).", "type": "text/plain" }, "key": "account_id", "value": "" }, { "disabled": false, "description": { "content": "Filter to accounts whose full name contains this value (case-insensitive substring match).", "type": "text/plain" }, "key": "account_name", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"short_name\": \"\",\n \"full_name\": \"\",\n \"type\": \"CUSTOMER\",\n \"subtype\": \"CASH\",\n \"open_date\": \"\",\n \"account_holder_entity_id\": \"\",\n \"account_holder_entity_kind\": \"NATURAL_PERSON\",\n \"options_level\": \"\",\n \"status\": \"ACTIVE\",\n \"close_date\": \"\"\n },\n {\n \"id\": \"\",\n \"short_name\": \"\",\n \"full_name\": \"\",\n \"type\": \"OTHER\",\n \"subtype\": \"MARGIN\",\n \"open_date\": \"\",\n \"account_holder_entity_id\": \"\",\n \"account_holder_entity_kind\": \"NATURAL_PERSON\",\n \"options_level\": \"\",\n \"status\": \"CLOSED\",\n \"close_date\": \"\"\n }\n ],\n \"metadata\": {\n \"request_id\": \"\",\n \"next_page_token\": \"\",\n \"page_number\": \"\",\n \"previous_page_token\": \"\",\n \"total_items\": \"\",\n \"total_pages\": \"\"\n },\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b6f98c49-7dfb-44fa-bdfe-bcb5cccc8b10", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1", "accounts" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The number of items to return per page. Only used when page_token is not provided.", "type": "text/plain" }, "key": "page_size", "value": "1000" }, { "disabled": false, "description": { "content": "Token for retrieving the next or previous page of results. Contains encoded pagination state; when provided, page_size is ignored.", "type": "text/plain" }, "key": "page_token", "value": "" }, { "disabled": false, "description": { "content": "Filter to accounts whose id starts with this value (lexicographic prefix match on the decimal id, e.g. `100` matches `100345`).", "type": "text/plain" }, "key": "account_id", "value": "" }, { "disabled": false, "description": { "content": "Filter to accounts whose full name contains this value (case-insensitive substring match).", "type": "text/plain" }, "key": "account_name", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"sunt_f\": false,\n \"magnae59\": 67421727\n },\n {\n \"minim48\": false,\n \"fugiat94d\": -43856089.03091218\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "746c3dfb-248c-41b8-b6cd-d76d537c4031", "name": "Internal server error", "originalRequest": { "url": { "path": [ "v1", "accounts" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The number of items to return per page. Only used when page_token is not provided.", "type": "text/plain" }, "key": "page_size", "value": "1000" }, { "disabled": false, "description": { "content": "Token for retrieving the next or previous page of results. Contains encoded pagination state; when provided, page_size is ignored.", "type": "text/plain" }, "key": "page_token", "value": "" }, { "disabled": false, "description": { "content": "Filter to accounts whose id starts with this value (lexicographic prefix match on the decimal id, e.g. `100` matches `100345`).", "type": "text/plain" }, "key": "account_id", "value": "" }, { "disabled": false, "description": { "content": "Filter to accounts whose full name contains this value (case-insensitive substring match).", "type": "text/plain" }, "key": "account_name", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"sunt_f\": false,\n \"magnae59\": 67421727\n },\n {\n \"minim48\": false,\n \"fugiat94d\": -43856089.03091218\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5d909df0-b4b4-4868-98d4-07b79387dbdd", "name": "Get Account By ID", "request": { "name": "Get Account By ID", "description": { "content": "Fetch account details by ID, including the mailing address, date of\nbirth, phone number, and country of tax residency of the account-holder\nentity when on file.", "type": "text/plain" }, "url": { "path": [ "v1", "accounts", ":account_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "account_id", "disabled": false, "description": { "content": "(Required) Account identifier", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "012d99b4-18f8-4b24-9191-ccaa88736073", "name": "Account details", "originalRequest": { "url": { "path": [ "v1", "accounts", ":account_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"\",\n \"short_name\": \"\",\n \"full_name\": \"\",\n \"type\": \"OTHER\",\n \"subtype\": \"OTHER\",\n \"open_date\": \"\",\n \"account_holder_entity_id\": \"\",\n \"account_holder_entity_kind\": \"NATURAL_PERSON\",\n \"options_level\": \"\",\n \"status\": \"CLOSED\",\n \"close_date\": \"\",\n \"country_of_tax_residency\": \"\",\n \"date_of_birth\": \"\",\n \"mailing_address\": \"\",\n \"phone_number\": \"\"\n },\n \"metadata\": {\n \"request_id\": \"\",\n \"next_page_token\": \"\",\n \"page_number\": \"\",\n \"previous_page_token\": \"\",\n \"total_items\": \"\",\n \"total_pages\": \"\"\n },\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c1f40f07-cb1d-4a64-a638-64ec4518ceba", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1", "accounts", ":account_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"sunt_f\": false,\n \"magnae59\": 67421727\n },\n {\n \"minim48\": false,\n \"fugiat94d\": -43856089.03091218\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3c6ba934-6711-418b-a836-0694fc943007", "name": "Account not found", "originalRequest": { "url": { "path": [ "v1", "accounts", ":account_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"sunt_f\": false,\n \"magnae59\": 67421727\n },\n {\n \"minim48\": false,\n \"fugiat94d\": -43856089.03091218\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e7a0f23c-60eb-423a-831e-abbc3bdb331b", "name": "Internal server error", "originalRequest": { "url": { "path": [ "v1", "accounts", ":account_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"sunt_f\": false,\n \"magnae59\": 67421727\n },\n {\n \"minim48\": false,\n \"fugiat94d\": -43856089.03091218\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c5975f76-4346-4502-babb-e7b747f3deb3", "name": "Patch Account By ID", "request": { "name": "Patch Account By ID", "description": { "content": "Update account risk settings", "type": "text/plain" }, "url": { "path": [ "v1", "accounts", ":account_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "account_id", "disabled": false, "description": { "content": "(Required) Account identifier", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"risk\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "0289a1c2-7599-4edb-860d-206321386dc9", "name": "Account updated successfully", "originalRequest": { "url": { "path": [ "v1", "accounts", ":account_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"risk\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"risk\": \"\"\n },\n \"metadata\": {\n \"request_id\": \"\",\n \"next_page_token\": \"\",\n \"page_number\": \"\",\n \"previous_page_token\": \"\",\n \"total_items\": \"\",\n \"total_pages\": \"\"\n },\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f81dbc14-0827-4425-a6d1-bc7f3654177f", "name": "Invalid request", "originalRequest": { "url": { "path": [ "v1", "accounts", ":account_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"risk\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"sunt_f\": false,\n \"magnae59\": 67421727\n },\n {\n \"minim48\": false,\n \"fugiat94d\": -43856089.03091218\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a299edfd-74e8-4947-8ef5-a87d348902f1", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1", "accounts", ":account_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"risk\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"sunt_f\": false,\n \"magnae59\": 67421727\n },\n {\n \"minim48\": false,\n \"fugiat94d\": -43856089.03091218\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cb3b18fc-d1dc-436e-9185-77b7f31d81b7", "name": "Account not found", "originalRequest": { "url": { "path": [ "v1", "accounts", ":account_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"risk\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"sunt_f\": false,\n \"magnae59\": 67421727\n },\n {\n \"minim48\": false,\n \"fugiat94d\": -43856089.03091218\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b5ea0aed-0cdf-497a-9a17-7e074b1d7371", "name": "Internal server error", "originalRequest": { "url": { "path": [ "v1", "accounts", ":account_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"risk\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"sunt_f\": false,\n \"magnae59\": 67421727\n },\n {\n \"minim48\": false,\n \"fugiat94d\": -43856089.03091218\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7e8645c7-1554-4d58-87e4-3cdeac221423", "name": "Get Account Balances", "request": { "name": "Get Account Balances", "description": { "content": "Fetch account balance information", "type": "text/plain" }, "url": { "path": [ "v1", "accounts", ":account_id", "balances" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Limit the number of top margin contributors returned.", "type": "text/plain" }, "key": "top_margin_contributors_limit", "value": "" } ], "variable": [ { "type": "any", "value": "", "key": "account_id", "disabled": false, "description": { "content": "(Required) Account identifier", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "9583628e-34d1-4ec5-adcc-928c2e72ba1e", "name": "Account balance information", "originalRequest": { "url": { "path": [ "v1", "accounts", ":account_id", "balances" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Limit the number of top margin contributors returned.", "type": "text/plain" }, "key": "top_margin_contributors_limit", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"account_id\": \"\",\n \"buying_power\": \"\",\n \"currency\": \"\",\n \"equity\": \"\",\n \"long_market_value\": \"\",\n \"settled_cash\": \"\",\n \"withdrawable_cash\": \"\",\n \"trade_cash\": \"\",\n \"open_order_adjustment\": \"\",\n \"unsettled_credits\": \"\",\n \"unsettled_debits\": \"\",\n \"margin_type\": \"NONE\",\n \"unrealized_pnl\": \"\",\n \"daily_unrealized_pnl\": \"\",\n \"daily_pnl\": \"\",\n \"daily_change\": \"\",\n \"daily_realized_pnl\": \"\",\n \"sod\": {\n \"buying_power\": \"\",\n \"equity\": \"\",\n \"long_market_value\": \"\",\n \"short_market_value\": \"\",\n \"asof\": \"\",\n \"maintenance_margin_excess\": \"\",\n \"maintenance_margin_requirement\": \"\",\n \"trade_cash\": \"\"\n },\n \"margin_details\": \"\",\n \"multiplier\": \"\",\n \"short_market_value\": \"\"\n },\n \"metadata\": {\n \"request_id\": \"\",\n \"next_page_token\": \"\",\n \"page_number\": \"\",\n \"previous_page_token\": \"\",\n \"total_items\": \"\",\n \"total_pages\": \"\"\n },\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9621c417-bf85-47f2-ad6b-5e52e30b5c44", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1", "accounts", ":account_id", "balances" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Limit the number of top margin contributors returned.", "type": "text/plain" }, "key": "top_margin_contributors_limit", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"sunt_f\": false,\n \"magnae59\": 67421727\n },\n {\n \"minim48\": false,\n \"fugiat94d\": -43856089.03091218\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0cda2ef8-4d5d-40c4-b836-65b088db9f0a", "name": "Account not found", "originalRequest": { "url": { "path": [ "v1", "accounts", ":account_id", "balances" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Limit the number of top margin contributors returned.", "type": "text/plain" }, "key": "top_margin_contributors_limit", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"sunt_f\": false,\n \"magnae59\": 67421727\n },\n {\n \"minim48\": false,\n \"fugiat94d\": -43856089.03091218\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3a39cabe-67e5-4e58-a386-c1c843c20e66", "name": "Internal server error", "originalRequest": { "url": { "path": [ "v1", "accounts", ":account_id", "balances" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Limit the number of top margin contributors returned.", "type": "text/plain" }, "key": "top_margin_contributors_limit", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"sunt_f\": false,\n \"magnae59\": 67421727\n },\n {\n \"minim48\": false,\n \"fugiat94d\": -43856089.03091218\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "79306c81-500f-468f-a287-541913e40a64", "name": "Get Portfolio History", "request": { "name": "Get Portfolio History", "description": { "content": "Retrieves daily portfolio history for the specified account.", "type": "text/plain" }, "url": { "path": [ "v1", "accounts", ":account_id", "portfolio-history" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Start date for the portfolio history range, in YYYY-MM-DD format.", "type": "text/plain" }, "key": "start_date", "value": "" }, { "disabled": false, "description": { "content": "Defaults to today in America/New_York when omitted.", "type": "text/plain" }, "key": "end_date", "value": "" } ], "variable": [ { "type": "any", "value": "", "key": "account_id", "disabled": false, "description": { "content": "(Required) Account identifier", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "c9822c30-2269-4515-acfd-e1f5a29dcfeb", "name": "Portfolio history", "originalRequest": { "url": { "path": [ "v1", "accounts", ":account_id", "portfolio-history" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Start date for the portfolio history range, in YYYY-MM-DD format.", "type": "text/plain" }, "key": "start_date", "value": "" }, { "disabled": false, "description": { "content": "Defaults to today in America/New_York when omitted.", "type": "text/plain" }, "key": "end_date", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"segments\": [\n {\n \"date\": \"\",\n \"realized_pnl\": \"\",\n \"unrealized_pnl\": \"\",\n \"sod_equity\": \"\",\n \"eod_equity\": \"\",\n \"bought_notional\": \"\",\n \"day_pnl\": \"\",\n \"net_pnl\": \"\",\n \"position_pnl\": \"\",\n \"sold_notional\": \"\"\n },\n {\n \"date\": \"\",\n \"realized_pnl\": \"\",\n \"unrealized_pnl\": \"\",\n \"sod_equity\": \"\",\n \"eod_equity\": \"\",\n \"bought_notional\": \"\",\n \"day_pnl\": \"\",\n \"net_pnl\": \"\",\n \"position_pnl\": \"\",\n \"sold_notional\": \"\"\n }\n ]\n },\n \"metadata\": {\n \"request_id\": \"\",\n \"next_page_token\": \"\",\n \"page_number\": \"\",\n \"previous_page_token\": \"\",\n \"total_items\": \"\",\n \"total_pages\": \"\"\n },\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0f55c576-1184-465e-8556-f959e24ca187", "name": "Partial success: some data is available but the full request could not be completed", "originalRequest": { "url": { "path": [ "v1", "accounts", ":account_id", "portfolio-history" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Start date for the portfolio history range, in YYYY-MM-DD format.", "type": "text/plain" }, "key": "start_date", "value": "" }, { "disabled": false, "description": { "content": "Defaults to today in America/New_York when omitted.", "type": "text/plain" }, "key": "end_date", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Multi-Status (WebDAV) (RFC 4918)", "code": 207, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"segments\": [\n {\n \"date\": \"\",\n \"realized_pnl\": \"\",\n \"unrealized_pnl\": \"\",\n \"sod_equity\": \"\",\n \"eod_equity\": \"\",\n \"bought_notional\": \"\",\n \"day_pnl\": \"\",\n \"net_pnl\": \"\",\n \"position_pnl\": \"\",\n \"sold_notional\": \"\"\n },\n {\n \"date\": \"\",\n \"realized_pnl\": \"\",\n \"unrealized_pnl\": \"\",\n \"sod_equity\": \"\",\n \"eod_equity\": \"\",\n \"bought_notional\": \"\",\n \"day_pnl\": \"\",\n \"net_pnl\": \"\",\n \"position_pnl\": \"\",\n \"sold_notional\": \"\"\n }\n ]\n },\n \"metadata\": {\n \"request_id\": \"\",\n \"next_page_token\": \"\",\n \"page_number\": \"\",\n \"previous_page_token\": \"\",\n \"total_items\": \"\",\n \"total_pages\": \"\"\n },\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "960bfa28-ea14-4f28-ae03-d7beb994d50a", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1", "accounts", ":account_id", "portfolio-history" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Start date for the portfolio history range, in YYYY-MM-DD format.", "type": "text/plain" }, "key": "start_date", "value": "" }, { "disabled": false, "description": { "content": "Defaults to today in America/New_York when omitted.", "type": "text/plain" }, "key": "end_date", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"sunt_f\": false,\n \"magnae59\": 67421727\n },\n {\n \"minim48\": false,\n \"fugiat94d\": -43856089.03091218\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2c94472f-7225-4ec0-bd7a-ed22c2fb8d71", "name": "Internal server error", "originalRequest": { "url": { "path": [ "v1", "accounts", ":account_id", "portfolio-history" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Start date for the portfolio history range, in YYYY-MM-DD format.", "type": "text/plain" }, "key": "start_date", "value": "" }, { "disabled": false, "description": { "content": "Defaults to today in America/New_York when omitted.", "type": "text/plain" }, "key": "end_date", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"sunt_f\": false,\n \"magnae59\": 67421727\n },\n {\n \"minim48\": false,\n \"fugiat94d\": -43856089.03091218\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Orders", "description": "Place, monitor, and manage trading orders.", "item": [ { "id": "53707eab-5a6d-4498-914d-b59533b70277", "name": "Get Executions", "request": { "name": "Get Executions", "description": { "content": "Retrieves filled and partially-filled execution reports for the specified\ntrading account, ordered by transaction time (nanosecond precision) descending.", "type": "text/plain" }, "url": { "path": [ "v1", "accounts", ":account_id", "executions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Comma-separated instrument identifiers (UUIDs) or symbols (e.g. `AAPL`) to filter by. When provided, only executions for any of the listed instruments are returned.", "type": "text/plain" }, "key": "instrument_ids", "value": "," }, { "disabled": false, "description": { "content": "Comma-separated order IDs to filter by. When provided, only executions belonging to an order in this set are returned.", "type": "text/plain" }, "key": "order_ids", "value": "," }, { "disabled": false, "description": { "content": "Comma-separated instrument IDs (UUID) or symbols (equity tickers or OSI option symbols). Matches option fills whose resolved underlier is any of the given instruments.", "type": "text/plain" }, "key": "underlying_instrument_ids", "value": "," }, { "disabled": false, "description": { "content": "The number of items to return per page. Only used when page_token is not provided.", "type": "text/plain" }, "key": "page_size", "value": "1000" }, { "disabled": false, "description": { "content": "Token for retrieving the next or previous page of results. Contains encoded pagination state; when provided, page_size is ignored.", "type": "text/plain" }, "key": "page_token", "value": "" }, { "disabled": false, "description": { "content": "The start date and time for the query range, inclusive (ISO 8601 format)", "type": "text/plain" }, "key": "from", "value": "" }, { "disabled": false, "description": { "content": "The end date and time for the query range, inclusive (ISO 8601 format)", "type": "text/plain" }, "key": "to", "value": "" } ], "variable": [ { "type": "any", "value": "", "key": "account_id", "disabled": false, "description": { "content": "(Required) Account identifier", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "df3dfe53-798c-4621-93c6-8e217725068d", "name": "List of executions", "originalRequest": { "url": { "path": [ "v1", "accounts", ":account_id", "executions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Comma-separated instrument identifiers (UUIDs) or symbols (e.g. `AAPL`) to filter by. When provided, only executions for any of the listed instruments are returned.", "type": "text/plain" }, "key": "instrument_ids", "value": "," }, { "disabled": false, "description": { "content": "Comma-separated order IDs to filter by. When provided, only executions belonging to an order in this set are returned.", "type": "text/plain" }, "key": "order_ids", "value": "," }, { "disabled": false, "description": { "content": "Comma-separated instrument IDs (UUID) or symbols (equity tickers or OSI option symbols). Matches option fills whose resolved underlier is any of the given instruments.", "type": "text/plain" }, "key": "underlying_instrument_ids", "value": "," }, { "disabled": false, "description": { "content": "The number of items to return per page. Only used when page_token is not provided.", "type": "text/plain" }, "key": "page_size", "value": "1000" }, { "disabled": false, "description": { "content": "Token for retrieving the next or previous page of results. Contains encoded pagination state; when provided, page_size is ignored.", "type": "text/plain" }, "key": "page_token", "value": "" }, { "disabled": false, "description": { "content": "The start date and time for the query range, inclusive (ISO 8601 format)", "type": "text/plain" }, "key": "from", "value": "" }, { "disabled": false, "description": { "content": "The end date and time for the query range, inclusive (ISO 8601 format)", "type": "text/plain" }, "key": "to", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"order_id\": \"\",\n \"side\": \"BUY\",\n \"quantity\": \"\",\n \"transaction_time\": \"\",\n \"instrument_id\": \"\",\n \"price\": \"\",\n \"symbol\": \"\",\n \"underlying_instrument_id\": \"\",\n \"underlying_instrument_type\": \"\",\n \"venue\": \"\"\n },\n {\n \"id\": \"\",\n \"order_id\": \"\",\n \"side\": \"BUY\",\n \"quantity\": \"\",\n \"transaction_time\": \"\",\n \"instrument_id\": \"\",\n \"price\": \"\",\n \"symbol\": \"\",\n \"underlying_instrument_id\": \"\",\n \"underlying_instrument_type\": \"\",\n \"venue\": \"\"\n }\n ],\n \"metadata\": {\n \"request_id\": \"\",\n \"next_page_token\": \"\",\n \"page_number\": \"\",\n \"previous_page_token\": \"\",\n \"total_items\": \"\",\n \"total_pages\": \"\"\n },\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "148553fa-bc94-4248-90d1-aa5fcac87500", "name": "Invalid request parameters", "originalRequest": { "url": { "path": [ "v1", "accounts", ":account_id", "executions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Comma-separated instrument identifiers (UUIDs) or symbols (e.g. `AAPL`) to filter by. When provided, only executions for any of the listed instruments are returned.", "type": "text/plain" }, "key": "instrument_ids", "value": "," }, { "disabled": false, "description": { "content": "Comma-separated order IDs to filter by. When provided, only executions belonging to an order in this set are returned.", "type": "text/plain" }, "key": "order_ids", "value": "," }, { "disabled": false, "description": { "content": "Comma-separated instrument IDs (UUID) or symbols (equity tickers or OSI option symbols). Matches option fills whose resolved underlier is any of the given instruments.", "type": "text/plain" }, "key": "underlying_instrument_ids", "value": "," }, { "disabled": false, "description": { "content": "The number of items to return per page. Only used when page_token is not provided.", "type": "text/plain" }, "key": "page_size", "value": "1000" }, { "disabled": false, "description": { "content": "Token for retrieving the next or previous page of results. Contains encoded pagination state; when provided, page_size is ignored.", "type": "text/plain" }, "key": "page_token", "value": "" }, { "disabled": false, "description": { "content": "The start date and time for the query range, inclusive (ISO 8601 format)", "type": "text/plain" }, "key": "from", "value": "" }, { "disabled": false, "description": { "content": "The end date and time for the query range, inclusive (ISO 8601 format)", "type": "text/plain" }, "key": "to", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"sunt_f\": false,\n \"magnae59\": 67421727\n },\n {\n \"minim48\": false,\n \"fugiat94d\": -43856089.03091218\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3e185f3c-0624-469a-986e-5c77c475ca2a", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1", "accounts", ":account_id", "executions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Comma-separated instrument identifiers (UUIDs) or symbols (e.g. `AAPL`) to filter by. When provided, only executions for any of the listed instruments are returned.", "type": "text/plain" }, "key": "instrument_ids", "value": "," }, { "disabled": false, "description": { "content": "Comma-separated order IDs to filter by. When provided, only executions belonging to an order in this set are returned.", "type": "text/plain" }, "key": "order_ids", "value": "," }, { "disabled": false, "description": { "content": "Comma-separated instrument IDs (UUID) or symbols (equity tickers or OSI option symbols). Matches option fills whose resolved underlier is any of the given instruments.", "type": "text/plain" }, "key": "underlying_instrument_ids", "value": "," }, { "disabled": false, "description": { "content": "The number of items to return per page. Only used when page_token is not provided.", "type": "text/plain" }, "key": "page_size", "value": "1000" }, { "disabled": false, "description": { "content": "Token for retrieving the next or previous page of results. Contains encoded pagination state; when provided, page_size is ignored.", "type": "text/plain" }, "key": "page_token", "value": "" }, { "disabled": false, "description": { "content": "The start date and time for the query range, inclusive (ISO 8601 format)", "type": "text/plain" }, "key": "from", "value": "" }, { "disabled": false, "description": { "content": "The end date and time for the query range, inclusive (ISO 8601 format)", "type": "text/plain" }, "key": "to", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"sunt_f\": false,\n \"magnae59\": 67421727\n },\n {\n \"minim48\": false,\n \"fugiat94d\": -43856089.03091218\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9a299ada-c644-45e9-abce-cb85bea31ea1", "name": "Internal server error", "originalRequest": { "url": { "path": [ "v1", "accounts", ":account_id", "executions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Comma-separated instrument identifiers (UUIDs) or symbols (e.g. `AAPL`) to filter by. When provided, only executions for any of the listed instruments are returned.", "type": "text/plain" }, "key": "instrument_ids", "value": "," }, { "disabled": false, "description": { "content": "Comma-separated order IDs to filter by. When provided, only executions belonging to an order in this set are returned.", "type": "text/plain" }, "key": "order_ids", "value": "," }, { "disabled": false, "description": { "content": "Comma-separated instrument IDs (UUID) or symbols (equity tickers or OSI option symbols). Matches option fills whose resolved underlier is any of the given instruments.", "type": "text/plain" }, "key": "underlying_instrument_ids", "value": "," }, { "disabled": false, "description": { "content": "The number of items to return per page. Only used when page_token is not provided.", "type": "text/plain" }, "key": "page_size", "value": "1000" }, { "disabled": false, "description": { "content": "Token for retrieving the next or previous page of results. Contains encoded pagination state; when provided, page_size is ignored.", "type": "text/plain" }, "key": "page_token", "value": "" }, { "disabled": false, "description": { "content": "The start date and time for the query range, inclusive (ISO 8601 format)", "type": "text/plain" }, "key": "from", "value": "" }, { "disabled": false, "description": { "content": "The end date and time for the query range, inclusive (ISO 8601 format)", "type": "text/plain" }, "key": "to", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"sunt_f\": false,\n \"magnae59\": 67421727\n },\n {\n \"minim48\": false,\n \"fugiat94d\": -43856089.03091218\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "305a5ebf-dce6-468f-8f12-aec4361f2705", "name": "Get Orders", "request": { "name": "Get Orders", "description": { "content": "List orders for an account with optional filtering", "type": "text/plain" }, "url": { "path": [ "v1", "accounts", ":account_id", "orders" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The number of items to return per page. Only used when page_token is not provided.", "type": "text/plain" }, "key": "page_size", "value": "1000" }, { "disabled": false, "description": { "content": "Token for retrieving the next or previous page of results. Contains encoded pagination state; when provided, page_size is ignored.", "type": "text/plain" }, "key": "page_token", "value": "" }, { "disabled": false, "description": { "content": "Comma-separated list of order identifiers. Each value may be an order's `id` or its `client_order_id`; only orders matching one of the given identifiers are returned.", "type": "text/plain" }, "key": "order_ids", "value": "," }, { "disabled": false, "description": { "content": "Comma-separated order statuses to filter by", "type": "text/plain" }, "key": "status", "value": "STOPPED,STOPPED" }, { "disabled": false, "description": { "content": "Filter by symbol", "type": "text/plain" }, "key": "symbol", "value": "" }, { "disabled": false, "description": { "content": "Comma-separated instrument IDs (UUID) or symbols (equity tickers or OSI option symbols).", "type": "text/plain" }, "key": "instrument_ids", "value": "," }, { "disabled": false, "description": { "content": "Instrument type filter (e.g., COMMON_STOCK, OPTION)", "type": "text/plain" }, "key": "instrument_type", "value": "COMMON_STOCK" }, { "disabled": false, "description": { "content": "Comma-separated instrument IDs (UUID) or symbols (equity tickers or OSI option symbols). Matches options orders whose resolved underlier is any of the given instruments.", "type": "text/plain" }, "key": "underlying_instrument_ids", "value": "," }, { "disabled": false, "description": { "content": "The start date and time for the query range, inclusive (ISO 8601 format)", "type": "text/plain" }, "key": "from", "value": "" }, { "disabled": false, "description": { "content": "The end date and time for the query range, inclusive (ISO 8601 format)", "type": "text/plain" }, "key": "to", "value": "" } ], "variable": [ { "type": "any", "value": "", "key": "account_id", "disabled": false, "description": { "content": "(Required) Account identifier", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "cef9c877-3fb0-4c9c-8b05-674d57235d64", "name": "List of orders", "originalRequest": { "url": { "path": [ "v1", "accounts", ":account_id", "orders" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The number of items to return per page. Only used when page_token is not provided.", "type": "text/plain" }, "key": "page_size", "value": "1000" }, { "disabled": false, "description": { "content": "Token for retrieving the next or previous page of results. Contains encoded pagination state; when provided, page_size is ignored.", "type": "text/plain" }, "key": "page_token", "value": "" }, { "disabled": false, "description": { "content": "Comma-separated list of order identifiers. Each value may be an order's `id` or its `client_order_id`; only orders matching one of the given identifiers are returned.", "type": "text/plain" }, "key": "order_ids", "value": "," }, { "disabled": false, "description": { "content": "Comma-separated order statuses to filter by", "type": "text/plain" }, "key": "status", "value": "STOPPED,STOPPED" }, { "disabled": false, "description": { "content": "Filter by symbol", "type": "text/plain" }, "key": "symbol", "value": "" }, { "disabled": false, "description": { "content": "Comma-separated instrument IDs (UUID) or symbols (equity tickers or OSI option symbols).", "type": "text/plain" }, "key": "instrument_ids", "value": "," }, { "disabled": false, "description": { "content": "Instrument type filter (e.g., COMMON_STOCK, OPTION)", "type": "text/plain" }, "key": "instrument_type", "value": "COMMON_STOCK" }, { "disabled": false, "description": { "content": "Comma-separated instrument IDs (UUID) or symbols (equity tickers or OSI option symbols). Matches options orders whose resolved underlier is any of the given instruments.", "type": "text/plain" }, "key": "underlying_instrument_ids", "value": "," }, { "disabled": false, "description": { "content": "The start date and time for the query range, inclusive (ISO 8601 format)", "type": "text/plain" }, "key": "from", "value": "" }, { "disabled": false, "description": { "content": "The end date and time for the query range, inclusive (ISO 8601 format)", "type": "text/plain" }, "key": "to", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"client_order_id\": \"\",\n \"account_id\": \"\",\n \"venue\": \"\",\n \"side\": \"SELL\",\n \"quantity\": \"\",\n \"order_type\": \"MARKET\",\n \"time_in_force\": \"AT_CLOSE\",\n \"status\": \"PENDING_CANCEL\",\n \"filled_quantity\": \"\",\n \"leaves_quantity\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"average_fill_price\": \"\",\n \"details\": [\n \"\",\n \"\"\n ],\n \"expires_at\": \"\",\n \"extended_hours\": \"\",\n \"instrument_id\": \"\",\n \"instrument_type\": \"\",\n \"limit_offset\": \"\",\n \"limit_price\": \"\",\n \"queue_state\": \"\",\n \"releases_at\": \"\",\n \"stop_price\": \"\",\n \"strategy\": {\n \"type\": \"\",\n \"end_at\": \"\",\n \"start_at\": \"\"\n },\n \"symbol\": \"\",\n \"trailing_limit_px\": \"\",\n \"trailing_offset\": \"\",\n \"trailing_offset_type\": \"\",\n \"trailing_stop_px\": \"\",\n \"trailing_watermark_px\": \"\",\n \"trailing_watermark_ts\": \"\",\n \"underlying_instrument_id\": \"\",\n \"underlying_instrument_type\": \"\"\n },\n {\n \"id\": \"\",\n \"client_order_id\": \"\",\n \"account_id\": \"\",\n \"venue\": \"\",\n \"side\": \"SELL\",\n \"quantity\": \"\",\n \"order_type\": \"LIMIT\",\n \"time_in_force\": \"AT_OPEN\",\n \"status\": \"REJECTED\",\n \"filled_quantity\": \"\",\n \"leaves_quantity\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"average_fill_price\": \"\",\n \"details\": [\n \"\",\n \"\"\n ],\n \"expires_at\": \"\",\n \"extended_hours\": \"\",\n \"instrument_id\": \"\",\n \"instrument_type\": \"\",\n \"limit_offset\": \"\",\n \"limit_price\": \"\",\n \"queue_state\": \"\",\n \"releases_at\": \"\",\n \"stop_price\": \"\",\n \"strategy\": {\n \"type\": \"\",\n \"end_at\": \"\",\n \"start_at\": \"\"\n },\n \"symbol\": \"\",\n \"trailing_limit_px\": \"\",\n \"trailing_offset\": \"\",\n \"trailing_offset_type\": \"\",\n \"trailing_stop_px\": \"\",\n \"trailing_watermark_px\": \"\",\n \"trailing_watermark_ts\": \"\",\n \"underlying_instrument_id\": \"\",\n \"underlying_instrument_type\": \"\"\n }\n ],\n \"metadata\": {\n \"request_id\": \"\",\n \"next_page_token\": \"\",\n \"page_number\": \"\",\n \"previous_page_token\": \"\",\n \"total_items\": \"\",\n \"total_pages\": \"\"\n },\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4b8d4ec1-b633-49d1-b481-d3423b220b75", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1", "accounts", ":account_id", "orders" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The number of items to return per page. Only used when page_token is not provided.", "type": "text/plain" }, "key": "page_size", "value": "1000" }, { "disabled": false, "description": { "content": "Token for retrieving the next or previous page of results. Contains encoded pagination state; when provided, page_size is ignored.", "type": "text/plain" }, "key": "page_token", "value": "" }, { "disabled": false, "description": { "content": "Comma-separated list of order identifiers. Each value may be an order's `id` or its `client_order_id`; only orders matching one of the given identifiers are returned.", "type": "text/plain" }, "key": "order_ids", "value": "," }, { "disabled": false, "description": { "content": "Comma-separated order statuses to filter by", "type": "text/plain" }, "key": "status", "value": "STOPPED,STOPPED" }, { "disabled": false, "description": { "content": "Filter by symbol", "type": "text/plain" }, "key": "symbol", "value": "" }, { "disabled": false, "description": { "content": "Comma-separated instrument IDs (UUID) or symbols (equity tickers or OSI option symbols).", "type": "text/plain" }, "key": "instrument_ids", "value": "," }, { "disabled": false, "description": { "content": "Instrument type filter (e.g., COMMON_STOCK, OPTION)", "type": "text/plain" }, "key": "instrument_type", "value": "COMMON_STOCK" }, { "disabled": false, "description": { "content": "Comma-separated instrument IDs (UUID) or symbols (equity tickers or OSI option symbols). Matches options orders whose resolved underlier is any of the given instruments.", "type": "text/plain" }, "key": "underlying_instrument_ids", "value": "," }, { "disabled": false, "description": { "content": "The start date and time for the query range, inclusive (ISO 8601 format)", "type": "text/plain" }, "key": "from", "value": "" }, { "disabled": false, "description": { "content": "The end date and time for the query range, inclusive (ISO 8601 format)", "type": "text/plain" }, "key": "to", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"sunt_f\": false,\n \"magnae59\": 67421727\n },\n {\n \"minim48\": false,\n \"fugiat94d\": -43856089.03091218\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e0c83243-eba1-434a-9aec-6f4a1874cffc", "name": "Internal server error", "originalRequest": { "url": { "path": [ "v1", "accounts", ":account_id", "orders" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The number of items to return per page. Only used when page_token is not provided.", "type": "text/plain" }, "key": "page_size", "value": "1000" }, { "disabled": false, "description": { "content": "Token for retrieving the next or previous page of results. Contains encoded pagination state; when provided, page_size is ignored.", "type": "text/plain" }, "key": "page_token", "value": "" }, { "disabled": false, "description": { "content": "Comma-separated list of order identifiers. Each value may be an order's `id` or its `client_order_id`; only orders matching one of the given identifiers are returned.", "type": "text/plain" }, "key": "order_ids", "value": "," }, { "disabled": false, "description": { "content": "Comma-separated order statuses to filter by", "type": "text/plain" }, "key": "status", "value": "STOPPED,STOPPED" }, { "disabled": false, "description": { "content": "Filter by symbol", "type": "text/plain" }, "key": "symbol", "value": "" }, { "disabled": false, "description": { "content": "Comma-separated instrument IDs (UUID) or symbols (equity tickers or OSI option symbols).", "type": "text/plain" }, "key": "instrument_ids", "value": "," }, { "disabled": false, "description": { "content": "Instrument type filter (e.g., COMMON_STOCK, OPTION)", "type": "text/plain" }, "key": "instrument_type", "value": "COMMON_STOCK" }, { "disabled": false, "description": { "content": "Comma-separated instrument IDs (UUID) or symbols (equity tickers or OSI option symbols). Matches options orders whose resolved underlier is any of the given instruments.", "type": "text/plain" }, "key": "underlying_instrument_ids", "value": "," }, { "disabled": false, "description": { "content": "The start date and time for the query range, inclusive (ISO 8601 format)", "type": "text/plain" }, "key": "from", "value": "" }, { "disabled": false, "description": { "content": "The end date and time for the query range, inclusive (ISO 8601 format)", "type": "text/plain" }, "key": "to", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"sunt_f\": false,\n \"magnae59\": 67421727\n },\n {\n \"minim48\": false,\n \"fugiat94d\": -43856089.03091218\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "dde0a3ba-dd7a-45a9-805a-aab92fe6d367", "name": "Submit Orders", "request": { "name": "Submit Orders", "description": { "content": "Submit new orders", "type": "text/plain" }, "url": { "path": [ "v1", "accounts", ":account_id", "orders" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "account_id", "disabled": false, "description": { "content": "(Required) Account identifier", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "[\n {\n \"side\": \"SELL\",\n \"quantity\": \"\",\n \"order_type\": \"STOP\",\n \"time_in_force\": \"GOOD_TILL_DATE\",\n \"expires_at\": \"\",\n \"extended_hours\": \"\",\n \"id\": \"\",\n \"instrument_id\": \"\",\n \"limit_offset\": \"\",\n \"limit_price\": \"\",\n \"position_intent\": \"\",\n \"stop_price\": \"\",\n \"strategy\": \"\",\n \"symbol\": \"\",\n \"trailing_offset\": \"\",\n \"trailing_offset_type\": \"\"\n },\n {\n \"side\": \"BUY\",\n \"quantity\": \"\",\n \"order_type\": \"MARKET\",\n \"time_in_force\": \"GOOD_TILL_DATE\",\n \"expires_at\": \"\",\n \"extended_hours\": \"\",\n \"id\": \"\",\n \"instrument_id\": \"\",\n \"limit_offset\": \"\",\n \"limit_price\": \"\",\n \"position_intent\": \"\",\n \"stop_price\": \"\",\n \"strategy\": \"\",\n \"symbol\": \"\",\n \"trailing_offset\": \"\",\n \"trailing_offset_type\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "2c78c81f-f566-48ca-b57b-42bd191c05bd", "name": "Orders submitted successfully", "originalRequest": { "url": { "path": [ "v1", "accounts", ":account_id", "orders" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "[\n {\n \"side\": \"SELL\",\n \"quantity\": \"\",\n \"order_type\": \"STOP\",\n \"time_in_force\": \"GOOD_TILL_DATE\",\n \"expires_at\": \"\",\n \"extended_hours\": \"\",\n \"id\": \"\",\n \"instrument_id\": \"\",\n \"limit_offset\": \"\",\n \"limit_price\": \"\",\n \"position_intent\": \"\",\n \"stop_price\": \"\",\n \"strategy\": \"\",\n \"symbol\": \"\",\n \"trailing_offset\": \"\",\n \"trailing_offset_type\": \"\"\n },\n {\n \"side\": \"BUY\",\n \"quantity\": \"\",\n \"order_type\": \"MARKET\",\n \"time_in_force\": \"GOOD_TILL_DATE\",\n \"expires_at\": \"\",\n \"extended_hours\": \"\",\n \"id\": \"\",\n \"instrument_id\": \"\",\n \"limit_offset\": \"\",\n \"limit_price\": \"\",\n \"position_intent\": \"\",\n \"stop_price\": \"\",\n \"strategy\": \"\",\n \"symbol\": \"\",\n \"trailing_offset\": \"\",\n \"trailing_offset_type\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"client_order_id\": \"\",\n \"account_id\": \"\",\n \"venue\": \"\",\n \"side\": \"SELL\",\n \"quantity\": \"\",\n \"order_type\": \"MARKET\",\n \"time_in_force\": \"AT_CLOSE\",\n \"status\": \"PENDING_CANCEL\",\n \"filled_quantity\": \"\",\n \"leaves_quantity\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"average_fill_price\": \"\",\n \"details\": [\n \"\",\n \"\"\n ],\n \"expires_at\": \"\",\n \"extended_hours\": \"\",\n \"instrument_id\": \"\",\n \"instrument_type\": \"\",\n \"limit_offset\": \"\",\n \"limit_price\": \"\",\n \"queue_state\": \"\",\n \"releases_at\": \"\",\n \"stop_price\": \"\",\n \"strategy\": {\n \"type\": \"\",\n \"end_at\": \"\",\n \"start_at\": \"\"\n },\n \"symbol\": \"\",\n \"trailing_limit_px\": \"\",\n \"trailing_offset\": \"\",\n \"trailing_offset_type\": \"\",\n \"trailing_stop_px\": \"\",\n \"trailing_watermark_px\": \"\",\n \"trailing_watermark_ts\": \"\",\n \"underlying_instrument_id\": \"\",\n \"underlying_instrument_type\": \"\"\n },\n {\n \"id\": \"\",\n \"client_order_id\": \"\",\n \"account_id\": \"\",\n \"venue\": \"\",\n \"side\": \"SELL\",\n \"quantity\": \"\",\n \"order_type\": \"LIMIT\",\n \"time_in_force\": \"AT_OPEN\",\n \"status\": \"REJECTED\",\n \"filled_quantity\": \"\",\n \"leaves_quantity\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"average_fill_price\": \"\",\n \"details\": [\n \"\",\n \"\"\n ],\n \"expires_at\": \"\",\n \"extended_hours\": \"\",\n \"instrument_id\": \"\",\n \"instrument_type\": \"\",\n \"limit_offset\": \"\",\n \"limit_price\": \"\",\n \"queue_state\": \"\",\n \"releases_at\": \"\",\n \"stop_price\": \"\",\n \"strategy\": {\n \"type\": \"\",\n \"end_at\": \"\",\n \"start_at\": \"\"\n },\n \"symbol\": \"\",\n \"trailing_limit_px\": \"\",\n \"trailing_offset\": \"\",\n \"trailing_offset_type\": \"\",\n \"trailing_stop_px\": \"\",\n \"trailing_watermark_px\": \"\",\n \"trailing_watermark_ts\": \"\",\n \"underlying_instrument_id\": \"\",\n \"underlying_instrument_type\": \"\"\n }\n ],\n \"metadata\": {\n \"request_id\": \"\",\n \"next_page_token\": \"\",\n \"page_number\": \"\",\n \"previous_page_token\": \"\",\n \"total_items\": \"\",\n \"total_pages\": \"\"\n },\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "089a7402-2407-4fcd-b53d-161d61423c09", "name": "Invalid order request", "originalRequest": { "url": { "path": [ "v1", "accounts", ":account_id", "orders" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "[\n {\n \"side\": \"SELL\",\n \"quantity\": \"\",\n \"order_type\": \"STOP\",\n \"time_in_force\": \"GOOD_TILL_DATE\",\n \"expires_at\": \"\",\n \"extended_hours\": \"\",\n \"id\": \"\",\n \"instrument_id\": \"\",\n \"limit_offset\": \"\",\n \"limit_price\": \"\",\n \"position_intent\": \"\",\n \"stop_price\": \"\",\n \"strategy\": \"\",\n \"symbol\": \"\",\n \"trailing_offset\": \"\",\n \"trailing_offset_type\": \"\"\n },\n {\n \"side\": \"BUY\",\n \"quantity\": \"\",\n \"order_type\": \"MARKET\",\n \"time_in_force\": \"GOOD_TILL_DATE\",\n \"expires_at\": \"\",\n \"extended_hours\": \"\",\n \"id\": \"\",\n \"instrument_id\": \"\",\n \"limit_offset\": \"\",\n \"limit_price\": \"\",\n \"position_intent\": \"\",\n \"stop_price\": \"\",\n \"strategy\": \"\",\n \"symbol\": \"\",\n \"trailing_offset\": \"\",\n \"trailing_offset_type\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"sunt_f\": false,\n \"magnae59\": 67421727\n },\n {\n \"minim48\": false,\n \"fugiat94d\": -43856089.03091218\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "280e2143-d8d5-483d-b6bb-a82c163d7052", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1", "accounts", ":account_id", "orders" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "[\n {\n \"side\": \"SELL\",\n \"quantity\": \"\",\n \"order_type\": \"STOP\",\n \"time_in_force\": \"GOOD_TILL_DATE\",\n \"expires_at\": \"\",\n \"extended_hours\": \"\",\n \"id\": \"\",\n \"instrument_id\": \"\",\n \"limit_offset\": \"\",\n \"limit_price\": \"\",\n \"position_intent\": \"\",\n \"stop_price\": \"\",\n \"strategy\": \"\",\n \"symbol\": \"\",\n \"trailing_offset\": \"\",\n \"trailing_offset_type\": \"\"\n },\n {\n \"side\": \"BUY\",\n \"quantity\": \"\",\n \"order_type\": \"MARKET\",\n \"time_in_force\": \"GOOD_TILL_DATE\",\n \"expires_at\": \"\",\n \"extended_hours\": \"\",\n \"id\": \"\",\n \"instrument_id\": \"\",\n \"limit_offset\": \"\",\n \"limit_price\": \"\",\n \"position_intent\": \"\",\n \"stop_price\": \"\",\n \"strategy\": \"\",\n \"symbol\": \"\",\n \"trailing_offset\": \"\",\n \"trailing_offset_type\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"sunt_f\": false,\n \"magnae59\": 67421727\n },\n {\n \"minim48\": false,\n \"fugiat94d\": -43856089.03091218\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fe624d79-f379-4135-b820-b95081e45995", "name": "Malformed order request payload", "originalRequest": { "url": { "path": [ "v1", "accounts", ":account_id", "orders" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "[\n {\n \"side\": \"SELL\",\n \"quantity\": \"\",\n \"order_type\": \"STOP\",\n \"time_in_force\": \"GOOD_TILL_DATE\",\n \"expires_at\": \"\",\n \"extended_hours\": \"\",\n \"id\": \"\",\n \"instrument_id\": \"\",\n \"limit_offset\": \"\",\n \"limit_price\": \"\",\n \"position_intent\": \"\",\n \"stop_price\": \"\",\n \"strategy\": \"\",\n \"symbol\": \"\",\n \"trailing_offset\": \"\",\n \"trailing_offset_type\": \"\"\n },\n {\n \"side\": \"BUY\",\n \"quantity\": \"\",\n \"order_type\": \"MARKET\",\n \"time_in_force\": \"GOOD_TILL_DATE\",\n \"expires_at\": \"\",\n \"extended_hours\": \"\",\n \"id\": \"\",\n \"instrument_id\": \"\",\n \"limit_offset\": \"\",\n \"limit_price\": \"\",\n \"position_intent\": \"\",\n \"stop_price\": \"\",\n \"strategy\": \"\",\n \"symbol\": \"\",\n \"trailing_offset\": \"\",\n \"trailing_offset_type\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"sunt_f\": false,\n \"magnae59\": 67421727\n },\n {\n \"minim48\": false,\n \"fugiat94d\": -43856089.03091218\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8f9b25a1-81bf-4771-8388-b6d260eb89de", "name": "Internal server error", "originalRequest": { "url": { "path": [ "v1", "accounts", ":account_id", "orders" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "[\n {\n \"side\": \"SELL\",\n \"quantity\": \"\",\n \"order_type\": \"STOP\",\n \"time_in_force\": \"GOOD_TILL_DATE\",\n \"expires_at\": \"\",\n \"extended_hours\": \"\",\n \"id\": \"\",\n \"instrument_id\": \"\",\n \"limit_offset\": \"\",\n \"limit_price\": \"\",\n \"position_intent\": \"\",\n \"stop_price\": \"\",\n \"strategy\": \"\",\n \"symbol\": \"\",\n \"trailing_offset\": \"\",\n \"trailing_offset_type\": \"\"\n },\n {\n \"side\": \"BUY\",\n \"quantity\": \"\",\n \"order_type\": \"MARKET\",\n \"time_in_force\": \"GOOD_TILL_DATE\",\n \"expires_at\": \"\",\n \"extended_hours\": \"\",\n \"id\": \"\",\n \"instrument_id\": \"\",\n \"limit_offset\": \"\",\n \"limit_price\": \"\",\n \"position_intent\": \"\",\n \"stop_price\": \"\",\n \"strategy\": \"\",\n \"symbol\": \"\",\n \"trailing_offset\": \"\",\n \"trailing_offset_type\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"sunt_f\": false,\n \"magnae59\": 67421727\n },\n {\n \"minim48\": false,\n \"fugiat94d\": -43856089.03091218\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "00863757-593e-4d51-8a05-20e1d14b5a94", "name": "Cancel All Open Orders", "request": { "name": "Cancel All Open Orders", "description": { "content": "Cancel all orders for an account", "type": "text/plain" }, "url": { "path": [ "v1", "accounts", ":account_id", "orders" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter by order side (BUY or SELL)", "type": "text/plain" }, "key": "side", "value": "SELL" }, { "disabled": false, "description": { "content": "Filter by order type (e.g., MARKET, LIMIT)", "type": "text/plain" }, "key": "type", "value": "TRAILING_STOP_LIMIT" }, { "disabled": false, "description": { "content": "Filter by instrument type (e.g., COMMON_STOCK, OPTION)", "type": "text/plain" }, "key": "instrument_type", "value": "COMMON_STOCK" }, { "disabled": false, "description": { "content": "Comma-separated instrument IDs (UUID) or symbols (equity tickers or OSI option symbols).", "type": "text/plain" }, "key": "instrument_ids", "value": "," } ], "variable": [ { "type": "any", "value": "", "key": "account_id", "disabled": false, "description": { "content": "(Required) Account identifier", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "4ce869df-e823-4f83-acae-a6fdd8d02258", "name": "Orders cancelled", "originalRequest": { "url": { "path": [ "v1", "accounts", ":account_id", "orders" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter by order side (BUY or SELL)", "type": "text/plain" }, "key": "side", "value": "SELL" }, { "disabled": false, "description": { "content": "Filter by order type (e.g., MARKET, LIMIT)", "type": "text/plain" }, "key": "type", "value": "TRAILING_STOP_LIMIT" }, { "disabled": false, "description": { "content": "Filter by instrument type (e.g., COMMON_STOCK, OPTION)", "type": "text/plain" }, "key": "instrument_type", "value": "COMMON_STOCK" }, { "disabled": false, "description": { "content": "Comma-separated instrument IDs (UUID) or symbols (equity tickers or OSI option symbols).", "type": "text/plain" }, "key": "instrument_ids", "value": "," } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"client_order_id\": \"\",\n \"account_id\": \"\",\n \"venue\": \"\",\n \"side\": \"SELL\",\n \"quantity\": \"\",\n \"order_type\": \"MARKET\",\n \"time_in_force\": \"AT_CLOSE\",\n \"status\": \"PENDING_CANCEL\",\n \"filled_quantity\": \"\",\n \"leaves_quantity\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"average_fill_price\": \"\",\n \"details\": [\n \"\",\n \"\"\n ],\n \"expires_at\": \"\",\n \"extended_hours\": \"\",\n \"instrument_id\": \"\",\n \"instrument_type\": \"\",\n \"limit_offset\": \"\",\n \"limit_price\": \"\",\n \"queue_state\": \"\",\n \"releases_at\": \"\",\n \"stop_price\": \"\",\n \"strategy\": {\n \"type\": \"\",\n \"end_at\": \"\",\n \"start_at\": \"\"\n },\n \"symbol\": \"\",\n \"trailing_limit_px\": \"\",\n \"trailing_offset\": \"\",\n \"trailing_offset_type\": \"\",\n \"trailing_stop_px\": \"\",\n \"trailing_watermark_px\": \"\",\n \"trailing_watermark_ts\": \"\",\n \"underlying_instrument_id\": \"\",\n \"underlying_instrument_type\": \"\"\n },\n {\n \"id\": \"\",\n \"client_order_id\": \"\",\n \"account_id\": \"\",\n \"venue\": \"\",\n \"side\": \"SELL\",\n \"quantity\": \"\",\n \"order_type\": \"LIMIT\",\n \"time_in_force\": \"AT_OPEN\",\n \"status\": \"REJECTED\",\n \"filled_quantity\": \"\",\n \"leaves_quantity\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"average_fill_price\": \"\",\n \"details\": [\n \"\",\n \"\"\n ],\n \"expires_at\": \"\",\n \"extended_hours\": \"\",\n \"instrument_id\": \"\",\n \"instrument_type\": \"\",\n \"limit_offset\": \"\",\n \"limit_price\": \"\",\n \"queue_state\": \"\",\n \"releases_at\": \"\",\n \"stop_price\": \"\",\n \"strategy\": {\n \"type\": \"\",\n \"end_at\": \"\",\n \"start_at\": \"\"\n },\n \"symbol\": \"\",\n \"trailing_limit_px\": \"\",\n \"trailing_offset\": \"\",\n \"trailing_offset_type\": \"\",\n \"trailing_stop_px\": \"\",\n \"trailing_watermark_px\": \"\",\n \"trailing_watermark_ts\": \"\",\n \"underlying_instrument_id\": \"\",\n \"underlying_instrument_type\": \"\"\n }\n ],\n \"metadata\": {\n \"request_id\": \"\",\n \"next_page_token\": \"\",\n \"page_number\": \"\",\n \"previous_page_token\": \"\",\n \"total_items\": \"\",\n \"total_pages\": \"\"\n },\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "90dd2813-ff1a-4174-94b9-59d19d1ac0ed", "name": "Invalid filter parameters", "originalRequest": { "url": { "path": [ "v1", "accounts", ":account_id", "orders" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter by order side (BUY or SELL)", "type": "text/plain" }, "key": "side", "value": "SELL" }, { "disabled": false, "description": { "content": "Filter by order type (e.g., MARKET, LIMIT)", "type": "text/plain" }, "key": "type", "value": "TRAILING_STOP_LIMIT" }, { "disabled": false, "description": { "content": "Filter by instrument type (e.g., COMMON_STOCK, OPTION)", "type": "text/plain" }, "key": "instrument_type", "value": "COMMON_STOCK" }, { "disabled": false, "description": { "content": "Comma-separated instrument IDs (UUID) or symbols (equity tickers or OSI option symbols).", "type": "text/plain" }, "key": "instrument_ids", "value": "," } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"sunt_f\": false,\n \"magnae59\": 67421727\n },\n {\n \"minim48\": false,\n \"fugiat94d\": -43856089.03091218\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f04d472b-35a1-4d21-8ecb-b930d86de6d5", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1", "accounts", ":account_id", "orders" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter by order side (BUY or SELL)", "type": "text/plain" }, "key": "side", "value": "SELL" }, { "disabled": false, "description": { "content": "Filter by order type (e.g., MARKET, LIMIT)", "type": "text/plain" }, "key": "type", "value": "TRAILING_STOP_LIMIT" }, { "disabled": false, "description": { "content": "Filter by instrument type (e.g., COMMON_STOCK, OPTION)", "type": "text/plain" }, "key": "instrument_type", "value": "COMMON_STOCK" }, { "disabled": false, "description": { "content": "Comma-separated instrument IDs (UUID) or symbols (equity tickers or OSI option symbols).", "type": "text/plain" }, "key": "instrument_ids", "value": "," } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"sunt_f\": false,\n \"magnae59\": 67421727\n },\n {\n \"minim48\": false,\n \"fugiat94d\": -43856089.03091218\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b9dd9256-7726-49c8-ab96-6675b26698bc", "name": "No orders match the specified filters", "originalRequest": { "url": { "path": [ "v1", "accounts", ":account_id", "orders" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter by order side (BUY or SELL)", "type": "text/plain" }, "key": "side", "value": "SELL" }, { "disabled": false, "description": { "content": "Filter by order type (e.g., MARKET, LIMIT)", "type": "text/plain" }, "key": "type", "value": "TRAILING_STOP_LIMIT" }, { "disabled": false, "description": { "content": "Filter by instrument type (e.g., COMMON_STOCK, OPTION)", "type": "text/plain" }, "key": "instrument_type", "value": "COMMON_STOCK" }, { "disabled": false, "description": { "content": "Comma-separated instrument IDs (UUID) or symbols (equity tickers or OSI option symbols).", "type": "text/plain" }, "key": "instrument_ids", "value": "," } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"sunt_f\": false,\n \"magnae59\": 67421727\n },\n {\n \"minim48\": false,\n \"fugiat94d\": -43856089.03091218\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "98711d1b-740f-425c-80c9-3a390001c0c0", "name": "Internal server error", "originalRequest": { "url": { "path": [ "v1", "accounts", ":account_id", "orders" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter by order side (BUY or SELL)", "type": "text/plain" }, "key": "side", "value": "SELL" }, { "disabled": false, "description": { "content": "Filter by order type (e.g., MARKET, LIMIT)", "type": "text/plain" }, "key": "type", "value": "TRAILING_STOP_LIMIT" }, { "disabled": false, "description": { "content": "Filter by instrument type (e.g., COMMON_STOCK, OPTION)", "type": "text/plain" }, "key": "instrument_type", "value": "COMMON_STOCK" }, { "disabled": false, "description": { "content": "Comma-separated instrument IDs (UUID) or symbols (equity tickers or OSI option symbols).", "type": "text/plain" }, "key": "instrument_ids", "value": "," } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"sunt_f\": false,\n \"magnae59\": 67421727\n },\n {\n \"minim48\": false,\n \"fugiat94d\": -43856089.03091218\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f65a5186-88e3-4359-8691-23303a2412ff", "name": "Get Order By ID", "request": { "name": "Get Order By ID", "description": { "content": "Fetch a single order. The `{order_id}` path parameter accepts either the\norder's `id` or its `client_order_id`. A `client_order_id` can only be used\nwhile the order is open; after that, use the `id` returned in every order\nresponse, or find the order with the list-orders endpoint's `order_ids`\nfilter, which accepts both identifiers at any time.", "type": "text/plain" }, "url": { "path": [ "v1", "accounts", ":account_id", "orders", ":order_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "account_id", "disabled": false, "description": { "content": "(Required) Account identifier", "type": "text/plain" } }, { "type": "any", "value": "", "key": "order_id", "disabled": false, "description": { "content": "(Required) The order's `id`, or its `client_order_id` while the order is open", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "395a310f-f9dc-4ad9-8296-96b6a0471614", "name": "Order details", "originalRequest": { "url": { "path": [ "v1", "accounts", ":account_id", "orders", ":order_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"\",\n \"client_order_id\": \"\",\n \"account_id\": \"\",\n \"venue\": \"\",\n \"side\": \"BUY\",\n \"quantity\": \"\",\n \"order_type\": \"STOP\",\n \"time_in_force\": \"FILL_OR_KILL\",\n \"status\": \"REPLACED\",\n \"filled_quantity\": \"\",\n \"leaves_quantity\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"average_fill_price\": \"\",\n \"details\": [\n \"\",\n \"\"\n ],\n \"expires_at\": \"\",\n \"extended_hours\": \"\",\n \"instrument_id\": \"\",\n \"instrument_type\": \"\",\n \"limit_offset\": \"\",\n \"limit_price\": \"\",\n \"queue_state\": \"\",\n \"releases_at\": \"\",\n \"stop_price\": \"\",\n \"strategy\": {\n \"type\": \"\",\n \"end_at\": \"\",\n \"start_at\": \"\"\n },\n \"symbol\": \"\",\n \"trailing_limit_px\": \"\",\n \"trailing_offset\": \"\",\n \"trailing_offset_type\": \"\",\n \"trailing_stop_px\": \"\",\n \"trailing_watermark_px\": \"\",\n \"trailing_watermark_ts\": \"\",\n \"underlying_instrument_id\": \"\",\n \"underlying_instrument_type\": \"\"\n },\n \"metadata\": {\n \"request_id\": \"\",\n \"next_page_token\": \"\",\n \"page_number\": \"\",\n \"previous_page_token\": \"\",\n \"total_items\": \"\",\n \"total_pages\": \"\"\n },\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cf0971fc-1d51-49a9-bf2c-2c7950de5ca0", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1", "accounts", ":account_id", "orders", ":order_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"sunt_f\": false,\n \"magnae59\": 67421727\n },\n {\n \"minim48\": false,\n \"fugiat94d\": -43856089.03091218\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e46d4d0c-d4d6-41e2-8e8a-70cc73fdb1c2", "name": "Order not found", "originalRequest": { "url": { "path": [ "v1", "accounts", ":account_id", "orders", ":order_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"sunt_f\": false,\n \"magnae59\": 67421727\n },\n {\n \"minim48\": false,\n \"fugiat94d\": -43856089.03091218\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3d2ff68f-6db3-4c1c-93f2-6f4e975d19e5", "name": "Internal server error", "originalRequest": { "url": { "path": [ "v1", "accounts", ":account_id", "orders", ":order_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"sunt_f\": false,\n \"magnae59\": 67421727\n },\n {\n \"minim48\": false,\n \"fugiat94d\": -43856089.03091218\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "bd2d3154-b74f-4d36-9fa4-823816dd21c8", "name": "Cancel Open Order", "request": { "name": "Cancel Open Order", "description": { "content": "Cancel a specific order", "type": "text/plain" }, "url": { "path": [ "v1", "accounts", ":account_id", "orders", ":order_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "account_id", "disabled": false, "description": { "content": "(Required) Account identifier", "type": "text/plain" } }, { "type": "any", "value": "", "key": "order_id", "disabled": false, "description": { "content": "(Required) The `id` or `client_order_id` of the open order to cancel", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "f0b283da-992b-49bf-b53b-008f1241b3a8", "name": "Order cancelled successfully", "originalRequest": { "url": { "path": [ "v1", "accounts", ":account_id", "orders", ":order_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"\",\n \"client_order_id\": \"\",\n \"account_id\": \"\",\n \"venue\": \"\",\n \"side\": \"BUY\",\n \"quantity\": \"\",\n \"order_type\": \"STOP\",\n \"time_in_force\": \"FILL_OR_KILL\",\n \"status\": \"REPLACED\",\n \"filled_quantity\": \"\",\n \"leaves_quantity\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"average_fill_price\": \"\",\n \"details\": [\n \"\",\n \"\"\n ],\n \"expires_at\": \"\",\n \"extended_hours\": \"\",\n \"instrument_id\": \"\",\n \"instrument_type\": \"\",\n \"limit_offset\": \"\",\n \"limit_price\": \"\",\n \"queue_state\": \"\",\n \"releases_at\": \"\",\n \"stop_price\": \"\",\n \"strategy\": {\n \"type\": \"\",\n \"end_at\": \"\",\n \"start_at\": \"\"\n },\n \"symbol\": \"\",\n \"trailing_limit_px\": \"\",\n \"trailing_offset\": \"\",\n \"trailing_offset_type\": \"\",\n \"trailing_stop_px\": \"\",\n \"trailing_watermark_px\": \"\",\n \"trailing_watermark_ts\": \"\",\n \"underlying_instrument_id\": \"\",\n \"underlying_instrument_type\": \"\"\n },\n \"metadata\": {\n \"request_id\": \"\",\n \"next_page_token\": \"\",\n \"page_number\": \"\",\n \"previous_page_token\": \"\",\n \"total_items\": \"\",\n \"total_pages\": \"\"\n },\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "35e7d841-7131-4e7d-963f-4c7a39e1c37f", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1", "accounts", ":account_id", "orders", ":order_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"sunt_f\": false,\n \"magnae59\": 67421727\n },\n {\n \"minim48\": false,\n \"fugiat94d\": -43856089.03091218\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7e66d277-2880-4c72-9f9c-7408755f3f15", "name": "Order not found", "originalRequest": { "url": { "path": [ "v1", "accounts", ":account_id", "orders", ":order_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"sunt_f\": false,\n \"magnae59\": 67421727\n },\n {\n \"minim48\": false,\n \"fugiat94d\": -43856089.03091218\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5c15e2ff-4c95-4042-9410-149c4d9b1371", "name": "Internal server error", "originalRequest": { "url": { "path": [ "v1", "accounts", ":account_id", "orders", ":order_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"sunt_f\": false,\n \"magnae59\": 67421727\n },\n {\n \"minim48\": false,\n \"fugiat94d\": -43856089.03091218\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "039ec576-8ab8-4dc7-ab75-ab01c887af88", "name": "Replace Order", "request": { "name": "Replace Order", "description": { "content": "Replace an order with new parameters", "type": "text/plain" }, "url": { "path": [ "v1", "accounts", ":account_id", "orders", ":order_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "account_id", "disabled": false, "description": { "content": "(Required) Account identifier", "type": "text/plain" } }, { "type": "any", "value": "", "key": "order_id", "disabled": false, "description": { "content": "(Required) The `id` or `client_order_id` of the open order to replace", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"limit_offset\": \"\",\n \"limit_price\": \"\",\n \"quantity\": \"\",\n \"stop_price\": \"\",\n \"trailing_offset\": \"\",\n \"trailing_offset_type\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "fe928b91-41aa-4d6a-b15f-ce6a6128c6a6", "name": "Order replaced successfully", "originalRequest": { "url": { "path": [ "v1", "accounts", ":account_id", "orders", ":order_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"limit_offset\": \"\",\n \"limit_price\": \"\",\n \"quantity\": \"\",\n \"stop_price\": \"\",\n \"trailing_offset\": \"\",\n \"trailing_offset_type\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"\",\n \"client_order_id\": \"\",\n \"account_id\": \"\",\n \"venue\": \"\",\n \"side\": \"BUY\",\n \"quantity\": \"\",\n \"order_type\": \"STOP\",\n \"time_in_force\": \"FILL_OR_KILL\",\n \"status\": \"REPLACED\",\n \"filled_quantity\": \"\",\n \"leaves_quantity\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"average_fill_price\": \"\",\n \"details\": [\n \"\",\n \"\"\n ],\n \"expires_at\": \"\",\n \"extended_hours\": \"\",\n \"instrument_id\": \"\",\n \"instrument_type\": \"\",\n \"limit_offset\": \"\",\n \"limit_price\": \"\",\n \"queue_state\": \"\",\n \"releases_at\": \"\",\n \"stop_price\": \"\",\n \"strategy\": {\n \"type\": \"\",\n \"end_at\": \"\",\n \"start_at\": \"\"\n },\n \"symbol\": \"\",\n \"trailing_limit_px\": \"\",\n \"trailing_offset\": \"\",\n \"trailing_offset_type\": \"\",\n \"trailing_stop_px\": \"\",\n \"trailing_watermark_px\": \"\",\n \"trailing_watermark_ts\": \"\",\n \"underlying_instrument_id\": \"\",\n \"underlying_instrument_type\": \"\"\n },\n \"metadata\": {\n \"request_id\": \"\",\n \"next_page_token\": \"\",\n \"page_number\": \"\",\n \"previous_page_token\": \"\",\n \"total_items\": \"\",\n \"total_pages\": \"\"\n },\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "217d3572-167a-4b1b-8c61-3b4361bc73d6", "name": "Invalid replacement request", "originalRequest": { "url": { "path": [ "v1", "accounts", ":account_id", "orders", ":order_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"limit_offset\": \"\",\n \"limit_price\": \"\",\n \"quantity\": \"\",\n \"stop_price\": \"\",\n \"trailing_offset\": \"\",\n \"trailing_offset_type\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"sunt_f\": false,\n \"magnae59\": 67421727\n },\n {\n \"minim48\": false,\n \"fugiat94d\": -43856089.03091218\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e2b92b90-1222-4690-b34b-11106da08a6c", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1", "accounts", ":account_id", "orders", ":order_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"limit_offset\": \"\",\n \"limit_price\": \"\",\n \"quantity\": \"\",\n \"stop_price\": \"\",\n \"trailing_offset\": \"\",\n \"trailing_offset_type\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"sunt_f\": false,\n \"magnae59\": 67421727\n },\n {\n \"minim48\": false,\n \"fugiat94d\": -43856089.03091218\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f43d239c-ded9-4467-b105-c1f13574465c", "name": "Order not found", "originalRequest": { "url": { "path": [ "v1", "accounts", ":account_id", "orders", ":order_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"limit_offset\": \"\",\n \"limit_price\": \"\",\n \"quantity\": \"\",\n \"stop_price\": \"\",\n \"trailing_offset\": \"\",\n \"trailing_offset_type\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"sunt_f\": false,\n \"magnae59\": 67421727\n },\n {\n \"minim48\": false,\n \"fugiat94d\": -43856089.03091218\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b61b3211-b81b-481e-90d0-140a6c85201e", "name": "Internal server error", "originalRequest": { "url": { "path": [ "v1", "accounts", ":account_id", "orders", ":order_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"limit_offset\": \"\",\n \"limit_price\": \"\",\n \"quantity\": \"\",\n \"stop_price\": \"\",\n \"trailing_offset\": \"\",\n \"trailing_offset_type\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"sunt_f\": false,\n \"magnae59\": 67421727\n },\n {\n \"minim48\": false,\n \"fugiat94d\": -43856089.03091218\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Positions", "description": "View positions and manage position instructions.", "item": [ { "id": "1a106a3a-1650-4e32-8d57-3cfb684f1803", "name": "Get Positions", "request": { "name": "Get Positions", "description": { "content": "Retrieves all positions for the specified trading account.", "type": "text/plain" }, "url": { "path": [ "v1", "accounts", ":account_id", "positions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The number of items to return per page. Only used when page_token is not provided.", "type": "text/plain" }, "key": "page_size", "value": "1000" }, { "disabled": false, "description": { "content": "Token for retrieving the next or previous page of results. Contains encoded pagination state; when provided, page_size is ignored.", "type": "text/plain" }, "key": "page_token", "value": "" }, { "disabled": false, "description": { "content": "Comma-separated instrument identifiers", "type": "text/plain" }, "key": "instrument_ids", "value": "," }, { "disabled": false, "description": { "content": "Field to sort by", "type": "text/plain" }, "key": "sort_by", "value": "INSTRUMENT_TYPE" }, { "disabled": false, "description": { "content": "Sort direction", "type": "text/plain" }, "key": "sort_direction", "value": "DESC" } ], "variable": [ { "type": "any", "value": "", "key": "account_id", "disabled": false, "description": { "content": "(Required) Account identifier", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "fd2c98fe-98cd-498b-b5a6-0dacd7f0f209", "name": "List of positions", "originalRequest": { "url": { "path": [ "v1", "accounts", ":account_id", "positions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The number of items to return per page. Only used when page_token is not provided.", "type": "text/plain" }, "key": "page_size", "value": "1000" }, { "disabled": false, "description": { "content": "Token for retrieving the next or previous page of results. Contains encoded pagination state; when provided, page_size is ignored.", "type": "text/plain" }, "key": "page_token", "value": "" }, { "disabled": false, "description": { "content": "Comma-separated instrument identifiers", "type": "text/plain" }, "key": "instrument_ids", "value": "," }, { "disabled": false, "description": { "content": "Field to sort by", "type": "text/plain" }, "key": "sort_by", "value": "INSTRUMENT_TYPE" }, { "disabled": false, "description": { "content": "Sort direction", "type": "text/plain" }, "key": "sort_direction", "value": "DESC" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"account_id\": \"\",\n \"instrument_id\": \"\",\n \"symbol\": \"\",\n \"instrument_type\": \"OPTION\",\n \"quantity\": \"\",\n \"market_value\": \"\",\n \"position_type\": \"LONG\",\n \"available_quantity\": \"\",\n \"avg_price\": \"\",\n \"closing_price\": \"\",\n \"closing_price_date\": \"\",\n \"cost_basis\": \"\",\n \"daily_realized_pnl\": \"\",\n \"daily_unrealized_pnl\": \"\",\n \"daily_unrealized_pnl_pct\": \"\",\n \"instrument_price\": \"\",\n \"underlying_instrument_id\": \"\",\n \"underlying_instrument_type\": \"\",\n \"unrealized_pnl\": \"\",\n \"unrealized_pnl_pct\": \"\"\n },\n {\n \"account_id\": \"\",\n \"instrument_id\": \"\",\n \"symbol\": \"\",\n \"instrument_type\": \"INDEX\",\n \"quantity\": \"\",\n \"market_value\": \"\",\n \"position_type\": \"LONG\",\n \"available_quantity\": \"\",\n \"avg_price\": \"\",\n \"closing_price\": \"\",\n \"closing_price_date\": \"\",\n \"cost_basis\": \"\",\n \"daily_realized_pnl\": \"\",\n \"daily_unrealized_pnl\": \"\",\n \"daily_unrealized_pnl_pct\": \"\",\n \"instrument_price\": \"\",\n \"underlying_instrument_id\": \"\",\n \"underlying_instrument_type\": \"\",\n \"unrealized_pnl\": \"\",\n \"unrealized_pnl_pct\": \"\"\n }\n ],\n \"metadata\": {\n \"request_id\": \"\",\n \"next_page_token\": \"\",\n \"page_number\": \"\",\n \"previous_page_token\": \"\",\n \"total_items\": \"\",\n \"total_pages\": \"\"\n },\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b349c201-7f01-4bf1-9c13-7e08e9c561c7", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1", "accounts", ":account_id", "positions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The number of items to return per page. Only used when page_token is not provided.", "type": "text/plain" }, "key": "page_size", "value": "1000" }, { "disabled": false, "description": { "content": "Token for retrieving the next or previous page of results. Contains encoded pagination state; when provided, page_size is ignored.", "type": "text/plain" }, "key": "page_token", "value": "" }, { "disabled": false, "description": { "content": "Comma-separated instrument identifiers", "type": "text/plain" }, "key": "instrument_ids", "value": "," }, { "disabled": false, "description": { "content": "Field to sort by", "type": "text/plain" }, "key": "sort_by", "value": "INSTRUMENT_TYPE" }, { "disabled": false, "description": { "content": "Sort direction", "type": "text/plain" }, "key": "sort_direction", "value": "DESC" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"sunt_f\": false,\n \"magnae59\": 67421727\n },\n {\n \"minim48\": false,\n \"fugiat94d\": -43856089.03091218\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "55ee4db1-02e1-4da7-bd35-6908f0984d34", "name": "Internal server error", "originalRequest": { "url": { "path": [ "v1", "accounts", ":account_id", "positions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The number of items to return per page. Only used when page_token is not provided.", "type": "text/plain" }, "key": "page_size", "value": "1000" }, { "disabled": false, "description": { "content": "Token for retrieving the next or previous page of results. Contains encoded pagination state; when provided, page_size is ignored.", "type": "text/plain" }, "key": "page_token", "value": "" }, { "disabled": false, "description": { "content": "Comma-separated instrument identifiers", "type": "text/plain" }, "key": "instrument_ids", "value": "," }, { "disabled": false, "description": { "content": "Field to sort by", "type": "text/plain" }, "key": "sort_by", "value": "INSTRUMENT_TYPE" }, { "disabled": false, "description": { "content": "Sort direction", "type": "text/plain" }, "key": "sort_direction", "value": "DESC" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"sunt_f\": false,\n \"magnae59\": 67421727\n },\n {\n \"minim48\": false,\n \"fugiat94d\": -43856089.03091218\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4612b1db-5e91-4b09-ae16-2b0747d6d863", "name": "Close Positions", "request": { "name": "Close Positions", "description": { "content": "Delete all positions within an account.\n\nCloses all positions for the specified trading account.", "type": "text/plain" }, "url": { "path": [ "v1", "accounts", ":account_id", "positions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "account_id", "disabled": false, "description": { "content": "(Required) Account identifier", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "c9bb1825-363c-40cb-ba47-478b679d8029", "name": "List of orders generated to close all positions.", "originalRequest": { "url": { "path": [ "v1", "accounts", ":account_id", "positions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"client_order_id\": \"\",\n \"account_id\": \"\",\n \"venue\": \"\",\n \"side\": \"SELL\",\n \"quantity\": \"\",\n \"order_type\": \"MARKET\",\n \"time_in_force\": \"AT_CLOSE\",\n \"status\": \"PENDING_CANCEL\",\n \"filled_quantity\": \"\",\n \"leaves_quantity\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"average_fill_price\": \"\",\n \"details\": [\n \"\",\n \"\"\n ],\n \"expires_at\": \"\",\n \"extended_hours\": \"\",\n \"instrument_id\": \"\",\n \"instrument_type\": \"\",\n \"limit_offset\": \"\",\n \"limit_price\": \"\",\n \"queue_state\": \"\",\n \"releases_at\": \"\",\n \"stop_price\": \"\",\n \"strategy\": {\n \"type\": \"\",\n \"end_at\": \"\",\n \"start_at\": \"\"\n },\n \"symbol\": \"\",\n \"trailing_limit_px\": \"\",\n \"trailing_offset\": \"\",\n \"trailing_offset_type\": \"\",\n \"trailing_stop_px\": \"\",\n \"trailing_watermark_px\": \"\",\n \"trailing_watermark_ts\": \"\",\n \"underlying_instrument_id\": \"\",\n \"underlying_instrument_type\": \"\"\n },\n {\n \"id\": \"\",\n \"client_order_id\": \"\",\n \"account_id\": \"\",\n \"venue\": \"\",\n \"side\": \"SELL\",\n \"quantity\": \"\",\n \"order_type\": \"LIMIT\",\n \"time_in_force\": \"AT_OPEN\",\n \"status\": \"REJECTED\",\n \"filled_quantity\": \"\",\n \"leaves_quantity\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"average_fill_price\": \"\",\n \"details\": [\n \"\",\n \"\"\n ],\n \"expires_at\": \"\",\n \"extended_hours\": \"\",\n \"instrument_id\": \"\",\n \"instrument_type\": \"\",\n \"limit_offset\": \"\",\n \"limit_price\": \"\",\n \"queue_state\": \"\",\n \"releases_at\": \"\",\n \"stop_price\": \"\",\n \"strategy\": {\n \"type\": \"\",\n \"end_at\": \"\",\n \"start_at\": \"\"\n },\n \"symbol\": \"\",\n \"trailing_limit_px\": \"\",\n \"trailing_offset\": \"\",\n \"trailing_offset_type\": \"\",\n \"trailing_stop_px\": \"\",\n \"trailing_watermark_px\": \"\",\n \"trailing_watermark_ts\": \"\",\n \"underlying_instrument_id\": \"\",\n \"underlying_instrument_type\": \"\"\n }\n ],\n \"metadata\": {\n \"request_id\": \"\",\n \"next_page_token\": \"\",\n \"page_number\": \"\",\n \"previous_page_token\": \"\",\n \"total_items\": \"\",\n \"total_pages\": \"\"\n },\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "828f65c1-e5cc-4e29-a770-ffe39f2402e4", "name": "Invalid request", "originalRequest": { "url": { "path": [ "v1", "accounts", ":account_id", "positions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"sunt_f\": false,\n \"magnae59\": 67421727\n },\n {\n \"minim48\": false,\n \"fugiat94d\": -43856089.03091218\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a19e65d7-c986-4384-a670-c05b1d3dc54c", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1", "accounts", ":account_id", "positions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"sunt_f\": false,\n \"magnae59\": 67421727\n },\n {\n \"minim48\": false,\n \"fugiat94d\": -43856089.03091218\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2d64c3dc-15eb-46f5-93d4-0123a4fc8f69", "name": "Internal server error", "originalRequest": { "url": { "path": [ "v1", "accounts", ":account_id", "positions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"sunt_f\": false,\n \"magnae59\": 67421727\n },\n {\n \"minim48\": false,\n \"fugiat94d\": -43856089.03091218\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c6bb2d07-5ba9-4816-a44b-93c09a9f2162", "name": "Get Position Instructions", "request": { "name": "Get Position Instructions", "description": { "content": "Returns the current lifecycle state of the account's position\ninstructions. Optionally filter by a specific contract.\n\nNote: instructions that fail pre-acceptance validation on `POST` —\nduplicates, `DO_NOT_EXERCISE` / `CONTRARY_EXERCISE` on a non-expiry day,\ninsufficient position, or an unresolvable instrument — are rejected\n(with `status = REJECTED` and a `rejection_reason`) without being\npersisted, so they surface only in the `POST` response and never appear\nin this list.", "type": "text/plain" }, "url": { "path": [ "v1", "accounts", ":account_id", "positions", "instructions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Limit results to a single contract. Instrument ID (UUID) or symbol (equity ticker or OSI option symbol).", "type": "text/plain" }, "key": "instrument_id", "value": "" }, { "disabled": false, "description": { "content": "Limit results to instructions whose contract has this underlier.\nInstrument ID (UUID) or symbol (equity ticker or OSI option symbol).\nCombined with `instrument_id` as a logical AND when both are supplied.", "type": "text/plain" }, "key": "underlying_instrument_id", "value": "" } ], "variable": [ { "type": "any", "value": "", "key": "account_id", "disabled": false, "description": { "content": "(Required) Account identifier", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "72be19a6-d03d-45c8-a53b-eb9ce7b21747", "name": "Position instructions", "originalRequest": { "url": { "path": [ "v1", "accounts", ":account_id", "positions", "instructions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Limit results to a single contract. Instrument ID (UUID) or symbol (equity ticker or OSI option symbol).", "type": "text/plain" }, "key": "instrument_id", "value": "" }, { "disabled": false, "description": { "content": "Limit results to instructions whose contract has this underlier.\nInstrument ID (UUID) or symbol (equity ticker or OSI option symbol).\nCombined with `instrument_id` as a logical AND when both are supplied.", "type": "text/plain" }, "key": "underlying_instrument_id", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"client_instruction_id\": \"\",\n \"account_id\": \"\",\n \"instruction_type\": \"CONTRARY_EXERCISE\",\n \"instrument_id\": \"\",\n \"symbol\": \"\",\n \"quantity\": \"\",\n \"status\": \"CANCELLED\",\n \"accepted_quantity\": \"\",\n \"created_at\": \"\",\n \"rejection\": \"\",\n \"rejection_reason\": \"\",\n \"underlying_instrument_id\": \"\",\n \"updated_at\": \"\"\n },\n {\n \"id\": \"\",\n \"client_instruction_id\": \"\",\n \"account_id\": \"\",\n \"instruction_type\": \"EXERCISE\",\n \"instrument_id\": \"\",\n \"symbol\": \"\",\n \"quantity\": \"\",\n \"status\": \"UNKNOWN\",\n \"accepted_quantity\": \"\",\n \"created_at\": \"\",\n \"rejection\": \"\",\n \"rejection_reason\": \"\",\n \"underlying_instrument_id\": \"\",\n \"updated_at\": \"\"\n }\n ],\n \"metadata\": {\n \"request_id\": \"\",\n \"next_page_token\": \"\",\n \"page_number\": \"\",\n \"previous_page_token\": \"\",\n \"total_items\": \"\",\n \"total_pages\": \"\"\n },\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "56a38ce6-3599-4efd-828d-0e9e9f99465b", "name": "Invalid query parameters", "originalRequest": { "url": { "path": [ "v1", "accounts", ":account_id", "positions", "instructions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Limit results to a single contract. Instrument ID (UUID) or symbol (equity ticker or OSI option symbol).", "type": "text/plain" }, "key": "instrument_id", "value": "" }, { "disabled": false, "description": { "content": "Limit results to instructions whose contract has this underlier.\nInstrument ID (UUID) or symbol (equity ticker or OSI option symbol).\nCombined with `instrument_id` as a logical AND when both are supplied.", "type": "text/plain" }, "key": "underlying_instrument_id", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"sunt_f\": false,\n \"magnae59\": 67421727\n },\n {\n \"minim48\": false,\n \"fugiat94d\": -43856089.03091218\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2566cdf5-d5d1-4f7c-8617-580217c83e99", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1", "accounts", ":account_id", "positions", "instructions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Limit results to a single contract. Instrument ID (UUID) or symbol (equity ticker or OSI option symbol).", "type": "text/plain" }, "key": "instrument_id", "value": "" }, { "disabled": false, "description": { "content": "Limit results to instructions whose contract has this underlier.\nInstrument ID (UUID) or symbol (equity ticker or OSI option symbol).\nCombined with `instrument_id` as a logical AND when both are supplied.", "type": "text/plain" }, "key": "underlying_instrument_id", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"sunt_f\": false,\n \"magnae59\": 67421727\n },\n {\n \"minim48\": false,\n \"fugiat94d\": -43856089.03091218\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e48d22b1-ebc5-4a72-abbc-a20c03b2b487", "name": "Account or instrument not found", "originalRequest": { "url": { "path": [ "v1", "accounts", ":account_id", "positions", "instructions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Limit results to a single contract. Instrument ID (UUID) or symbol (equity ticker or OSI option symbol).", "type": "text/plain" }, "key": "instrument_id", "value": "" }, { "disabled": false, "description": { "content": "Limit results to instructions whose contract has this underlier.\nInstrument ID (UUID) or symbol (equity ticker or OSI option symbol).\nCombined with `instrument_id` as a logical AND when both are supplied.", "type": "text/plain" }, "key": "underlying_instrument_id", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"sunt_f\": false,\n \"magnae59\": 67421727\n },\n {\n \"minim48\": false,\n \"fugiat94d\": -43856089.03091218\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fad3c191-7622-4590-be18-d47548a7f293", "name": "Service temporarily unavailable", "originalRequest": { "url": { "path": [ "v1", "accounts", ":account_id", "positions", "instructions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Limit results to a single contract. Instrument ID (UUID) or symbol (equity ticker or OSI option symbol).", "type": "text/plain" }, "key": "instrument_id", "value": "" }, { "disabled": false, "description": { "content": "Limit results to instructions whose contract has this underlier.\nInstrument ID (UUID) or symbol (equity ticker or OSI option symbol).\nCombined with `instrument_id` as a logical AND when both are supplied.", "type": "text/plain" }, "key": "underlying_instrument_id", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"sunt_f\": false,\n \"magnae59\": 67421727\n },\n {\n \"minim48\": false,\n \"fugiat94d\": -43856089.03091218\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "bc7ecf18-14ec-4db7-8f62-08d5c120cfd8", "name": "Submit Position Instructions", "request": { "name": "Submit Position Instructions", "description": { "content": "Submit one or more position instructions (Exercise, Do-Not-Exercise,\nContrary Exercise Advice) against the account.\n\nBatch semantics:\n- **All rows accepted** → `200 OK`. Every row is in `data` with\n `status = SENT`.\n- **Partial success** → `207 Multi-Status`. `data` contains every\n row; rejected rows carry `status = REJECTED` and\n `rejection_reason`. The top-level `error` summarizes the batch\n failure.\n- **All rows rejected** → `4xx`/`5xx`. The HTTP status reflects\n the aggregate cause: `409` when every row was a duplicate, `400`\n for validation failures like DNE/CEA on a non-expiry day, `503`\n if the clearing service is unavailable. `data` still contains\n every row carrying `status = REJECTED` and `rejection_reason`\n so callers can attribute failures by `client_instruction_id`; the\n top-level `error` summarizes the batch.", "type": "text/plain" }, "url": { "path": [ "v1", "accounts", ":account_id", "positions", "instructions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "account_id", "disabled": false, "description": { "content": "(Required) Account identifier", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "[\n {\n \"instruction_type\": \"EXERCISE\",\n \"instrument_id\": \"\",\n \"quantity\": \"\",\n \"client_instruction_id\": \"\"\n },\n {\n \"instruction_type\": \"CONTRARY_EXERCISE\",\n \"instrument_id\": \"\",\n \"quantity\": \"\",\n \"client_instruction_id\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "9ac7d65e-9ba3-457f-9d31-10350a1b548e", "name": "All instructions accepted", "originalRequest": { "url": { "path": [ "v1", "accounts", ":account_id", "positions", "instructions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "[\n {\n \"instruction_type\": \"EXERCISE\",\n \"instrument_id\": \"\",\n \"quantity\": \"\",\n \"client_instruction_id\": \"\"\n },\n {\n \"instruction_type\": \"CONTRARY_EXERCISE\",\n \"instrument_id\": \"\",\n \"quantity\": \"\",\n \"client_instruction_id\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"client_instruction_id\": \"\",\n \"account_id\": \"\",\n \"instruction_type\": \"CONTRARY_EXERCISE\",\n \"instrument_id\": \"\",\n \"symbol\": \"\",\n \"quantity\": \"\",\n \"status\": \"CANCELLED\",\n \"accepted_quantity\": \"\",\n \"created_at\": \"\",\n \"rejection\": \"\",\n \"rejection_reason\": \"\",\n \"underlying_instrument_id\": \"\",\n \"updated_at\": \"\"\n },\n {\n \"id\": \"\",\n \"client_instruction_id\": \"\",\n \"account_id\": \"\",\n \"instruction_type\": \"EXERCISE\",\n \"instrument_id\": \"\",\n \"symbol\": \"\",\n \"quantity\": \"\",\n \"status\": \"UNKNOWN\",\n \"accepted_quantity\": \"\",\n \"created_at\": \"\",\n \"rejection\": \"\",\n \"rejection_reason\": \"\",\n \"underlying_instrument_id\": \"\",\n \"updated_at\": \"\"\n }\n ],\n \"metadata\": {\n \"request_id\": \"\",\n \"next_page_token\": \"\",\n \"page_number\": \"\",\n \"previous_page_token\": \"\",\n \"total_items\": \"\",\n \"total_pages\": \"\"\n },\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "52f96f79-c2f9-4c90-8408-7a0a1a551d42", "name": "Partial success — some rows accepted, others rejected", "originalRequest": { "url": { "path": [ "v1", "accounts", ":account_id", "positions", "instructions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "[\n {\n \"instruction_type\": \"EXERCISE\",\n \"instrument_id\": \"\",\n \"quantity\": \"\",\n \"client_instruction_id\": \"\"\n },\n {\n \"instruction_type\": \"CONTRARY_EXERCISE\",\n \"instrument_id\": \"\",\n \"quantity\": \"\",\n \"client_instruction_id\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Multi-Status (WebDAV) (RFC 4918)", "code": 207, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"client_instruction_id\": \"\",\n \"account_id\": \"\",\n \"instruction_type\": \"CONTRARY_EXERCISE\",\n \"instrument_id\": \"\",\n \"symbol\": \"\",\n \"quantity\": \"\",\n \"status\": \"CANCELLED\",\n \"accepted_quantity\": \"\",\n \"created_at\": \"\",\n \"rejection\": \"\",\n \"rejection_reason\": \"\",\n \"underlying_instrument_id\": \"\",\n \"updated_at\": \"\"\n },\n {\n \"id\": \"\",\n \"client_instruction_id\": \"\",\n \"account_id\": \"\",\n \"instruction_type\": \"EXERCISE\",\n \"instrument_id\": \"\",\n \"symbol\": \"\",\n \"quantity\": \"\",\n \"status\": \"UNKNOWN\",\n \"accepted_quantity\": \"\",\n \"created_at\": \"\",\n \"rejection\": \"\",\n \"rejection_reason\": \"\",\n \"underlying_instrument_id\": \"\",\n \"updated_at\": \"\"\n }\n ],\n \"metadata\": {\n \"request_id\": \"\",\n \"next_page_token\": \"\",\n \"page_number\": \"\",\n \"previous_page_token\": \"\",\n \"total_items\": \"\",\n \"total_pages\": \"\"\n },\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1e626352-1b8f-41a0-99bd-cae2cd8805b6", "name": "Invalid request or all rows rejected by validation", "originalRequest": { "url": { "path": [ "v1", "accounts", ":account_id", "positions", "instructions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "[\n {\n \"instruction_type\": \"EXERCISE\",\n \"instrument_id\": \"\",\n \"quantity\": \"\",\n \"client_instruction_id\": \"\"\n },\n {\n \"instruction_type\": \"CONTRARY_EXERCISE\",\n \"instrument_id\": \"\",\n \"quantity\": \"\",\n \"client_instruction_id\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"client_instruction_id\": \"\",\n \"account_id\": \"\",\n \"instruction_type\": \"CONTRARY_EXERCISE\",\n \"instrument_id\": \"\",\n \"symbol\": \"\",\n \"quantity\": \"\",\n \"status\": \"CANCELLED\",\n \"accepted_quantity\": \"\",\n \"created_at\": \"\",\n \"rejection\": \"\",\n \"rejection_reason\": \"\",\n \"underlying_instrument_id\": \"\",\n \"updated_at\": \"\"\n },\n {\n \"id\": \"\",\n \"client_instruction_id\": \"\",\n \"account_id\": \"\",\n \"instruction_type\": \"EXERCISE\",\n \"instrument_id\": \"\",\n \"symbol\": \"\",\n \"quantity\": \"\",\n \"status\": \"UNKNOWN\",\n \"accepted_quantity\": \"\",\n \"created_at\": \"\",\n \"rejection\": \"\",\n \"rejection_reason\": \"\",\n \"underlying_instrument_id\": \"\",\n \"updated_at\": \"\"\n }\n ],\n \"metadata\": {\n \"request_id\": \"\",\n \"next_page_token\": \"\",\n \"page_number\": \"\",\n \"previous_page_token\": \"\",\n \"total_items\": \"\",\n \"total_pages\": \"\"\n },\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5aeb52b9-2f51-4319-b9c3-b76492382a19", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1", "accounts", ":account_id", "positions", "instructions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "[\n {\n \"instruction_type\": \"EXERCISE\",\n \"instrument_id\": \"\",\n \"quantity\": \"\",\n \"client_instruction_id\": \"\"\n },\n {\n \"instruction_type\": \"CONTRARY_EXERCISE\",\n \"instrument_id\": \"\",\n \"quantity\": \"\",\n \"client_instruction_id\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"sunt_f\": false,\n \"magnae59\": 67421727\n },\n {\n \"minim48\": false,\n \"fugiat94d\": -43856089.03091218\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5b5bc48b-3f26-4453-ab95-abe194e913c8", "name": "Account or instrument not found", "originalRequest": { "url": { "path": [ "v1", "accounts", ":account_id", "positions", "instructions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "[\n {\n \"instruction_type\": \"EXERCISE\",\n \"instrument_id\": \"\",\n \"quantity\": \"\",\n \"client_instruction_id\": \"\"\n },\n {\n \"instruction_type\": \"CONTRARY_EXERCISE\",\n \"instrument_id\": \"\",\n \"quantity\": \"\",\n \"client_instruction_id\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"sunt_f\": false,\n \"magnae59\": 67421727\n },\n {\n \"minim48\": false,\n \"fugiat94d\": -43856089.03091218\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ba8ed9d3-4e17-4119-824c-8855f7d95318", "name": "All rows rejected as duplicates", "originalRequest": { "url": { "path": [ "v1", "accounts", ":account_id", "positions", "instructions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "[\n {\n \"instruction_type\": \"EXERCISE\",\n \"instrument_id\": \"\",\n \"quantity\": \"\",\n \"client_instruction_id\": \"\"\n },\n {\n \"instruction_type\": \"CONTRARY_EXERCISE\",\n \"instrument_id\": \"\",\n \"quantity\": \"\",\n \"client_instruction_id\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"client_instruction_id\": \"\",\n \"account_id\": \"\",\n \"instruction_type\": \"CONTRARY_EXERCISE\",\n \"instrument_id\": \"\",\n \"symbol\": \"\",\n \"quantity\": \"\",\n \"status\": \"CANCELLED\",\n \"accepted_quantity\": \"\",\n \"created_at\": \"\",\n \"rejection\": \"\",\n \"rejection_reason\": \"\",\n \"underlying_instrument_id\": \"\",\n \"updated_at\": \"\"\n },\n {\n \"id\": \"\",\n \"client_instruction_id\": \"\",\n \"account_id\": \"\",\n \"instruction_type\": \"EXERCISE\",\n \"instrument_id\": \"\",\n \"symbol\": \"\",\n \"quantity\": \"\",\n \"status\": \"UNKNOWN\",\n \"accepted_quantity\": \"\",\n \"created_at\": \"\",\n \"rejection\": \"\",\n \"rejection_reason\": \"\",\n \"underlying_instrument_id\": \"\",\n \"updated_at\": \"\"\n }\n ],\n \"metadata\": {\n \"request_id\": \"\",\n \"next_page_token\": \"\",\n \"page_number\": \"\",\n \"previous_page_token\": \"\",\n \"total_items\": \"\",\n \"total_pages\": \"\"\n },\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cc3d42d9-58c8-4e97-90e0-afba43ccef2c", "name": "All rows rejected by an internal server fault", "originalRequest": { "url": { "path": [ "v1", "accounts", ":account_id", "positions", "instructions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "[\n {\n \"instruction_type\": \"EXERCISE\",\n \"instrument_id\": \"\",\n \"quantity\": \"\",\n \"client_instruction_id\": \"\"\n },\n {\n \"instruction_type\": \"CONTRARY_EXERCISE\",\n \"instrument_id\": \"\",\n \"quantity\": \"\",\n \"client_instruction_id\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"client_instruction_id\": \"\",\n \"account_id\": \"\",\n \"instruction_type\": \"CONTRARY_EXERCISE\",\n \"instrument_id\": \"\",\n \"symbol\": \"\",\n \"quantity\": \"\",\n \"status\": \"CANCELLED\",\n \"accepted_quantity\": \"\",\n \"created_at\": \"\",\n \"rejection\": \"\",\n \"rejection_reason\": \"\",\n \"underlying_instrument_id\": \"\",\n \"updated_at\": \"\"\n },\n {\n \"id\": \"\",\n \"client_instruction_id\": \"\",\n \"account_id\": \"\",\n \"instruction_type\": \"EXERCISE\",\n \"instrument_id\": \"\",\n \"symbol\": \"\",\n \"quantity\": \"\",\n \"status\": \"UNKNOWN\",\n \"accepted_quantity\": \"\",\n \"created_at\": \"\",\n \"rejection\": \"\",\n \"rejection_reason\": \"\",\n \"underlying_instrument_id\": \"\",\n \"updated_at\": \"\"\n }\n ],\n \"metadata\": {\n \"request_id\": \"\",\n \"next_page_token\": \"\",\n \"page_number\": \"\",\n \"previous_page_token\": \"\",\n \"total_items\": \"\",\n \"total_pages\": \"\"\n },\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0d2b7028-ba04-4530-aa51-2d4ad47d266b", "name": "All rows rejected because the clearing service was unavailable", "originalRequest": { "url": { "path": [ "v1", "accounts", ":account_id", "positions", "instructions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "[\n {\n \"instruction_type\": \"EXERCISE\",\n \"instrument_id\": \"\",\n \"quantity\": \"\",\n \"client_instruction_id\": \"\"\n },\n {\n \"instruction_type\": \"CONTRARY_EXERCISE\",\n \"instrument_id\": \"\",\n \"quantity\": \"\",\n \"client_instruction_id\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"client_instruction_id\": \"\",\n \"account_id\": \"\",\n \"instruction_type\": \"CONTRARY_EXERCISE\",\n \"instrument_id\": \"\",\n \"symbol\": \"\",\n \"quantity\": \"\",\n \"status\": \"CANCELLED\",\n \"accepted_quantity\": \"\",\n \"created_at\": \"\",\n \"rejection\": \"\",\n \"rejection_reason\": \"\",\n \"underlying_instrument_id\": \"\",\n \"updated_at\": \"\"\n },\n {\n \"id\": \"\",\n \"client_instruction_id\": \"\",\n \"account_id\": \"\",\n \"instruction_type\": \"EXERCISE\",\n \"instrument_id\": \"\",\n \"symbol\": \"\",\n \"quantity\": \"\",\n \"status\": \"UNKNOWN\",\n \"accepted_quantity\": \"\",\n \"created_at\": \"\",\n \"rejection\": \"\",\n \"rejection_reason\": \"\",\n \"underlying_instrument_id\": \"\",\n \"updated_at\": \"\"\n }\n ],\n \"metadata\": {\n \"request_id\": \"\",\n \"next_page_token\": \"\",\n \"page_number\": \"\",\n \"previous_page_token\": \"\",\n \"total_items\": \"\",\n \"total_pages\": \"\"\n },\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "20220236-d4f1-417d-8433-3821925f5467", "name": "Cancel Position Instruction", "request": { "name": "Cancel Position Instruction", "description": { "content": "Cancel an outstanding position instruction by its server-assigned `id`.\nReturns the updated instruction with status `CANCEL_REQUESTED`. The\nterminal `CANCELLED` or `CANCEL_FAILED` state arrives asynchronously and\nis observable via subsequent GETs.", "type": "text/plain" }, "url": { "path": [ "v1", "accounts", ":account_id", "positions", "instructions", ":instruction_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "account_id", "disabled": false, "description": { "content": "(Required) Account identifier", "type": "text/plain" } }, { "type": "any", "value": "", "key": "instruction_id", "disabled": false, "description": { "content": "(Required) Server-assigned instruction id", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "0846a3d9-cef2-45cd-9d6e-dd7bef6f47e8", "name": "Cancel accepted", "originalRequest": { "url": { "path": [ "v1", "accounts", ":account_id", "positions", "instructions", ":instruction_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"\",\n \"client_instruction_id\": \"\",\n \"account_id\": \"\",\n \"instruction_type\": \"DO_NOT_EXERCISE\",\n \"instrument_id\": \"\",\n \"symbol\": \"\",\n \"quantity\": \"\",\n \"status\": \"UNKNOWN\",\n \"accepted_quantity\": \"\",\n \"created_at\": \"\",\n \"rejection\": \"\",\n \"rejection_reason\": \"\",\n \"underlying_instrument_id\": \"\",\n \"updated_at\": \"\"\n },\n \"metadata\": {\n \"request_id\": \"\",\n \"next_page_token\": \"\",\n \"page_number\": \"\",\n \"previous_page_token\": \"\",\n \"total_items\": \"\",\n \"total_pages\": \"\"\n },\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0851fc83-769e-4acb-82e2-77f8b5b8de59", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1", "accounts", ":account_id", "positions", "instructions", ":instruction_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"sunt_f\": false,\n \"magnae59\": 67421727\n },\n {\n \"minim48\": false,\n \"fugiat94d\": -43856089.03091218\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f8a63a03-2b40-482e-931b-2dd82d64678a", "name": "Instruction not found", "originalRequest": { "url": { "path": [ "v1", "accounts", ":account_id", "positions", "instructions", ":instruction_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"sunt_f\": false,\n \"magnae59\": 67421727\n },\n {\n \"minim48\": false,\n \"fugiat94d\": -43856089.03091218\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fb300325-ec89-415d-83b8-f9f0cfc8538a", "name": "Instruction is in a terminal state", "originalRequest": { "url": { "path": [ "v1", "accounts", ":account_id", "positions", "instructions", ":instruction_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"sunt_f\": false,\n \"magnae59\": 67421727\n },\n {\n \"minim48\": false,\n \"fugiat94d\": -43856089.03091218\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "05305aee-b259-4e90-82f4-5b217ef9775c", "name": "Service temporarily unavailable", "originalRequest": { "url": { "path": [ "v1", "accounts", ":account_id", "positions", "instructions", ":instruction_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"sunt_f\": false,\n \"magnae59\": 67421727\n },\n {\n \"minim48\": false,\n \"fugiat94d\": -43856089.03091218\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a115bcd9-7cd8-4598-a108-36a9e430d6e1", "name": "Close Position", "request": { "name": "Close Position", "description": { "content": "Delete a position within an account for an instrument.\n\nRetrieves orders generated to close the position.", "type": "text/plain" }, "url": { "path": [ "v1", "accounts", ":account_id", "positions", ":instrument_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "account_id", "disabled": false, "description": { "content": "(Required) Account identifier", "type": "text/plain" } }, { "type": "any", "value": "", "key": "instrument_id", "disabled": false, "description": { "content": "(Required) Instrument ID (UUID) or symbol (equity ticker or OSI option symbol).", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "f162d316-a9c9-4b97-94c8-687bf033a36d", "name": "List of orders generated to close the position.", "originalRequest": { "url": { "path": [ "v1", "accounts", ":account_id", "positions", ":instrument_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"client_order_id\": \"\",\n \"account_id\": \"\",\n \"venue\": \"\",\n \"side\": \"SELL\",\n \"quantity\": \"\",\n \"order_type\": \"MARKET\",\n \"time_in_force\": \"AT_CLOSE\",\n \"status\": \"PENDING_CANCEL\",\n \"filled_quantity\": \"\",\n \"leaves_quantity\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"average_fill_price\": \"\",\n \"details\": [\n \"\",\n \"\"\n ],\n \"expires_at\": \"\",\n \"extended_hours\": \"\",\n \"instrument_id\": \"\",\n \"instrument_type\": \"\",\n \"limit_offset\": \"\",\n \"limit_price\": \"\",\n \"queue_state\": \"\",\n \"releases_at\": \"\",\n \"stop_price\": \"\",\n \"strategy\": {\n \"type\": \"\",\n \"end_at\": \"\",\n \"start_at\": \"\"\n },\n \"symbol\": \"\",\n \"trailing_limit_px\": \"\",\n \"trailing_offset\": \"\",\n \"trailing_offset_type\": \"\",\n \"trailing_stop_px\": \"\",\n \"trailing_watermark_px\": \"\",\n \"trailing_watermark_ts\": \"\",\n \"underlying_instrument_id\": \"\",\n \"underlying_instrument_type\": \"\"\n },\n {\n \"id\": \"\",\n \"client_order_id\": \"\",\n \"account_id\": \"\",\n \"venue\": \"\",\n \"side\": \"SELL\",\n \"quantity\": \"\",\n \"order_type\": \"LIMIT\",\n \"time_in_force\": \"AT_OPEN\",\n \"status\": \"REJECTED\",\n \"filled_quantity\": \"\",\n \"leaves_quantity\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"average_fill_price\": \"\",\n \"details\": [\n \"\",\n \"\"\n ],\n \"expires_at\": \"\",\n \"extended_hours\": \"\",\n \"instrument_id\": \"\",\n \"instrument_type\": \"\",\n \"limit_offset\": \"\",\n \"limit_price\": \"\",\n \"queue_state\": \"\",\n \"releases_at\": \"\",\n \"stop_price\": \"\",\n \"strategy\": {\n \"type\": \"\",\n \"end_at\": \"\",\n \"start_at\": \"\"\n },\n \"symbol\": \"\",\n \"trailing_limit_px\": \"\",\n \"trailing_offset\": \"\",\n \"trailing_offset_type\": \"\",\n \"trailing_stop_px\": \"\",\n \"trailing_watermark_px\": \"\",\n \"trailing_watermark_ts\": \"\",\n \"underlying_instrument_id\": \"\",\n \"underlying_instrument_type\": \"\"\n }\n ],\n \"metadata\": {\n \"request_id\": \"\",\n \"next_page_token\": \"\",\n \"page_number\": \"\",\n \"previous_page_token\": \"\",\n \"total_items\": \"\",\n \"total_pages\": \"\"\n },\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b2bcde5f-3c61-4128-8f98-813826a68ae0", "name": "Invalid request", "originalRequest": { "url": { "path": [ "v1", "accounts", ":account_id", "positions", ":instrument_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"sunt_f\": false,\n \"magnae59\": 67421727\n },\n {\n \"minim48\": false,\n \"fugiat94d\": -43856089.03091218\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "39c51280-0125-4210-a181-db1501a4af0c", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1", "accounts", ":account_id", "positions", ":instrument_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"sunt_f\": false,\n \"magnae59\": 67421727\n },\n {\n \"minim48\": false,\n \"fugiat94d\": -43856089.03091218\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "02d57011-e91d-4ae9-a880-55e8a9b4acb5", "name": "Internal server error", "originalRequest": { "url": { "path": [ "v1", "accounts", ":account_id", "positions", ":instrument_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"sunt_f\": false,\n \"magnae59\": 67421727\n },\n {\n \"minim48\": false,\n \"fugiat94d\": -43856089.03091218\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Watchlist", "description": "Create and manage watchlists.", "item": [ { "id": "37a74574-7cf5-4416-bafe-741c982a26fc", "name": "Get Watchlists", "request": { "name": "Get Watchlists", "description": { "content": "List watchlists for the authenticated user", "type": "text/plain" }, "url": { "path": [ "v1", "watchlists" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The number of items to return per page. Only used when page_token is not provided.", "type": "text/plain" }, "key": "page_size", "value": "1000" }, { "disabled": false, "description": { "content": "Token for retrieving the next or previous page of results. Contains encoded pagination state; when provided, page_size is ignored.", "type": "text/plain" }, "key": "page_token", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "645836fb-d86b-4e69-9dd2-3dfe13b7287a", "name": "List of watchlists", "originalRequest": { "url": { "path": [ "v1", "watchlists" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The number of items to return per page. Only used when page_token is not provided.", "type": "text/plain" }, "key": "page_size", "value": "1000" }, { "disabled": false, "description": { "content": "Token for retrieving the next or previous page of results. Contains encoded pagination state; when provided, page_size is ignored.", "type": "text/plain" }, "key": "page_token", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"created_at\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"created_at\": \"\"\n }\n ],\n \"metadata\": {\n \"request_id\": \"\",\n \"next_page_token\": \"\",\n \"page_number\": \"\",\n \"previous_page_token\": \"\",\n \"total_items\": \"\",\n \"total_pages\": \"\"\n },\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e61c5470-0238-4afb-a507-d0a828702219", "name": "Internal server error", "originalRequest": { "url": { "path": [ "v1", "watchlists" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The number of items to return per page. Only used when page_token is not provided.", "type": "text/plain" }, "key": "page_size", "value": "1000" }, { "disabled": false, "description": { "content": "Token for retrieving the next or previous page of results. Contains encoded pagination state; when provided, page_size is ignored.", "type": "text/plain" }, "key": "page_token", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"sunt_f\": false,\n \"magnae59\": 67421727\n },\n {\n \"minim48\": false,\n \"fugiat94d\": -43856089.03091218\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6bd73f50-9d2c-42d9-b47f-08913047d9f0", "name": "Create Watchlist", "request": { "name": "Create Watchlist", "description": {}, "url": { "path": [ "v1", "watchlists" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "5ca25d50-aaab-4b1c-85e7-9fd03bf443a6", "name": "Watchlist created successfully", "originalRequest": { "url": { "path": [ "v1", "watchlists" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"\",\n \"name\": \"\",\n \"created_at\": \"\"\n },\n \"metadata\": {\n \"request_id\": \"\",\n \"next_page_token\": \"\",\n \"page_number\": \"\",\n \"previous_page_token\": \"\",\n \"total_items\": \"\",\n \"total_pages\": \"\"\n },\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0a87bd19-0eb6-441b-8f1d-c042fe7c512d", "name": "Invalid request", "originalRequest": { "url": { "path": [ "v1", "watchlists" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"sunt_f\": false,\n \"magnae59\": 67421727\n },\n {\n \"minim48\": false,\n \"fugiat94d\": -43856089.03091218\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "681afee2-61d6-4526-ab6c-420faffc0876", "name": "Resource already exists", "originalRequest": { "url": { "path": [ "v1", "watchlists" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"sunt_f\": false,\n \"magnae59\": 67421727\n },\n {\n \"minim48\": false,\n \"fugiat94d\": -43856089.03091218\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4b26334d-5a60-4414-b486-4719eda3aeeb", "name": "Internal server error", "originalRequest": { "url": { "path": [ "v1", "watchlists" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"sunt_f\": false,\n \"magnae59\": 67421727\n },\n {\n \"minim48\": false,\n \"fugiat94d\": -43856089.03091218\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "83b52052-ad1e-40fb-9e6c-56b0249ceda0", "name": "Get Watchlist By ID", "request": { "name": "Get Watchlist By ID", "description": { "content": "Get a watchlist by ID with all its items", "type": "text/plain" }, "url": { "path": [ "v1", "watchlists", ":watchlist_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "watchlist_id", "disabled": false, "description": { "content": "(Required) Watchlist ID", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "e39ed10a-0e70-4107-bfcb-7d415c694cf6", "name": "Watchlist details with items", "originalRequest": { "url": { "path": [ "v1", "watchlists", ":watchlist_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"\",\n \"name\": \"\",\n \"created_at\": \"\",\n \"items\": [\n {\n \"id\": \"\",\n \"added_at\": \"\",\n \"added_price\": \"\",\n \"instrument\": \"\"\n },\n {\n \"id\": \"\",\n \"added_at\": \"\",\n \"added_price\": \"\",\n \"instrument\": \"\"\n }\n ]\n },\n \"metadata\": {\n \"request_id\": \"\",\n \"next_page_token\": \"\",\n \"page_number\": \"\",\n \"previous_page_token\": \"\",\n \"total_items\": \"\",\n \"total_pages\": \"\"\n },\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f974e53a-193e-4592-8437-990d7361ca28", "name": "Watchlist not found", "originalRequest": { "url": { "path": [ "v1", "watchlists", ":watchlist_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"sunt_f\": false,\n \"magnae59\": 67421727\n },\n {\n \"minim48\": false,\n \"fugiat94d\": -43856089.03091218\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "78ddb7b4-d6a7-41a3-aaca-5d94f8094167", "name": "Internal server error", "originalRequest": { "url": { "path": [ "v1", "watchlists", ":watchlist_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"sunt_f\": false,\n \"magnae59\": 67421727\n },\n {\n \"minim48\": false,\n \"fugiat94d\": -43856089.03091218\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f0e50b47-66b6-4380-a7d8-75322265b65b", "name": "Delete Watchlist", "request": { "name": "Delete Watchlist", "description": { "content": "Delete a watchlist and all its items", "type": "text/plain" }, "url": { "path": [ "v1", "watchlists", ":watchlist_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "watchlist_id", "disabled": false, "description": { "content": "(Required) Watchlist ID", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "9a631d82-a85e-4233-8022-81ce80295f12", "name": "Watchlist deleted successfully", "originalRequest": { "url": { "path": [ "v1", "watchlists", ":watchlist_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": \"\",\n \"metadata\": {\n \"request_id\": \"\",\n \"next_page_token\": \"\",\n \"page_number\": \"\",\n \"previous_page_token\": \"\",\n \"total_items\": \"\",\n \"total_pages\": \"\"\n },\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "79d35471-f3d0-4790-a464-7eae232a46f1", "name": "Watchlist not found", "originalRequest": { "url": { "path": [ "v1", "watchlists", ":watchlist_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"sunt_f\": false,\n \"magnae59\": 67421727\n },\n {\n \"minim48\": false,\n \"fugiat94d\": -43856089.03091218\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "37edd8f7-8955-4052-8a50-0998d0d93d1a", "name": "Internal server error", "originalRequest": { "url": { "path": [ "v1", "watchlists", ":watchlist_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"sunt_f\": false,\n \"magnae59\": 67421727\n },\n {\n \"minim48\": false,\n \"fugiat94d\": -43856089.03091218\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2ec5d808-5367-4b5a-a4c9-f4918d46fb05", "name": "Add Watchlist Item", "request": { "name": "Add Watchlist Item", "description": { "content": "Add an instrument to a watchlist", "type": "text/plain" }, "url": { "path": [ "v1", "watchlists", ":watchlist_id", "items" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "watchlist_id", "disabled": false, "description": { "content": "(Required) Watchlist ID", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"instrument_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "d03bad0b-1a7e-4ed9-98ec-0d1e89765f75", "name": "Item added successfully", "originalRequest": { "url": { "path": [ "v1", "watchlists", ":watchlist_id", "items" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"instrument_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"item_id\": \"\"\n },\n \"metadata\": {\n \"request_id\": \"\",\n \"next_page_token\": \"\",\n \"page_number\": \"\",\n \"previous_page_token\": \"\",\n \"total_items\": \"\",\n \"total_pages\": \"\"\n },\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6d559cad-ec35-414b-a15e-a09c43bb2f6b", "name": "Invalid request or watchlist is full", "originalRequest": { "url": { "path": [ "v1", "watchlists", ":watchlist_id", "items" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"instrument_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"sunt_f\": false,\n \"magnae59\": 67421727\n },\n {\n \"minim48\": false,\n \"fugiat94d\": -43856089.03091218\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4db57dd7-382e-4eb0-bb8f-ed5caa4aafaa", "name": "Watchlist or instrument not found", "originalRequest": { "url": { "path": [ "v1", "watchlists", ":watchlist_id", "items" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"instrument_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"sunt_f\": false,\n \"magnae59\": 67421727\n },\n {\n \"minim48\": false,\n \"fugiat94d\": -43856089.03091218\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cae22ada-20a6-4916-81d5-2de4938e4a59", "name": "Instrument already exists in watchlist", "originalRequest": { "url": { "path": [ "v1", "watchlists", ":watchlist_id", "items" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"instrument_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"sunt_f\": false,\n \"magnae59\": 67421727\n },\n {\n \"minim48\": false,\n \"fugiat94d\": -43856089.03091218\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b6b8d36e-98ff-4fa5-9a86-86ae71137154", "name": "Internal server error", "originalRequest": { "url": { "path": [ "v1", "watchlists", ":watchlist_id", "items" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"instrument_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"sunt_f\": false,\n \"magnae59\": 67421727\n },\n {\n \"minim48\": false,\n \"fugiat94d\": -43856089.03091218\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ba265008-5ec6-4a14-9020-e5f69839ea12", "name": "Delete Watchlist Item", "request": { "name": "Delete Watchlist Item", "description": { "content": "Delete an instrument from a watchlist", "type": "text/plain" }, "url": { "path": [ "v1", "watchlists", ":watchlist_id", "items", ":item_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "watchlist_id", "disabled": false, "description": { "content": "(Required) Watchlist ID", "type": "text/plain" } }, { "type": "any", "value": "", "key": "item_id", "disabled": false, "description": { "content": "(Required) Item ID", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "5c3497b5-359e-4b1a-ab0a-0dab875a8cdd", "name": "Item deleted successfully", "originalRequest": { "url": { "path": [ "v1", "watchlists", ":watchlist_id", "items", ":item_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": \"\",\n \"metadata\": {\n \"request_id\": \"\",\n \"next_page_token\": \"\",\n \"page_number\": \"\",\n \"previous_page_token\": \"\",\n \"total_items\": \"\",\n \"total_pages\": \"\"\n },\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "46a56719-9b6b-4228-8152-b5f08b9c3985", "name": "Watchlist or item not found", "originalRequest": { "url": { "path": [ "v1", "watchlists", ":watchlist_id", "items", ":item_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"sunt_f\": false,\n \"magnae59\": 67421727\n },\n {\n \"minim48\": false,\n \"fugiat94d\": -43856089.03091218\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4b8f8fc4-8abc-4d27-85bc-7a444165b319", "name": "Internal server error", "originalRequest": { "url": { "path": [ "v1", "watchlists", ":watchlist_id", "items", ":item_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"sunt_f\": false,\n \"magnae59\": 67421727\n },\n {\n \"minim48\": false,\n \"fugiat94d\": -43856089.03091218\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Instruments", "description": "Retrieve core details and discovery endpoints for tradable instruments.", "item": [ { "id": "2fe7c241-18c6-48d2-954e-1b9d244baf34", "name": "Get Instruments", "request": { "name": "Get Instruments", "description": { "content": "Retrieves a list of tradeable instruments.\n\n", "type": "text/plain" }, "url": { "path": [ "v1", "instruments" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter by instrument type (e.g. COMMON_STOCK, OPTION)", "type": "text/plain" }, "key": "instrument_type", "value": "COMMON_STOCK" }, { "disabled": false, "description": { "content": "Comma-separated instrument identifiers: unique identifiers or symbols (symbol for equities, OSI for options)", "type": "text/plain" }, "key": "instrument_ids", "value": "," }, { "disabled": false, "description": { "content": "Filter by marginable status", "type": "text/plain" }, "key": "is_marginable", "value": "" }, { "disabled": false, "description": { "content": "Filter by easy to borrow status", "type": "text/plain" }, "key": "easy_to_borrow", "value": "" }, { "disabled": false, "description": { "content": "Filter by short prohibited status", "type": "text/plain" }, "key": "is_short_prohibited", "value": "" }, { "disabled": false, "description": { "content": "Filter by threshold security status", "type": "text/plain" }, "key": "is_threshold_security", "value": "" }, { "disabled": false, "description": { "content": "Filter by liquidation only status", "type": "text/plain" }, "key": "is_liquidation_only", "value": "" }, { "disabled": false, "description": { "content": "Filter by publicly traded partnership (PTP) status", "type": "text/plain" }, "key": "is_ptp", "value": "" }, { "disabled": false, "description": { "content": "The number of items to return per page. Only used when page_token is not provided.", "type": "text/plain" }, "key": "page_size", "value": "1000" }, { "disabled": false, "description": { "content": "Token for retrieving the next or previous page of results. Contains encoded pagination state; when provided, page_size is ignored.", "type": "text/plain" }, "key": "page_token", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "101a8e53-3eda-491d-b4d1-bddc0b1a4910", "name": "List of instruments", "originalRequest": { "url": { "path": [ "v1", "instruments" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter by instrument type (e.g. COMMON_STOCK, OPTION)", "type": "text/plain" }, "key": "instrument_type", "value": "COMMON_STOCK" }, { "disabled": false, "description": { "content": "Comma-separated instrument identifiers: unique identifiers or symbols (symbol for equities, OSI for options)", "type": "text/plain" }, "key": "instrument_ids", "value": "," }, { "disabled": false, "description": { "content": "Filter by marginable status", "type": "text/plain" }, "key": "is_marginable", "value": "" }, { "disabled": false, "description": { "content": "Filter by easy to borrow status", "type": "text/plain" }, "key": "easy_to_borrow", "value": "" }, { "disabled": false, "description": { "content": "Filter by short prohibited status", "type": "text/plain" }, "key": "is_short_prohibited", "value": "" }, { "disabled": false, "description": { "content": "Filter by threshold security status", "type": "text/plain" }, "key": "is_threshold_security", "value": "" }, { "disabled": false, "description": { "content": "Filter by liquidation only status", "type": "text/plain" }, "key": "is_liquidation_only", "value": "" }, { "disabled": false, "description": { "content": "Filter by publicly traded partnership (PTP) status", "type": "text/plain" }, "key": "is_ptp", "value": "" }, { "disabled": false, "description": { "content": "The number of items to return per page. Only used when page_token is not provided.", "type": "text/plain" }, "key": "page_size", "value": "1000" }, { "disabled": false, "description": { "content": "Token for retrieving the next or previous page of results. Contains encoded pagination state; when provided, page_size is ignored.", "type": "text/plain" }, "key": "page_token", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"symbol\": \"\",\n \"venue\": \"\",\n \"country_of_issue\": \"\",\n \"currency\": \"\",\n \"is_marginable\": \"\",\n \"easy_to_borrow\": \"\",\n \"is_short_prohibited\": \"\",\n \"is_threshold_security\": \"\",\n \"is_liquidation_only\": \"\",\n \"is_tradable\": \"\",\n \"is_fractionable\": \"\",\n \"is_ptp\": \"\",\n \"adv\": \"\",\n \"cax_adjusted_previous_close\": \"\",\n \"instrument_type\": \"\",\n \"long_margin_rate\": \"\",\n \"name\": \"\",\n \"notional_adv\": \"\",\n \"previous_close\": \"\",\n \"short_margin_rate\": \"\",\n \"tick_rules\": [\n {\n \"start_price\": \"\",\n \"tick_size\": \"\",\n \"end_price\": \"\"\n },\n {\n \"start_price\": \"\",\n \"tick_size\": \"\",\n \"end_price\": \"\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"symbol\": \"\",\n \"venue\": \"\",\n \"country_of_issue\": \"\",\n \"currency\": \"\",\n \"is_marginable\": \"\",\n \"easy_to_borrow\": \"\",\n \"is_short_prohibited\": \"\",\n \"is_threshold_security\": \"\",\n \"is_liquidation_only\": \"\",\n \"is_tradable\": \"\",\n \"is_fractionable\": \"\",\n \"is_ptp\": \"\",\n \"adv\": \"\",\n \"cax_adjusted_previous_close\": \"\",\n \"instrument_type\": \"\",\n \"long_margin_rate\": \"\",\n \"name\": \"\",\n \"notional_adv\": \"\",\n \"previous_close\": \"\",\n \"short_margin_rate\": \"\",\n \"tick_rules\": [\n {\n \"start_price\": \"\",\n \"tick_size\": \"\",\n \"end_price\": \"\"\n },\n {\n \"start_price\": \"\",\n \"tick_size\": \"\",\n \"end_price\": \"\"\n }\n ]\n }\n ],\n \"metadata\": {\n \"request_id\": \"\",\n \"next_page_token\": \"\",\n \"page_number\": \"\",\n \"previous_page_token\": \"\",\n \"total_items\": \"\",\n \"total_pages\": \"\"\n },\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "45a8d9dd-d24d-43ec-85ab-6235277a1957", "name": "Internal server error", "originalRequest": { "url": { "path": [ "v1", "instruments" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter by instrument type (e.g. COMMON_STOCK, OPTION)", "type": "text/plain" }, "key": "instrument_type", "value": "COMMON_STOCK" }, { "disabled": false, "description": { "content": "Comma-separated instrument identifiers: unique identifiers or symbols (symbol for equities, OSI for options)", "type": "text/plain" }, "key": "instrument_ids", "value": "," }, { "disabled": false, "description": { "content": "Filter by marginable status", "type": "text/plain" }, "key": "is_marginable", "value": "" }, { "disabled": false, "description": { "content": "Filter by easy to borrow status", "type": "text/plain" }, "key": "easy_to_borrow", "value": "" }, { "disabled": false, "description": { "content": "Filter by short prohibited status", "type": "text/plain" }, "key": "is_short_prohibited", "value": "" }, { "disabled": false, "description": { "content": "Filter by threshold security status", "type": "text/plain" }, "key": "is_threshold_security", "value": "" }, { "disabled": false, "description": { "content": "Filter by liquidation only status", "type": "text/plain" }, "key": "is_liquidation_only", "value": "" }, { "disabled": false, "description": { "content": "Filter by publicly traded partnership (PTP) status", "type": "text/plain" }, "key": "is_ptp", "value": "" }, { "disabled": false, "description": { "content": "The number of items to return per page. Only used when page_token is not provided.", "type": "text/plain" }, "key": "page_size", "value": "1000" }, { "disabled": false, "description": { "content": "Token for retrieving the next or previous page of results. Contains encoded pagination state; when provided, page_size is ignored.", "type": "text/plain" }, "key": "page_token", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"sunt_f\": false,\n \"magnae59\": 67421727\n },\n {\n \"minim48\": false,\n \"fugiat94d\": -43856089.03091218\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4cd55ce7-15b3-44ee-88ab-26eee8a1f82b", "name": "Get Option Contracts", "request": { "name": "Get Option Contracts", "description": { "content": "List options contracts.\n\nReturns options contracts with options-specific metadata. Exactly one\nidentifier must be provided: `underlier`/`underlying_instrument_id` (list\nall contracts for that underlier) or `contract_ids` (look up specific\ncontracts directly). `expiry`/`contract_type` apply as filters in either\ncase.", "type": "text/plain" }, "url": { "path": [ "v1", "instruments", "options", "contracts" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Underlier symbol (e.g., AAPL, SPX)", "type": "text/plain" }, "key": "underlier", "value": "" }, { "disabled": false, "description": { "content": "Instrument identifier or symbol of the underlying equity/index", "type": "text/plain" }, "key": "underlying_instrument_id", "value": "" }, { "disabled": false, "description": { "content": "Comma-separated contract instrument IDs (UUID) or OSI option symbols to look up directly, bypassing underlier expansion. Mutually exclusive with underlier/underlying_instrument_id; up to 100 values.", "type": "text/plain" }, "key": "contract_ids", "value": "," }, { "disabled": false, "description": { "content": "Filter to contracts expiring on this date (YYYY-MM-DD)", "type": "text/plain" }, "key": "expiry", "value": "" }, { "disabled": false, "description": { "content": "Filter by contract type: CALL or PUT", "type": "text/plain" }, "key": "contract_type", "value": "CALL" }, { "disabled": false, "description": { "content": "Filter by settlement cycle: true for early-settling (AM, settle-on-open) contracts, false for normal (PM) contracts. Omit to return both.", "type": "text/plain" }, "key": "is_settle_on_open", "value": "" }, { "disabled": false, "description": { "content": "The number of items to return per page. Only used when page_token is not provided.", "type": "text/plain" }, "key": "page_size", "value": "1000" }, { "disabled": false, "description": { "content": "Token for retrieving the next or previous page of results. Contains encoded pagination state; when provided, page_size is ignored.", "type": "text/plain" }, "key": "page_token", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "e8151064-45e1-4739-aa91-4db4efd7c728", "name": "List of options contracts", "originalRequest": { "url": { "path": [ "v1", "instruments", "options", "contracts" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Underlier symbol (e.g., AAPL, SPX)", "type": "text/plain" }, "key": "underlier", "value": "" }, { "disabled": false, "description": { "content": "Instrument identifier or symbol of the underlying equity/index", "type": "text/plain" }, "key": "underlying_instrument_id", "value": "" }, { "disabled": false, "description": { "content": "Comma-separated contract instrument IDs (UUID) or OSI option symbols to look up directly, bypassing underlier expansion. Mutually exclusive with underlier/underlying_instrument_id; up to 100 values.", "type": "text/plain" }, "key": "contract_ids", "value": "," }, { "disabled": false, "description": { "content": "Filter to contracts expiring on this date (YYYY-MM-DD)", "type": "text/plain" }, "key": "expiry", "value": "" }, { "disabled": false, "description": { "content": "Filter by contract type: CALL or PUT", "type": "text/plain" }, "key": "contract_type", "value": "CALL" }, { "disabled": false, "description": { "content": "Filter by settlement cycle: true for early-settling (AM, settle-on-open) contracts, false for normal (PM) contracts. Omit to return both.", "type": "text/plain" }, "key": "is_settle_on_open", "value": "" }, { "disabled": false, "description": { "content": "The number of items to return per page. Only used when page_token is not provided.", "type": "text/plain" }, "key": "page_size", "value": "1000" }, { "disabled": false, "description": { "content": "Token for retrieving the next or previous page of results. Contains encoded pagination state; when provided, page_size is ignored.", "type": "text/plain" }, "key": "page_token", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"symbol\": \"\",\n \"currency\": \"\",\n \"exchange\": \"\",\n \"expiry\": \"\",\n \"contract_type\": \"PUT\",\n \"strike_price\": \"\",\n \"multiplier\": \"\",\n \"exercise_style\": \"AMERICAN\",\n \"listing_type\": \"STANDARD\",\n \"is_liquidation_only\": \"\",\n \"is_marginable\": \"\",\n \"is_tradable\": \"\",\n \"is_settle_on_open\": \"\",\n \"last_trade_cutoff\": \"\",\n \"open_interest\": \"\",\n \"tick_rules\": [\n {\n \"start_price\": \"\",\n \"tick_size\": \"\",\n \"end_price\": \"\"\n },\n {\n \"start_price\": \"\",\n \"tick_size\": \"\",\n \"end_price\": \"\"\n }\n ],\n \"underlying_instrument_id\": \"\"\n },\n {\n \"id\": \"\",\n \"symbol\": \"\",\n \"currency\": \"\",\n \"exchange\": \"\",\n \"expiry\": \"\",\n \"contract_type\": \"CALL\",\n \"strike_price\": \"\",\n \"multiplier\": \"\",\n \"exercise_style\": \"EUROPEAN\",\n \"listing_type\": \"OTC\",\n \"is_liquidation_only\": \"\",\n \"is_marginable\": \"\",\n \"is_tradable\": \"\",\n \"is_settle_on_open\": \"\",\n \"last_trade_cutoff\": \"\",\n \"open_interest\": \"\",\n \"tick_rules\": [\n {\n \"start_price\": \"\",\n \"tick_size\": \"\",\n \"end_price\": \"\"\n },\n {\n \"start_price\": \"\",\n \"tick_size\": \"\",\n \"end_price\": \"\"\n }\n ],\n \"underlying_instrument_id\": \"\"\n }\n ],\n \"metadata\": {\n \"request_id\": \"\",\n \"next_page_token\": \"\",\n \"page_number\": \"\",\n \"previous_page_token\": \"\",\n \"total_items\": \"\",\n \"total_pages\": \"\"\n },\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "467cee4a-be97-409e-876f-63afcbc8b44c", "name": "Invalid parameters", "originalRequest": { "url": { "path": [ "v1", "instruments", "options", "contracts" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Underlier symbol (e.g., AAPL, SPX)", "type": "text/plain" }, "key": "underlier", "value": "" }, { "disabled": false, "description": { "content": "Instrument identifier or symbol of the underlying equity/index", "type": "text/plain" }, "key": "underlying_instrument_id", "value": "" }, { "disabled": false, "description": { "content": "Comma-separated contract instrument IDs (UUID) or OSI option symbols to look up directly, bypassing underlier expansion. Mutually exclusive with underlier/underlying_instrument_id; up to 100 values.", "type": "text/plain" }, "key": "contract_ids", "value": "," }, { "disabled": false, "description": { "content": "Filter to contracts expiring on this date (YYYY-MM-DD)", "type": "text/plain" }, "key": "expiry", "value": "" }, { "disabled": false, "description": { "content": "Filter by contract type: CALL or PUT", "type": "text/plain" }, "key": "contract_type", "value": "CALL" }, { "disabled": false, "description": { "content": "Filter by settlement cycle: true for early-settling (AM, settle-on-open) contracts, false for normal (PM) contracts. Omit to return both.", "type": "text/plain" }, "key": "is_settle_on_open", "value": "" }, { "disabled": false, "description": { "content": "The number of items to return per page. Only used when page_token is not provided.", "type": "text/plain" }, "key": "page_size", "value": "1000" }, { "disabled": false, "description": { "content": "Token for retrieving the next or previous page of results. Contains encoded pagination state; when provided, page_size is ignored.", "type": "text/plain" }, "key": "page_token", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"sunt_f\": false,\n \"magnae59\": 67421727\n },\n {\n \"minim48\": false,\n \"fugiat94d\": -43856089.03091218\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "60fd8a19-cb27-415b-8084-d7281ce1101f", "name": "Underlier not found", "originalRequest": { "url": { "path": [ "v1", "instruments", "options", "contracts" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Underlier symbol (e.g., AAPL, SPX)", "type": "text/plain" }, "key": "underlier", "value": "" }, { "disabled": false, "description": { "content": "Instrument identifier or symbol of the underlying equity/index", "type": "text/plain" }, "key": "underlying_instrument_id", "value": "" }, { "disabled": false, "description": { "content": "Comma-separated contract instrument IDs (UUID) or OSI option symbols to look up directly, bypassing underlier expansion. Mutually exclusive with underlier/underlying_instrument_id; up to 100 values.", "type": "text/plain" }, "key": "contract_ids", "value": "," }, { "disabled": false, "description": { "content": "Filter to contracts expiring on this date (YYYY-MM-DD)", "type": "text/plain" }, "key": "expiry", "value": "" }, { "disabled": false, "description": { "content": "Filter by contract type: CALL or PUT", "type": "text/plain" }, "key": "contract_type", "value": "CALL" }, { "disabled": false, "description": { "content": "Filter by settlement cycle: true for early-settling (AM, settle-on-open) contracts, false for normal (PM) contracts. Omit to return both.", "type": "text/plain" }, "key": "is_settle_on_open", "value": "" }, { "disabled": false, "description": { "content": "The number of items to return per page. Only used when page_token is not provided.", "type": "text/plain" }, "key": "page_size", "value": "1000" }, { "disabled": false, "description": { "content": "Token for retrieving the next or previous page of results. Contains encoded pagination state; when provided, page_size is ignored.", "type": "text/plain" }, "key": "page_token", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"sunt_f\": false,\n \"magnae59\": 67421727\n },\n {\n \"minim48\": false,\n \"fugiat94d\": -43856089.03091218\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3701ddbf-3f66-44b9-a7bb-37d0d236c71b", "name": "Internal server error", "originalRequest": { "url": { "path": [ "v1", "instruments", "options", "contracts" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Underlier symbol (e.g., AAPL, SPX)", "type": "text/plain" }, "key": "underlier", "value": "" }, { "disabled": false, "description": { "content": "Instrument identifier or symbol of the underlying equity/index", "type": "text/plain" }, "key": "underlying_instrument_id", "value": "" }, { "disabled": false, "description": { "content": "Comma-separated contract instrument IDs (UUID) or OSI option symbols to look up directly, bypassing underlier expansion. Mutually exclusive with underlier/underlying_instrument_id; up to 100 values.", "type": "text/plain" }, "key": "contract_ids", "value": "," }, { "disabled": false, "description": { "content": "Filter to contracts expiring on this date (YYYY-MM-DD)", "type": "text/plain" }, "key": "expiry", "value": "" }, { "disabled": false, "description": { "content": "Filter by contract type: CALL or PUT", "type": "text/plain" }, "key": "contract_type", "value": "CALL" }, { "disabled": false, "description": { "content": "Filter by settlement cycle: true for early-settling (AM, settle-on-open) contracts, false for normal (PM) contracts. Omit to return both.", "type": "text/plain" }, "key": "is_settle_on_open", "value": "" }, { "disabled": false, "description": { "content": "The number of items to return per page. Only used when page_token is not provided.", "type": "text/plain" }, "key": "page_size", "value": "1000" }, { "disabled": false, "description": { "content": "Token for retrieving the next or previous page of results. Contains encoded pagination state; when provided, page_size is ignored.", "type": "text/plain" }, "key": "page_token", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"sunt_f\": false,\n \"magnae59\": 67421727\n },\n {\n \"minim48\": false,\n \"fugiat94d\": -43856089.03091218\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "aae86b5f-8e5c-4f1b-842d-2ad33b7a9bfd", "name": "Search Instruments", "request": { "name": "Search Instruments", "description": { "content": "Search instruments by symbol, alternate identifier, or company name.\n\nThe `q` parameter is case-insensitive and supports ticker symbols,\nalternate identifiers such as CUSIP, ISIN, and OPRA root,\nand company names for non-option instruments. Results are ranked by match\nquality plus instrument quality signals and relevance. Defaults to the `EQUITY` asset class (common\nstocks, preferred shares, ADRs, ETFs, and exchange-traded mutual funds).\nPass `asset_class=OPTION` to search option contracts: by full OSI symbol, by\nan OSI prefix (root + `YYMMDD` expiry, e.g. `AAPL 261217`), or by a\nroot-scoped phrase such as `AAPL Dec 250 call`.", "type": "text/plain" }, "url": { "path": [ "v1", "instruments", "search" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Search term applied case-insensitively to ticker symbols, alternate identifiers (CUSIP, ISIN, OPRA root), and company names for non-option instruments. Option searches match symbols and alternate identifiers.", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Comma-separated asset classes (EQUITY|OPTION|WARRANT|BOND|FX|OTHER). Defaults to EQUITY.", "type": "text/plain" }, "key": "asset_class", "value": "" }, { "disabled": false, "description": { "content": "Include inactive instruments. Default false.", "type": "text/plain" }, "key": "include_inactive", "value": "" }, { "disabled": false, "description": { "content": "Include publicly traded partnership (PTP) instruments. Default true (penalized in ranking).", "type": "text/plain" }, "key": "include_ptp", "value": "" }, { "disabled": false, "description": { "content": "Optional ISO currency filter (e.g., USD).", "type": "text/plain" }, "key": "currency", "value": "" }, { "disabled": false, "description": { "content": "Optional listing-country filter (e.g., US).", "type": "text/plain" }, "key": "country", "value": "" }, { "disabled": false, "description": { "content": "The number of items to return per page. Only used when page_token is not provided.", "type": "text/plain" }, "key": "page_size", "value": "100" }, { "disabled": false, "description": { "content": "Token for retrieving the next or previous page of results. Contains encoded pagination state; when provided, page_size is ignored.", "type": "text/plain" }, "key": "page_token", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "7535c076-f863-40a3-9a12-0d47453024c3", "name": "Ranked list of matching instruments", "originalRequest": { "url": { "path": [ "v1", "instruments", "search" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Search term applied case-insensitively to ticker symbols, alternate identifiers (CUSIP, ISIN, OPRA root), and company names for non-option instruments. Option searches match symbols and alternate identifiers.", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Comma-separated asset classes (EQUITY|OPTION|WARRANT|BOND|FX|OTHER). Defaults to EQUITY.", "type": "text/plain" }, "key": "asset_class", "value": "" }, { "disabled": false, "description": { "content": "Include inactive instruments. Default false.", "type": "text/plain" }, "key": "include_inactive", "value": "" }, { "disabled": false, "description": { "content": "Include publicly traded partnership (PTP) instruments. Default true (penalized in ranking).", "type": "text/plain" }, "key": "include_ptp", "value": "" }, { "disabled": false, "description": { "content": "Optional ISO currency filter (e.g., USD).", "type": "text/plain" }, "key": "currency", "value": "" }, { "disabled": false, "description": { "content": "Optional listing-country filter (e.g., US).", "type": "text/plain" }, "key": "country", "value": "" }, { "disabled": false, "description": { "content": "The number of items to return per page. Only used when page_token is not provided.", "type": "text/plain" }, "key": "page_size", "value": "100" }, { "disabled": false, "description": { "content": "Token for retrieving the next or previous page of results. Contains encoded pagination state; when provided, page_size is ignored.", "type": "text/plain" }, "key": "page_token", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"symbol\": \"\",\n \"venue\": \"\",\n \"country_of_issue\": \"\",\n \"currency\": \"\",\n \"is_marginable\": \"\",\n \"easy_to_borrow\": \"\",\n \"is_short_prohibited\": \"\",\n \"is_threshold_security\": \"\",\n \"is_liquidation_only\": \"\",\n \"is_tradable\": \"\",\n \"is_fractionable\": \"\",\n \"is_ptp\": \"\",\n \"adv\": \"\",\n \"cax_adjusted_previous_close\": \"\",\n \"instrument_type\": \"\",\n \"long_margin_rate\": \"\",\n \"name\": \"\",\n \"notional_adv\": \"\",\n \"previous_close\": \"\",\n \"short_margin_rate\": \"\",\n \"tick_rules\": [\n {\n \"start_price\": \"\",\n \"tick_size\": \"\",\n \"end_price\": \"\"\n },\n {\n \"start_price\": \"\",\n \"tick_size\": \"\",\n \"end_price\": \"\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"symbol\": \"\",\n \"venue\": \"\",\n \"country_of_issue\": \"\",\n \"currency\": \"\",\n \"is_marginable\": \"\",\n \"easy_to_borrow\": \"\",\n \"is_short_prohibited\": \"\",\n \"is_threshold_security\": \"\",\n \"is_liquidation_only\": \"\",\n \"is_tradable\": \"\",\n \"is_fractionable\": \"\",\n \"is_ptp\": \"\",\n \"adv\": \"\",\n \"cax_adjusted_previous_close\": \"\",\n \"instrument_type\": \"\",\n \"long_margin_rate\": \"\",\n \"name\": \"\",\n \"notional_adv\": \"\",\n \"previous_close\": \"\",\n \"short_margin_rate\": \"\",\n \"tick_rules\": [\n {\n \"start_price\": \"\",\n \"tick_size\": \"\",\n \"end_price\": \"\"\n },\n {\n \"start_price\": \"\",\n \"tick_size\": \"\",\n \"end_price\": \"\"\n }\n ]\n }\n ],\n \"metadata\": {\n \"request_id\": \"\",\n \"next_page_token\": \"\",\n \"page_number\": \"\",\n \"previous_page_token\": \"\",\n \"total_items\": \"\",\n \"total_pages\": \"\"\n },\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "10492548-ef8f-482d-bad2-af658809c49d", "name": "Missing or invalid query parameters", "originalRequest": { "url": { "path": [ "v1", "instruments", "search" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Search term applied case-insensitively to ticker symbols, alternate identifiers (CUSIP, ISIN, OPRA root), and company names for non-option instruments. Option searches match symbols and alternate identifiers.", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Comma-separated asset classes (EQUITY|OPTION|WARRANT|BOND|FX|OTHER). Defaults to EQUITY.", "type": "text/plain" }, "key": "asset_class", "value": "" }, { "disabled": false, "description": { "content": "Include inactive instruments. Default false.", "type": "text/plain" }, "key": "include_inactive", "value": "" }, { "disabled": false, "description": { "content": "Include publicly traded partnership (PTP) instruments. Default true (penalized in ranking).", "type": "text/plain" }, "key": "include_ptp", "value": "" }, { "disabled": false, "description": { "content": "Optional ISO currency filter (e.g., USD).", "type": "text/plain" }, "key": "currency", "value": "" }, { "disabled": false, "description": { "content": "Optional listing-country filter (e.g., US).", "type": "text/plain" }, "key": "country", "value": "" }, { "disabled": false, "description": { "content": "The number of items to return per page. Only used when page_token is not provided.", "type": "text/plain" }, "key": "page_size", "value": "100" }, { "disabled": false, "description": { "content": "Token for retrieving the next or previous page of results. Contains encoded pagination state; when provided, page_size is ignored.", "type": "text/plain" }, "key": "page_token", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"sunt_f\": false,\n \"magnae59\": 67421727\n },\n {\n \"minim48\": false,\n \"fugiat94d\": -43856089.03091218\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "18d943dc-30af-46eb-a6e4-2efa2bc695a8", "name": "Internal server error", "originalRequest": { "url": { "path": [ "v1", "instruments", "search" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Search term applied case-insensitively to ticker symbols, alternate identifiers (CUSIP, ISIN, OPRA root), and company names for non-option instruments. Option searches match symbols and alternate identifiers.", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Comma-separated asset classes (EQUITY|OPTION|WARRANT|BOND|FX|OTHER). Defaults to EQUITY.", "type": "text/plain" }, "key": "asset_class", "value": "" }, { "disabled": false, "description": { "content": "Include inactive instruments. Default false.", "type": "text/plain" }, "key": "include_inactive", "value": "" }, { "disabled": false, "description": { "content": "Include publicly traded partnership (PTP) instruments. Default true (penalized in ranking).", "type": "text/plain" }, "key": "include_ptp", "value": "" }, { "disabled": false, "description": { "content": "Optional ISO currency filter (e.g., USD).", "type": "text/plain" }, "key": "currency", "value": "" }, { "disabled": false, "description": { "content": "Optional listing-country filter (e.g., US).", "type": "text/plain" }, "key": "country", "value": "" }, { "disabled": false, "description": { "content": "The number of items to return per page. Only used when page_token is not provided.", "type": "text/plain" }, "key": "page_size", "value": "100" }, { "disabled": false, "description": { "content": "Token for retrieving the next or previous page of results. Contains encoded pagination state; when provided, page_size is ignored.", "type": "text/plain" }, "key": "page_token", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"sunt_f\": false,\n \"magnae59\": 67421727\n },\n {\n \"minim48\": false,\n \"fugiat94d\": -43856089.03091218\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "14038d84-7919-4dee-af41-141b4e7ab5f3", "name": "Instrument data is not ready yet", "originalRequest": { "url": { "path": [ "v1", "instruments", "search" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Search term applied case-insensitively to ticker symbols, alternate identifiers (CUSIP, ISIN, OPRA root), and company names for non-option instruments. Option searches match symbols and alternate identifiers.", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Comma-separated asset classes (EQUITY|OPTION|WARRANT|BOND|FX|OTHER). Defaults to EQUITY.", "type": "text/plain" }, "key": "asset_class", "value": "" }, { "disabled": false, "description": { "content": "Include inactive instruments. Default false.", "type": "text/plain" }, "key": "include_inactive", "value": "" }, { "disabled": false, "description": { "content": "Include publicly traded partnership (PTP) instruments. Default true (penalized in ranking).", "type": "text/plain" }, "key": "include_ptp", "value": "" }, { "disabled": false, "description": { "content": "Optional ISO currency filter (e.g., USD).", "type": "text/plain" }, "key": "currency", "value": "" }, { "disabled": false, "description": { "content": "Optional listing-country filter (e.g., US).", "type": "text/plain" }, "key": "country", "value": "" }, { "disabled": false, "description": { "content": "The number of items to return per page. Only used when page_token is not provided.", "type": "text/plain" }, "key": "page_size", "value": "100" }, { "disabled": false, "description": { "content": "Token for retrieving the next or previous page of results. Contains encoded pagination state; when provided, page_size is ignored.", "type": "text/plain" }, "key": "page_token", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"sunt_f\": false,\n \"magnae59\": 67421727\n },\n {\n \"minim48\": false,\n \"fugiat94d\": -43856089.03091218\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "673ecff8-e3fb-46a5-8138-48434abf2163", "name": "Get Instrument By ID", "request": { "name": "Get Instrument By ID", "description": { "content": "Retrieves detailed information for a specific instrument.", "type": "text/plain" }, "url": { "path": [ "v1", "instruments", ":instrument_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "When true, include unique options expiry dates for this instrument", "type": "text/plain" }, "key": "include_options_expiry_dates", "value": "" } ], "variable": [ { "type": "any", "value": "", "key": "instrument_id", "disabled": false, "description": { "content": "(Required) Instrument ID (UUID) or symbol (equity ticker or OSI option symbol).", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "8f57a6cd-9ba7-4657-ab20-32a174c51cf2", "name": "Instrument details", "originalRequest": { "url": { "path": [ "v1", "instruments", ":instrument_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "When true, include unique options expiry dates for this instrument", "type": "text/plain" }, "key": "include_options_expiry_dates", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"\",\n \"symbol\": \"\",\n \"venue\": \"\",\n \"country_of_issue\": \"\",\n \"currency\": \"\",\n \"is_marginable\": \"\",\n \"easy_to_borrow\": \"\",\n \"is_short_prohibited\": \"\",\n \"is_threshold_security\": \"\",\n \"is_liquidation_only\": \"\",\n \"is_tradable\": \"\",\n \"is_fractionable\": \"\",\n \"is_ptp\": \"\",\n \"adv\": \"\",\n \"cax_adjusted_previous_close\": \"\",\n \"instrument_type\": \"\",\n \"long_margin_rate\": \"\",\n \"name\": \"\",\n \"notional_adv\": \"\",\n \"previous_close\": \"\",\n \"short_margin_rate\": \"\",\n \"tick_rules\": [\n {\n \"start_price\": \"\",\n \"tick_size\": \"\",\n \"end_price\": \"\"\n },\n {\n \"start_price\": \"\",\n \"tick_size\": \"\",\n \"end_price\": \"\"\n }\n ],\n \"options_contract_expiry_dates\": null,\n \"options_expiry_dates\": null\n },\n \"metadata\": {\n \"request_id\": \"\",\n \"next_page_token\": \"\",\n \"page_number\": \"\",\n \"previous_page_token\": \"\",\n \"total_items\": \"\",\n \"total_pages\": \"\"\n },\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "814a646e-25d8-4996-a871-a697f7566b72", "name": "Instrument not found", "originalRequest": { "url": { "path": [ "v1", "instruments", ":instrument_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "When true, include unique options expiry dates for this instrument", "type": "text/plain" }, "key": "include_options_expiry_dates", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"sunt_f\": false,\n \"magnae59\": 67421727\n },\n {\n \"minim48\": false,\n \"fugiat94d\": -43856089.03091218\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "38e82726-8a23-411b-876c-7160a24026f1", "name": "Internal server error", "originalRequest": { "url": { "path": [ "v1", "instruments", ":instrument_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "When true, include unique options expiry dates for this instrument", "type": "text/plain" }, "key": "include_options_expiry_dates", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"sunt_f\": false,\n \"magnae59\": 67421727\n },\n {\n \"minim48\": false,\n \"fugiat94d\": -43856089.03091218\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Instrument Data", "description": "Retrieve instrument analytics, market data, news, and related reference data.", "item": [ { "id": "229cd3bd-7d8a-4e75-a78b-009f9c1bac2b", "name": "Get All Instrument Events", "request": { "name": "Get All Instrument Events", "description": { "content": "List instrument events across all securities, grouped by date. Results are\npaginated via `page_size` / `page_token`; a date's events may span two pages.\n\nDate range defaults (anchored on the current trading day, or the next trading day\nif today is a weekend or US market holiday):\n- Unfiltered (no `instrument_ids`): a single trading day\n (`from_date` = `to_date` = anchor). If only one bound is given, the other\n defaults to 6 days from it; there is no maximum span once both bounds are given.\n- Filtered (with `instrument_ids`): a 30-day lookback ending on the anchor\n (`from_date` = anchor − 30 days, `to_date` = anchor).\n\nPagination metadata does not include `total_items` or `total_pages` for this\nendpoint. Use `next_page_token` to detect whether more results exist.", "type": "text/plain" }, "url": { "path": [ "v1", "instruments", "events" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter by event type(s). Comma-delimited list. Example: `event_types=EARNINGS,IPO`.", "type": "text/plain" }, "key": "event_types", "value": "EARNINGS,DIVIDEND" }, { "disabled": false, "description": { "content": "Filter by instrument. Comma-separated instrument IDs (UUID) or symbols (equity tickers or OSI option symbols). Example: `instrument_ids=550e8400-e29b-41d4-a716-446655440000,AAPL`.", "type": "text/plain" }, "key": "instrument_ids", "value": "," }, { "disabled": false, "description": { "content": "The start date for the query range, inclusive (YYYY-MM-DD).", "type": "text/plain" }, "key": "from_date", "value": "" }, { "disabled": false, "description": { "content": "The end date for the query range, inclusive (YYYY-MM-DD).", "type": "text/plain" }, "key": "to_date", "value": "" }, { "disabled": false, "description": { "content": "The number of items to return per page. Only used when page_token is not provided.", "type": "text/plain" }, "key": "page_size", "value": "1000" }, { "disabled": false, "description": { "content": "Token for retrieving the next or previous page of results. Contains encoded pagination state; when provided, page_size is ignored.", "type": "text/plain" }, "key": "page_token", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "20a6d8bb-e02d-4b00-acdc-93d9381b593c", "name": "Instrument events grouped by date", "originalRequest": { "url": { "path": [ "v1", "instruments", "events" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter by event type(s). Comma-delimited list. Example: `event_types=EARNINGS,IPO`.", "type": "text/plain" }, "key": "event_types", "value": "EARNINGS,DIVIDEND" }, { "disabled": false, "description": { "content": "Filter by instrument. Comma-separated instrument IDs (UUID) or symbols (equity tickers or OSI option symbols). Example: `instrument_ids=550e8400-e29b-41d4-a716-446655440000,AAPL`.", "type": "text/plain" }, "key": "instrument_ids", "value": "," }, { "disabled": false, "description": { "content": "The start date for the query range, inclusive (YYYY-MM-DD).", "type": "text/plain" }, "key": "from_date", "value": "" }, { "disabled": false, "description": { "content": "The end date for the query range, inclusive (YYYY-MM-DD).", "type": "text/plain" }, "key": "to_date", "value": "" }, { "disabled": false, "description": { "content": "The number of items to return per page. Only used when page_token is not provided.", "type": "text/plain" }, "key": "page_size", "value": "1000" }, { "disabled": false, "description": { "content": "Token for retrieving the next or previous page of results. Contains encoded pagination state; when provided, page_size is ignored.", "type": "text/plain" }, "key": "page_token", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"event_dates\": [\n {\n \"date\": \"\",\n \"events\": [\n {\n \"type\": \"DIVIDEND\",\n \"symbol\": \"\",\n \"dividend_event_data\": \"\",\n \"earnings_event_data\": \"\",\n \"instrument_id\": \"\",\n \"ipo_event_data\": \"\",\n \"name\": \"\",\n \"reporting_currency\": \"\",\n \"stock_split_event_data\": \"\"\n },\n {\n \"type\": \"EARNINGS\",\n \"symbol\": \"\",\n \"dividend_event_data\": \"\",\n \"earnings_event_data\": \"\",\n \"instrument_id\": \"\",\n \"ipo_event_data\": \"\",\n \"name\": \"\",\n \"reporting_currency\": \"\",\n \"stock_split_event_data\": \"\"\n }\n ]\n },\n {\n \"date\": \"\",\n \"events\": [\n {\n \"type\": \"STOCK_SPLIT\",\n \"symbol\": \"\",\n \"dividend_event_data\": \"\",\n \"earnings_event_data\": \"\",\n \"instrument_id\": \"\",\n \"ipo_event_data\": \"\",\n \"name\": \"\",\n \"reporting_currency\": \"\",\n \"stock_split_event_data\": \"\"\n },\n {\n \"type\": \"IPO\",\n \"symbol\": \"\",\n \"dividend_event_data\": \"\",\n \"earnings_event_data\": \"\",\n \"instrument_id\": \"\",\n \"ipo_event_data\": \"\",\n \"name\": \"\",\n \"reporting_currency\": \"\",\n \"stock_split_event_data\": \"\"\n }\n ]\n }\n ]\n },\n \"metadata\": {\n \"request_id\": \"\",\n \"next_page_token\": \"\",\n \"page_number\": \"\",\n \"previous_page_token\": \"\",\n \"total_items\": \"\",\n \"total_pages\": \"\"\n },\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d5369161-6737-48f4-938c-27cc2e726bb6", "name": "Invalid query parameters", "originalRequest": { "url": { "path": [ "v1", "instruments", "events" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter by event type(s). Comma-delimited list. Example: `event_types=EARNINGS,IPO`.", "type": "text/plain" }, "key": "event_types", "value": "EARNINGS,DIVIDEND" }, { "disabled": false, "description": { "content": "Filter by instrument. Comma-separated instrument IDs (UUID) or symbols (equity tickers or OSI option symbols). Example: `instrument_ids=550e8400-e29b-41d4-a716-446655440000,AAPL`.", "type": "text/plain" }, "key": "instrument_ids", "value": "," }, { "disabled": false, "description": { "content": "The start date for the query range, inclusive (YYYY-MM-DD).", "type": "text/plain" }, "key": "from_date", "value": "" }, { "disabled": false, "description": { "content": "The end date for the query range, inclusive (YYYY-MM-DD).", "type": "text/plain" }, "key": "to_date", "value": "" }, { "disabled": false, "description": { "content": "The number of items to return per page. Only used when page_token is not provided.", "type": "text/plain" }, "key": "page_size", "value": "1000" }, { "disabled": false, "description": { "content": "Token for retrieving the next or previous page of results. Contains encoded pagination state; when provided, page_size is ignored.", "type": "text/plain" }, "key": "page_token", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"sunt_f\": false,\n \"magnae59\": 67421727\n },\n {\n \"minim48\": false,\n \"fugiat94d\": -43856089.03091218\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ffc06b20-6f61-44f0-8b52-82fd446bbb1c", "name": "Internal server error", "originalRequest": { "url": { "path": [ "v1", "instruments", "events" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter by event type(s). Comma-delimited list. Example: `event_types=EARNINGS,IPO`.", "type": "text/plain" }, "key": "event_types", "value": "EARNINGS,DIVIDEND" }, { "disabled": false, "description": { "content": "Filter by instrument. Comma-separated instrument IDs (UUID) or symbols (equity tickers or OSI option symbols). Example: `instrument_ids=550e8400-e29b-41d4-a716-446655440000,AAPL`.", "type": "text/plain" }, "key": "instrument_ids", "value": "," }, { "disabled": false, "description": { "content": "The start date for the query range, inclusive (YYYY-MM-DD).", "type": "text/plain" }, "key": "from_date", "value": "" }, { "disabled": false, "description": { "content": "The end date for the query range, inclusive (YYYY-MM-DD).", "type": "text/plain" }, "key": "to_date", "value": "" }, { "disabled": false, "description": { "content": "The number of items to return per page. Only used when page_token is not provided.", "type": "text/plain" }, "key": "page_size", "value": "1000" }, { "disabled": false, "description": { "content": "Token for retrieving the next or previous page of results. Contains encoded pagination state; when provided, page_size is ignored.", "type": "text/plain" }, "key": "page_token", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"sunt_f\": false,\n \"magnae59\": 67421727\n },\n {\n \"minim48\": false,\n \"fugiat94d\": -43856089.03091218\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c644c261-dd5b-4f83-ab27-5f72dd646d81", "name": "Get Instrument Analyst Consensus", "request": { "name": "Get Instrument Analyst Consensus", "description": { "content": "Retrieves analyst ratings and price targets for an instrument.", "type": "text/plain" }, "url": { "path": [ "v1", "instruments", ":instrument_id", "analyst-reporting" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The start date for the query range, inclusive (YYYY-MM-DD)", "type": "text/plain" }, "key": "from", "value": "" }, { "disabled": false, "description": { "content": "The end date for the query range, inclusive (YYYY-MM-DD)", "type": "text/plain" }, "key": "to", "value": "" } ], "variable": [ { "type": "any", "value": "", "key": "instrument_id", "disabled": false, "description": { "content": "(Required) Instrument ID (UUID) or symbol (equity ticker or OSI option symbol).", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "c9f07d51-3eb2-4d92-aefd-cf729ad75388", "name": "Analyst consensus data", "originalRequest": { "url": { "path": [ "v1", "instruments", ":instrument_id", "analyst-reporting" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The start date for the query range, inclusive (YYYY-MM-DD)", "type": "text/plain" }, "key": "from", "value": "" }, { "disabled": false, "description": { "content": "The end date for the query range, inclusive (YYYY-MM-DD)", "type": "text/plain" }, "key": "to", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"date\": \"\",\n \"distribution\": \"\",\n \"price_target\": \"\",\n \"rating\": \"\"\n },\n \"metadata\": {\n \"request_id\": \"\",\n \"next_page_token\": \"\",\n \"page_number\": \"\",\n \"previous_page_token\": \"\",\n \"total_items\": \"\",\n \"total_pages\": \"\"\n },\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9bbd7327-b6a3-46ff-97c1-c7ffc85fc57e", "name": "Instrument not found", "originalRequest": { "url": { "path": [ "v1", "instruments", ":instrument_id", "analyst-reporting" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The start date for the query range, inclusive (YYYY-MM-DD)", "type": "text/plain" }, "key": "from", "value": "" }, { "disabled": false, "description": { "content": "The end date for the query range, inclusive (YYYY-MM-DD)", "type": "text/plain" }, "key": "to", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"sunt_f\": false,\n \"magnae59\": 67421727\n },\n {\n \"minim48\": false,\n \"fugiat94d\": -43856089.03091218\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6412f4d4-1167-4cd2-83c2-e7c0e40e7e65", "name": "Internal server error", "originalRequest": { "url": { "path": [ "v1", "instruments", ":instrument_id", "analyst-reporting" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The start date for the query range, inclusive (YYYY-MM-DD)", "type": "text/plain" }, "key": "from", "value": "" }, { "disabled": false, "description": { "content": "The end date for the query range, inclusive (YYYY-MM-DD)", "type": "text/plain" }, "key": "to", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"sunt_f\": false,\n \"magnae59\": 67421727\n },\n {\n \"minim48\": false,\n \"fugiat94d\": -43856089.03091218\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d7405a02-f320-4888-a898-2bfb2554c5c4", "name": "Get Instrument Balance Sheet Statements", "request": { "name": "Get Instrument Balance Sheet Statements", "description": { "content": "Get balance sheet statements for an instrument.\n\nRetrieves quarterly balance sheet statements for a specific instrument, sorted by fiscal period\n(most recent first).\n\nDate range defaults:\n- `from_date`: None (no lower bound)\n- `to_date`: None (no upper bound)\n\nPagination metadata does not include `total_items` or `total_pages` for this\nendpoint. Use `next_page_token` to detect whether more results exist.", "type": "text/plain" }, "url": { "path": [ "v1", "instruments", ":instrument_id", "balance-sheets" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The number of items to return per page. Only used when page_token is not provided.", "type": "text/plain" }, "key": "page_size", "value": "1000" }, { "disabled": false, "description": { "content": "Token for retrieving the next or previous page of results. Contains encoded pagination state; when provided, page_size is ignored.", "type": "text/plain" }, "key": "page_token", "value": "" }, { "disabled": false, "description": { "content": "The start date for the query range, inclusive (YYYY-MM-DD).", "type": "text/plain" }, "key": "from_date", "value": "" }, { "disabled": false, "description": { "content": "The end date for the query range, inclusive (YYYY-MM-DD).", "type": "text/plain" }, "key": "to_date", "value": "" } ], "variable": [ { "type": "any", "value": "", "key": "instrument_id", "disabled": false, "description": { "content": "(Required) Instrument ID (UUID) or symbol (equity ticker or OSI option symbol).", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "95665d40-e3ee-476a-8db8-e0f503ec56fc", "name": "List of quarterly balance sheet statements", "originalRequest": { "url": { "path": [ "v1", "instruments", ":instrument_id", "balance-sheets" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The number of items to return per page. Only used when page_token is not provided.", "type": "text/plain" }, "key": "page_size", "value": "1000" }, { "disabled": false, "description": { "content": "Token for retrieving the next or previous page of results. Contains encoded pagination state; when provided, page_size is ignored.", "type": "text/plain" }, "key": "page_token", "value": "" }, { "disabled": false, "description": { "content": "The start date for the query range, inclusive (YYYY-MM-DD).", "type": "text/plain" }, "key": "from_date", "value": "" }, { "disabled": false, "description": { "content": "The end date for the query range, inclusive (YYYY-MM-DD).", "type": "text/plain" }, "key": "to_date", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"reported_currency\": \"\",\n \"filing_date\": \"\",\n \"accepted_date\": \"\",\n \"year\": \"\",\n \"period\": \"\",\n \"period_type\": \"QUARTERLY\",\n \"account_payables\": \"\",\n \"accounts_receivables\": \"\",\n \"accrued_expenses\": \"\",\n \"accumulated_other_comprehensive_income_loss\": \"\",\n \"additional_paid_in_capital\": \"\",\n \"capital_lease_obligations\": \"\",\n \"capital_lease_obligations_current\": \"\",\n \"cash_and_cash_equivalents\": \"\",\n \"cash_and_short_term_investments\": \"\",\n \"common_stock\": \"\",\n \"deferred_revenue\": \"\",\n \"deferred_revenue_non_current\": \"\",\n \"deferred_tax_liabilities_non_current\": \"\",\n \"goodwill\": \"\",\n \"goodwill_and_intangible_assets\": \"\",\n \"intangible_assets\": \"\",\n \"inventory\": \"\",\n \"long_term_debt\": \"\",\n \"long_term_investments\": \"\",\n \"minority_interest\": \"\",\n \"net_debt\": \"\",\n \"net_receivables\": \"\",\n \"other_assets\": \"\",\n \"other_current_assets\": \"\",\n \"other_current_liabilities\": \"\",\n \"other_liabilities\": \"\",\n \"other_non_current_assets\": \"\",\n \"other_non_current_liabilities\": \"\",\n \"other_payables\": \"\",\n \"other_receivables\": \"\",\n \"other_total_stockholders_equity\": \"\",\n \"preferred_stock\": \"\",\n \"prepaids\": \"\",\n \"property_plant_and_equipment_net\": \"\",\n \"retained_earnings\": \"\",\n \"short_term_debt\": \"\",\n \"short_term_investments\": \"\",\n \"tax_assets\": \"\",\n \"tax_payables\": \"\",\n \"total_assets\": \"\",\n \"total_current_assets\": \"\",\n \"total_current_liabilities\": \"\",\n \"total_debt\": \"\",\n \"total_equity\": \"\",\n \"total_investments\": \"\",\n \"total_liabilities\": \"\",\n \"total_liabilities_and_total_equity\": \"\",\n \"total_non_current_assets\": \"\",\n \"total_non_current_liabilities\": \"\",\n \"total_payables\": \"\",\n \"total_stockholders_equity\": \"\",\n \"treasury_stock\": \"\"\n },\n {\n \"reported_currency\": \"\",\n \"filing_date\": \"\",\n \"accepted_date\": \"\",\n \"year\": \"\",\n \"period\": \"\",\n \"period_type\": \"BIANNUAL\",\n \"account_payables\": \"\",\n \"accounts_receivables\": \"\",\n \"accrued_expenses\": \"\",\n \"accumulated_other_comprehensive_income_loss\": \"\",\n \"additional_paid_in_capital\": \"\",\n \"capital_lease_obligations\": \"\",\n \"capital_lease_obligations_current\": \"\",\n \"cash_and_cash_equivalents\": \"\",\n \"cash_and_short_term_investments\": \"\",\n \"common_stock\": \"\",\n \"deferred_revenue\": \"\",\n \"deferred_revenue_non_current\": \"\",\n \"deferred_tax_liabilities_non_current\": \"\",\n \"goodwill\": \"\",\n \"goodwill_and_intangible_assets\": \"\",\n \"intangible_assets\": \"\",\n \"inventory\": \"\",\n \"long_term_debt\": \"\",\n \"long_term_investments\": \"\",\n \"minority_interest\": \"\",\n \"net_debt\": \"\",\n \"net_receivables\": \"\",\n \"other_assets\": \"\",\n \"other_current_assets\": \"\",\n \"other_current_liabilities\": \"\",\n \"other_liabilities\": \"\",\n \"other_non_current_assets\": \"\",\n \"other_non_current_liabilities\": \"\",\n \"other_payables\": \"\",\n \"other_receivables\": \"\",\n \"other_total_stockholders_equity\": \"\",\n \"preferred_stock\": \"\",\n \"prepaids\": \"\",\n \"property_plant_and_equipment_net\": \"\",\n \"retained_earnings\": \"\",\n \"short_term_debt\": \"\",\n \"short_term_investments\": \"\",\n \"tax_assets\": \"\",\n \"tax_payables\": \"\",\n \"total_assets\": \"\",\n \"total_current_assets\": \"\",\n \"total_current_liabilities\": \"\",\n \"total_debt\": \"\",\n \"total_equity\": \"\",\n \"total_investments\": \"\",\n \"total_liabilities\": \"\",\n \"total_liabilities_and_total_equity\": \"\",\n \"total_non_current_assets\": \"\",\n \"total_non_current_liabilities\": \"\",\n \"total_payables\": \"\",\n \"total_stockholders_equity\": \"\",\n \"treasury_stock\": \"\"\n }\n ],\n \"metadata\": {\n \"request_id\": \"\",\n \"next_page_token\": \"\",\n \"page_number\": \"\",\n \"previous_page_token\": \"\",\n \"total_items\": \"\",\n \"total_pages\": \"\"\n },\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e767405a-ded7-4ea2-9d81-697860057b6b", "name": "Instrument not found", "originalRequest": { "url": { "path": [ "v1", "instruments", ":instrument_id", "balance-sheets" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The number of items to return per page. Only used when page_token is not provided.", "type": "text/plain" }, "key": "page_size", "value": "1000" }, { "disabled": false, "description": { "content": "Token for retrieving the next or previous page of results. Contains encoded pagination state; when provided, page_size is ignored.", "type": "text/plain" }, "key": "page_token", "value": "" }, { "disabled": false, "description": { "content": "The start date for the query range, inclusive (YYYY-MM-DD).", "type": "text/plain" }, "key": "from_date", "value": "" }, { "disabled": false, "description": { "content": "The end date for the query range, inclusive (YYYY-MM-DD).", "type": "text/plain" }, "key": "to_date", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"sunt_f\": false,\n \"magnae59\": 67421727\n },\n {\n \"minim48\": false,\n \"fugiat94d\": -43856089.03091218\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "385976ca-612c-4d71-9998-344cbdb380aa", "name": "Internal server error", "originalRequest": { "url": { "path": [ "v1", "instruments", ":instrument_id", "balance-sheets" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The number of items to return per page. Only used when page_token is not provided.", "type": "text/plain" }, "key": "page_size", "value": "1000" }, { "disabled": false, "description": { "content": "Token for retrieving the next or previous page of results. Contains encoded pagination state; when provided, page_size is ignored.", "type": "text/plain" }, "key": "page_token", "value": "" }, { "disabled": false, "description": { "content": "The start date for the query range, inclusive (YYYY-MM-DD).", "type": "text/plain" }, "key": "from_date", "value": "" }, { "disabled": false, "description": { "content": "The end date for the query range, inclusive (YYYY-MM-DD).", "type": "text/plain" }, "key": "to_date", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"sunt_f\": false,\n \"magnae59\": 67421727\n },\n {\n \"minim48\": false,\n \"fugiat94d\": -43856089.03091218\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ed820fc1-a73a-4fad-93eb-bf0c8eb63e8b", "name": "Get Instrument Cash Flow Statements", "request": { "name": "Get Instrument Cash Flow Statements", "description": { "content": "Get cash flow statements for an instrument.\n\nRetrieves historical cash flow statements for the specified instrument.\nCash flow statements show cash inflows and outflows from operating, investing,\nand financing activities.\n\nPagination metadata does not include `total_items` or `total_pages` for this\nendpoint. Use `next_page_token` to detect whether more results exist.", "type": "text/plain" }, "url": { "path": [ "v1", "instruments", ":instrument_id", "cash-flow-statements" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The number of items to return per page. Only used when page_token is not provided.", "type": "text/plain" }, "key": "page_size", "value": "1000" }, { "disabled": false, "description": { "content": "Token for retrieving the next or previous page of results. Contains encoded pagination state; when provided, page_size is ignored.", "type": "text/plain" }, "key": "page_token", "value": "" }, { "disabled": false, "description": { "content": "The start date for the query range, inclusive (YYYY-MM-DD).", "type": "text/plain" }, "key": "from_date", "value": "" }, { "disabled": false, "description": { "content": "The end date for the query range, inclusive (YYYY-MM-DD).", "type": "text/plain" }, "key": "to_date", "value": "" } ], "variable": [ { "type": "any", "value": "", "key": "instrument_id", "disabled": false, "description": { "content": "(Required) Instrument ID (UUID) or symbol (equity ticker or OSI option symbol).", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "beef8c52-d79a-4455-8e24-60a98bdaed49", "name": "Cash flow statements retrieved successfully", "originalRequest": { "url": { "path": [ "v1", "instruments", ":instrument_id", "cash-flow-statements" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The number of items to return per page. Only used when page_token is not provided.", "type": "text/plain" }, "key": "page_size", "value": "1000" }, { "disabled": false, "description": { "content": "Token for retrieving the next or previous page of results. Contains encoded pagination state; when provided, page_size is ignored.", "type": "text/plain" }, "key": "page_token", "value": "" }, { "disabled": false, "description": { "content": "The start date for the query range, inclusive (YYYY-MM-DD).", "type": "text/plain" }, "key": "from_date", "value": "" }, { "disabled": false, "description": { "content": "The end date for the query range, inclusive (YYYY-MM-DD).", "type": "text/plain" }, "key": "to_date", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"reported_currency\": \"\",\n \"filing_date\": \"\",\n \"accepted_date\": \"\",\n \"year\": \"\",\n \"period\": \"\",\n \"period_type\": \"TTM\",\n \"accounts_payables\": \"\",\n \"accounts_receivables\": \"\",\n \"acquisitions_net\": \"\",\n \"capital_expenditure\": \"\",\n \"cash_at_beginning_of_period\": \"\",\n \"cash_at_end_of_period\": \"\",\n \"change_in_working_capital\": \"\",\n \"common_dividends_paid\": \"\",\n \"common_stock_issuance\": \"\",\n \"common_stock_repurchased\": \"\",\n \"deferred_income_tax\": \"\",\n \"depreciation_and_amortization\": \"\",\n \"effect_of_forex_changes_on_cash\": \"\",\n \"free_cash_flow\": \"\",\n \"income_taxes_paid\": \"\",\n \"interest_paid\": \"\",\n \"inventory\": \"\",\n \"investments_in_property_plant_and_equipment\": \"\",\n \"long_term_net_debt_issuance\": \"\",\n \"net_cash_provided_by_financing_activities\": \"\",\n \"net_cash_provided_by_investing_activities\": \"\",\n \"net_cash_provided_by_operating_activities\": \"\",\n \"net_change_in_cash\": \"\",\n \"net_common_stock_issuance\": \"\",\n \"net_debt_issuance\": \"\",\n \"net_dividends_paid\": \"\",\n \"net_income\": \"\",\n \"net_preferred_stock_issuance\": \"\",\n \"net_stock_issuance\": \"\",\n \"operating_cash_flow\": \"\",\n \"other_financing_activities\": \"\",\n \"other_investing_activities\": \"\",\n \"other_non_cash_items\": \"\",\n \"other_working_capital\": \"\",\n \"preferred_dividends_paid\": \"\",\n \"purchases_of_investments\": \"\",\n \"sales_maturities_of_investments\": \"\",\n \"short_term_net_debt_issuance\": \"\",\n \"stock_based_compensation\": \"\"\n },\n {\n \"reported_currency\": \"\",\n \"filing_date\": \"\",\n \"accepted_date\": \"\",\n \"year\": \"\",\n \"period\": \"\",\n \"period_type\": \"ANNUAL\",\n \"accounts_payables\": \"\",\n \"accounts_receivables\": \"\",\n \"acquisitions_net\": \"\",\n \"capital_expenditure\": \"\",\n \"cash_at_beginning_of_period\": \"\",\n \"cash_at_end_of_period\": \"\",\n \"change_in_working_capital\": \"\",\n \"common_dividends_paid\": \"\",\n \"common_stock_issuance\": \"\",\n \"common_stock_repurchased\": \"\",\n \"deferred_income_tax\": \"\",\n \"depreciation_and_amortization\": \"\",\n \"effect_of_forex_changes_on_cash\": \"\",\n \"free_cash_flow\": \"\",\n \"income_taxes_paid\": \"\",\n \"interest_paid\": \"\",\n \"inventory\": \"\",\n \"investments_in_property_plant_and_equipment\": \"\",\n \"long_term_net_debt_issuance\": \"\",\n \"net_cash_provided_by_financing_activities\": \"\",\n \"net_cash_provided_by_investing_activities\": \"\",\n \"net_cash_provided_by_operating_activities\": \"\",\n \"net_change_in_cash\": \"\",\n \"net_common_stock_issuance\": \"\",\n \"net_debt_issuance\": \"\",\n \"net_dividends_paid\": \"\",\n \"net_income\": \"\",\n \"net_preferred_stock_issuance\": \"\",\n \"net_stock_issuance\": \"\",\n \"operating_cash_flow\": \"\",\n \"other_financing_activities\": \"\",\n \"other_investing_activities\": \"\",\n \"other_non_cash_items\": \"\",\n \"other_working_capital\": \"\",\n \"preferred_dividends_paid\": \"\",\n \"purchases_of_investments\": \"\",\n \"sales_maturities_of_investments\": \"\",\n \"short_term_net_debt_issuance\": \"\",\n \"stock_based_compensation\": \"\"\n }\n ],\n \"metadata\": {\n \"request_id\": \"\",\n \"next_page_token\": \"\",\n \"page_number\": \"\",\n \"previous_page_token\": \"\",\n \"total_items\": \"\",\n \"total_pages\": \"\"\n },\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ee0088e2-d611-432a-a329-1a3fb2ff7bd2", "name": "Instrument not found", "originalRequest": { "url": { "path": [ "v1", "instruments", ":instrument_id", "cash-flow-statements" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The number of items to return per page. Only used when page_token is not provided.", "type": "text/plain" }, "key": "page_size", "value": "1000" }, { "disabled": false, "description": { "content": "Token for retrieving the next or previous page of results. Contains encoded pagination state; when provided, page_size is ignored.", "type": "text/plain" }, "key": "page_token", "value": "" }, { "disabled": false, "description": { "content": "The start date for the query range, inclusive (YYYY-MM-DD).", "type": "text/plain" }, "key": "from_date", "value": "" }, { "disabled": false, "description": { "content": "The end date for the query range, inclusive (YYYY-MM-DD).", "type": "text/plain" }, "key": "to_date", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"sunt_f\": false,\n \"magnae59\": 67421727\n },\n {\n \"minim48\": false,\n \"fugiat94d\": -43856089.03091218\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a00eae78-bad3-4bfc-9e99-8445e59751ce", "name": "Internal server error", "originalRequest": { "url": { "path": [ "v1", "instruments", ":instrument_id", "cash-flow-statements" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The number of items to return per page. Only used when page_token is not provided.", "type": "text/plain" }, "key": "page_size", "value": "1000" }, { "disabled": false, "description": { "content": "Token for retrieving the next or previous page of results. Contains encoded pagination state; when provided, page_size is ignored.", "type": "text/plain" }, "key": "page_token", "value": "" }, { "disabled": false, "description": { "content": "The start date for the query range, inclusive (YYYY-MM-DD).", "type": "text/plain" }, "key": "from_date", "value": "" }, { "disabled": false, "description": { "content": "The end date for the query range, inclusive (YYYY-MM-DD).", "type": "text/plain" }, "key": "to_date", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"sunt_f\": false,\n \"magnae59\": 67421727\n },\n {\n \"minim48\": false,\n \"fugiat94d\": -43856089.03091218\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5556d8e8-ff9c-499f-84fa-c2d95602a5ae", "name": "Get Instrument Events", "request": { "name": "Get Instrument Events", "description": { "content": "Retrieves corporate events (earnings, dividends, splits, IPO) for an instrument, grouped by\nevent type. Filter to specific types via `event_types`.\n\nDate range defaults:\n- `from_date`: today - 365 days\n- `to_date`: today + 60 days", "type": "text/plain" }, "url": { "path": [ "v1", "instruments", ":instrument_id", "events" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter by event type(s). Comma-delimited list. Example: `event_types=EARNINGS,IPO`.", "type": "text/plain" }, "key": "event_types", "value": "EARNINGS,DIVIDEND" }, { "disabled": false, "description": { "content": "The start date for the query range, inclusive (YYYY-MM-DD).", "type": "text/plain" }, "key": "from_date", "value": "" }, { "disabled": false, "description": { "content": "The end date for the query range, inclusive (YYYY-MM-DD).", "type": "text/plain" }, "key": "to_date", "value": "" } ], "variable": [ { "type": "any", "value": "", "key": "instrument_id", "disabled": false, "description": { "content": "(Required) Instrument ID (UUID) or symbol (equity ticker or OSI option symbol).", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "994eaca1-80dd-480a-904d-36eb6db4bc1d", "name": "Instrument events grouped by type", "originalRequest": { "url": { "path": [ "v1", "instruments", ":instrument_id", "events" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter by event type(s). Comma-delimited list. Example: `event_types=EARNINGS,IPO`.", "type": "text/plain" }, "key": "event_types", "value": "EARNINGS,DIVIDEND" }, { "disabled": false, "description": { "content": "The start date for the query range, inclusive (YYYY-MM-DD).", "type": "text/plain" }, "key": "from_date", "value": "" }, { "disabled": false, "description": { "content": "The end date for the query range, inclusive (YYYY-MM-DD).", "type": "text/plain" }, "key": "to_date", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"instrument_id\": \"\",\n \"earnings\": [\n {\n \"date\": \"\",\n \"eps_actual\": \"\",\n \"eps_estimate\": \"\",\n \"eps_surprise_percent\": \"\",\n \"report_time\": \"\",\n \"revenue_actual\": \"\",\n \"revenue_estimate\": \"\",\n \"revenue_surprise_percent\": \"\"\n },\n {\n \"date\": \"\",\n \"eps_actual\": \"\",\n \"eps_estimate\": \"\",\n \"eps_surprise_percent\": \"\",\n \"report_time\": \"\",\n \"revenue_actual\": \"\",\n \"revenue_estimate\": \"\",\n \"revenue_surprise_percent\": \"\"\n }\n ],\n \"dividends\": [\n {\n \"ex_date\": \"\",\n \"adjusted_dividend_amount\": \"\",\n \"declaration_date\": \"\",\n \"dividend_amount\": \"\",\n \"dividend_yield\": \"\",\n \"frequency\": \"\",\n \"payment_date\": \"\",\n \"record_date\": \"\"\n },\n {\n \"ex_date\": \"\",\n \"adjusted_dividend_amount\": \"\",\n \"declaration_date\": \"\",\n \"dividend_amount\": \"\",\n \"dividend_yield\": \"\",\n \"frequency\": \"\",\n \"payment_date\": \"\",\n \"record_date\": \"\"\n }\n ],\n \"splits\": [\n {\n \"date\": \"\",\n \"numerator\": \"\",\n \"denominator\": \"\",\n \"split_type\": \"\"\n },\n {\n \"date\": \"\",\n \"numerator\": \"\",\n \"denominator\": \"\",\n \"split_type\": \"\"\n }\n ],\n \"ipos\": [\n {\n \"date\": \"\",\n \"actions\": \"\",\n \"announced_at\": \"\",\n \"company\": \"\",\n \"exchange\": \"\",\n \"market_cap\": \"\",\n \"price_range\": \"\",\n \"shares\": \"\"\n },\n {\n \"date\": \"\",\n \"actions\": \"\",\n \"announced_at\": \"\",\n \"company\": \"\",\n \"exchange\": \"\",\n \"market_cap\": \"\",\n \"price_range\": \"\",\n \"shares\": \"\"\n }\n ],\n \"reporting_currency\": \"\"\n },\n \"metadata\": {\n \"request_id\": \"\",\n \"next_page_token\": \"\",\n \"page_number\": \"\",\n \"previous_page_token\": \"\",\n \"total_items\": \"\",\n \"total_pages\": \"\"\n },\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d4527e45-203a-4ae7-ab89-c8dcf1c9eeb5", "name": "Instrument not found", "originalRequest": { "url": { "path": [ "v1", "instruments", ":instrument_id", "events" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter by event type(s). Comma-delimited list. Example: `event_types=EARNINGS,IPO`.", "type": "text/plain" }, "key": "event_types", "value": "EARNINGS,DIVIDEND" }, { "disabled": false, "description": { "content": "The start date for the query range, inclusive (YYYY-MM-DD).", "type": "text/plain" }, "key": "from_date", "value": "" }, { "disabled": false, "description": { "content": "The end date for the query range, inclusive (YYYY-MM-DD).", "type": "text/plain" }, "key": "to_date", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"sunt_f\": false,\n \"magnae59\": 67421727\n },\n {\n \"minim48\": false,\n \"fugiat94d\": -43856089.03091218\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5da79097-1c02-414f-930f-97d818350b25", "name": "Internal server error", "originalRequest": { "url": { "path": [ "v1", "instruments", ":instrument_id", "events" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter by event type(s). Comma-delimited list. Example: `event_types=EARNINGS,IPO`.", "type": "text/plain" }, "key": "event_types", "value": "EARNINGS,DIVIDEND" }, { "disabled": false, "description": { "content": "The start date for the query range, inclusive (YYYY-MM-DD).", "type": "text/plain" }, "key": "from_date", "value": "" }, { "disabled": false, "description": { "content": "The end date for the query range, inclusive (YYYY-MM-DD).", "type": "text/plain" }, "key": "to_date", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"sunt_f\": false,\n \"magnae59\": 67421727\n },\n {\n \"minim48\": false,\n \"fugiat94d\": -43856089.03091218\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "588517c5-4056-4721-963f-d3edb2cbff01", "name": "Get Instrument Fundamentals", "request": { "name": "Get Instrument Fundamentals", "description": { "content": "Retrieves supplemental fundamentals and company profile data for an instrument.", "type": "text/plain" }, "url": { "path": [ "v1", "instruments", ":instrument_id", "fundamentals" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "instrument_id", "disabled": false, "description": { "content": "(Required) Instrument ID (UUID) or symbol (equity ticker or OSI option symbol).", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "e630e8fd-76c9-4e10-84e8-2b5eae922329", "name": "Instrument fundamentals", "originalRequest": { "url": { "path": [ "v1", "instruments", ":instrument_id", "fundamentals" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"average_volume\": \"\",\n \"beta\": \"\",\n \"description\": \"\",\n \"dividend_yield\": \"\",\n \"earnings_per_share\": \"\",\n \"fifty_two_week_high\": \"\",\n \"fifty_two_week_low\": \"\",\n \"industry\": \"\",\n \"list_date\": \"\",\n \"logo_url\": \"\",\n \"market_cap\": \"\",\n \"previous_close\": \"\",\n \"price_to_earnings\": \"\",\n \"reporting_currency\": \"\",\n \"sector\": \"\"\n },\n \"metadata\": {\n \"request_id\": \"\",\n \"next_page_token\": \"\",\n \"page_number\": \"\",\n \"previous_page_token\": \"\",\n \"total_items\": \"\",\n \"total_pages\": \"\"\n },\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1f75561f-b6e4-4271-bdd2-f706502e4ccf", "name": "Fundamentals not applicable to this instrument type (e.g. an index)", "originalRequest": { "url": { "path": [ "v1", "instruments", ":instrument_id", "fundamentals" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"sunt_f\": false,\n \"magnae59\": 67421727\n },\n {\n \"minim48\": false,\n \"fugiat94d\": -43856089.03091218\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ad38a004-4866-429f-a878-e3f247121d2d", "name": "Instrument or fundamentals not found", "originalRequest": { "url": { "path": [ "v1", "instruments", ":instrument_id", "fundamentals" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"sunt_f\": false,\n \"magnae59\": 67421727\n },\n {\n \"minim48\": false,\n \"fugiat94d\": -43856089.03091218\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "84a56806-6fd9-4c4b-9a49-856249b3476c", "name": "Internal server error", "originalRequest": { "url": { "path": [ "v1", "instruments", ":instrument_id", "fundamentals" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"sunt_f\": false,\n \"magnae59\": 67421727\n },\n {\n \"minim48\": false,\n \"fugiat94d\": -43856089.03091218\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c945ff1d-2729-42cb-91eb-540a29d042d2", "name": "Get Instrument Income Statements", "request": { "name": "Get Instrument Income Statements", "description": { "content": "Retrieves quarterly income statements for a specific instrument, sorted by fiscal period\n(most recent first).\n\nDate range defaults:\n- `from_date`: None (no lower bound)\n- `to_date`: None (no upper bound)\n\nPagination metadata does not include `total_items` or `total_pages` for this\nendpoint. Use `next_page_token` to detect whether more results exist.", "type": "text/plain" }, "url": { "path": [ "v1", "instruments", ":instrument_id", "income-statements" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The number of items to return per page. Only used when page_token is not provided.", "type": "text/plain" }, "key": "page_size", "value": "1000" }, { "disabled": false, "description": { "content": "Token for retrieving the next or previous page of results. Contains encoded pagination state; when provided, page_size is ignored.", "type": "text/plain" }, "key": "page_token", "value": "" }, { "disabled": false, "description": { "content": "The start date for the query range, inclusive (YYYY-MM-DD).", "type": "text/plain" }, "key": "from_date", "value": "" }, { "disabled": false, "description": { "content": "The end date for the query range, inclusive (YYYY-MM-DD).", "type": "text/plain" }, "key": "to_date", "value": "" } ], "variable": [ { "type": "any", "value": "", "key": "instrument_id", "disabled": false, "description": { "content": "(Required) Instrument ID (UUID) or symbol (equity ticker or OSI option symbol).", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "65af8600-4788-47e5-b262-1362571d91fe", "name": "List of quarterly income statements", "originalRequest": { "url": { "path": [ "v1", "instruments", ":instrument_id", "income-statements" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The number of items to return per page. Only used when page_token is not provided.", "type": "text/plain" }, "key": "page_size", "value": "1000" }, { "disabled": false, "description": { "content": "Token for retrieving the next or previous page of results. Contains encoded pagination state; when provided, page_size is ignored.", "type": "text/plain" }, "key": "page_token", "value": "" }, { "disabled": false, "description": { "content": "The start date for the query range, inclusive (YYYY-MM-DD).", "type": "text/plain" }, "key": "from_date", "value": "" }, { "disabled": false, "description": { "content": "The end date for the query range, inclusive (YYYY-MM-DD).", "type": "text/plain" }, "key": "to_date", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"reported_currency\": \"\",\n \"filing_date\": \"\",\n \"accepted_date\": \"\",\n \"year\": \"\",\n \"period\": \"\",\n \"period_type\": \"TTM\",\n \"bottom_line_net_income\": \"\",\n \"cost_and_expenses\": \"\",\n \"cost_of_revenue\": \"\",\n \"depreciation_and_amortization\": \"\",\n \"ebit\": \"\",\n \"ebitda\": \"\",\n \"eps\": \"\",\n \"eps_diluted\": \"\",\n \"general_and_administrative_expenses\": \"\",\n \"gross_profit\": \"\",\n \"income_before_tax\": \"\",\n \"income_tax_expense\": \"\",\n \"interest_expense\": \"\",\n \"interest_income\": \"\",\n \"net_income\": \"\",\n \"net_income_deductions\": \"\",\n \"net_income_from_continuing_operations\": \"\",\n \"net_income_from_discontinued_operations\": \"\",\n \"net_interest_income\": \"\",\n \"non_operating_income_excluding_interest\": \"\",\n \"operating_expenses\": \"\",\n \"operating_income\": \"\",\n \"other_adjustments_to_net_income\": \"\",\n \"other_expenses\": \"\",\n \"research_and_development_expenses\": \"\",\n \"revenue\": \"\",\n \"selling_and_marketing_expenses\": \"\",\n \"selling_general_and_administrative_expenses\": \"\",\n \"total_other_income_expenses_net\": \"\",\n \"weighted_average_shs_out\": \"\",\n \"weighted_average_shs_out_dil\": \"\"\n },\n {\n \"reported_currency\": \"\",\n \"filing_date\": \"\",\n \"accepted_date\": \"\",\n \"year\": \"\",\n \"period\": \"\",\n \"period_type\": \"QUARTERLY\",\n \"bottom_line_net_income\": \"\",\n \"cost_and_expenses\": \"\",\n \"cost_of_revenue\": \"\",\n \"depreciation_and_amortization\": \"\",\n \"ebit\": \"\",\n \"ebitda\": \"\",\n \"eps\": \"\",\n \"eps_diluted\": \"\",\n \"general_and_administrative_expenses\": \"\",\n \"gross_profit\": \"\",\n \"income_before_tax\": \"\",\n \"income_tax_expense\": \"\",\n \"interest_expense\": \"\",\n \"interest_income\": \"\",\n \"net_income\": \"\",\n \"net_income_deductions\": \"\",\n \"net_income_from_continuing_operations\": \"\",\n \"net_income_from_discontinued_operations\": \"\",\n \"net_interest_income\": \"\",\n \"non_operating_income_excluding_interest\": \"\",\n \"operating_expenses\": \"\",\n \"operating_income\": \"\",\n \"other_adjustments_to_net_income\": \"\",\n \"other_expenses\": \"\",\n \"research_and_development_expenses\": \"\",\n \"revenue\": \"\",\n \"selling_and_marketing_expenses\": \"\",\n \"selling_general_and_administrative_expenses\": \"\",\n \"total_other_income_expenses_net\": \"\",\n \"weighted_average_shs_out\": \"\",\n \"weighted_average_shs_out_dil\": \"\"\n }\n ],\n \"metadata\": {\n \"request_id\": \"\",\n \"next_page_token\": \"\",\n \"page_number\": \"\",\n \"previous_page_token\": \"\",\n \"total_items\": \"\",\n \"total_pages\": \"\"\n },\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3073e6e5-6a93-441a-8c6d-186f4562e043", "name": "Instrument not found", "originalRequest": { "url": { "path": [ "v1", "instruments", ":instrument_id", "income-statements" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The number of items to return per page. Only used when page_token is not provided.", "type": "text/plain" }, "key": "page_size", "value": "1000" }, { "disabled": false, "description": { "content": "Token for retrieving the next or previous page of results. Contains encoded pagination state; when provided, page_size is ignored.", "type": "text/plain" }, "key": "page_token", "value": "" }, { "disabled": false, "description": { "content": "The start date for the query range, inclusive (YYYY-MM-DD).", "type": "text/plain" }, "key": "from_date", "value": "" }, { "disabled": false, "description": { "content": "The end date for the query range, inclusive (YYYY-MM-DD).", "type": "text/plain" }, "key": "to_date", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"sunt_f\": false,\n \"magnae59\": 67421727\n },\n {\n \"minim48\": false,\n \"fugiat94d\": -43856089.03091218\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "59ab38f4-a9e3-46fd-b0c4-3ea56aaaa301", "name": "Internal server error", "originalRequest": { "url": { "path": [ "v1", "instruments", ":instrument_id", "income-statements" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The number of items to return per page. Only used when page_token is not provided.", "type": "text/plain" }, "key": "page_size", "value": "1000" }, { "disabled": false, "description": { "content": "Token for retrieving the next or previous page of results. Contains encoded pagination state; when provided, page_size is ignored.", "type": "text/plain" }, "key": "page_token", "value": "" }, { "disabled": false, "description": { "content": "The start date for the query range, inclusive (YYYY-MM-DD).", "type": "text/plain" }, "key": "from_date", "value": "" }, { "disabled": false, "description": { "content": "The end date for the query range, inclusive (YYYY-MM-DD).", "type": "text/plain" }, "key": "to_date", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"sunt_f\": false,\n \"magnae59\": 67421727\n },\n {\n \"minim48\": false,\n \"fugiat94d\": -43856089.03091218\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "bee6df3c-795d-47a1-bc43-f6e9a6b2cb9d", "name": "Get Daily Aggregate Summaries", "request": { "name": "Get Daily Aggregate Summaries", "description": { "content": "**Deprecated**: use `GET /market-data/snapshot` instead, which now reports\nthe same open/high/low/volume/open-interest fields under `session` and\ntop-level `open_interest`.\n\nReturns the most recent open, high, low, volume (OHLV) and current price\nfor the requested instruments.\n\nResponse contract: every request returns one row per **unique** resolved\n`instrument_id`, in first-seen request order. Resolvable ids with no\navailable data come back with `symbol` populated but market-data fields\n`null`. Ids that fail to resolve are omitted from `data` and reported in\n`error` instead (see the 207/404 responses below).", "type": "text/plain" }, "url": { "path": [ "v1", "market-data", "daily-summary" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Comma-separated instrument identifiers (required, 1..=100)", "type": "text/plain" }, "key": "instrument_ids", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "c06bd826-e74b-48ea-b8f1-1f5c9b4dc6cf", "name": "Daily aggregate summaries", "originalRequest": { "url": { "path": [ "v1", "market-data", "daily-summary" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Comma-separated instrument identifiers (required, 1..=100)", "type": "text/plain" }, "key": "instrument_ids", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"instrument_id\": \"\",\n \"high\": \"\",\n \"low\": \"\",\n \"not_applicable\": \"\",\n \"open\": \"\",\n \"open_interest\": \"\",\n \"symbol\": \"\",\n \"trade_date\": \"\",\n \"volume\": \"\"\n },\n {\n \"instrument_id\": \"\",\n \"high\": \"\",\n \"low\": \"\",\n \"not_applicable\": \"\",\n \"open\": \"\",\n \"open_interest\": \"\",\n \"symbol\": \"\",\n \"trade_date\": \"\",\n \"volume\": \"\"\n }\n ],\n \"metadata\": {\n \"request_id\": \"\",\n \"next_page_token\": \"\",\n \"page_number\": \"\",\n \"previous_page_token\": \"\",\n \"total_items\": \"\",\n \"total_pages\": \"\"\n },\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7fdb66c1-f3f7-42d1-8d0e-4f8e501c858b", "name": "One or more instrument ids failed to be found", "originalRequest": { "url": { "path": [ "v1", "market-data", "daily-summary" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Comma-separated instrument identifiers (required, 1..=100)", "type": "text/plain" }, "key": "instrument_ids", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Multi-Status (WebDAV) (RFC 4918)", "code": 207, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"instrument_id\": \"\",\n \"high\": \"\",\n \"low\": \"\",\n \"not_applicable\": \"\",\n \"open\": \"\",\n \"open_interest\": \"\",\n \"symbol\": \"\",\n \"trade_date\": \"\",\n \"volume\": \"\"\n },\n {\n \"instrument_id\": \"\",\n \"high\": \"\",\n \"low\": \"\",\n \"not_applicable\": \"\",\n \"open\": \"\",\n \"open_interest\": \"\",\n \"symbol\": \"\",\n \"trade_date\": \"\",\n \"volume\": \"\"\n }\n ],\n \"metadata\": {\n \"request_id\": \"\",\n \"next_page_token\": \"\",\n \"page_number\": \"\",\n \"previous_page_token\": \"\",\n \"total_items\": \"\",\n \"total_pages\": \"\"\n },\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6c641a15-9313-4142-9260-767db37fccfc", "name": "Missing, empty, or over-cap instrument_ids", "originalRequest": { "url": { "path": [ "v1", "market-data", "daily-summary" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Comma-separated instrument identifiers (required, 1..=100)", "type": "text/plain" }, "key": "instrument_ids", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"sunt_f\": false,\n \"magnae59\": 67421727\n },\n {\n \"minim48\": false,\n \"fugiat94d\": -43856089.03091218\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "518bfb27-4344-4b1f-b5ff-181a356fdea2", "name": "All instrument ids failed to be found", "originalRequest": { "url": { "path": [ "v1", "market-data", "daily-summary" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Comma-separated instrument identifiers (required, 1..=100)", "type": "text/plain" }, "key": "instrument_ids", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"sunt_f\": false,\n \"magnae59\": 67421727\n },\n {\n \"minim48\": false,\n \"fugiat94d\": -43856089.03091218\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e59fe874-9e01-47a3-ac44-889a8d306f30", "name": "Get Snapshots", "request": { "name": "Get Snapshots", "description": { "content": "Get market data snapshots for one or more securities.", "type": "text/plain" }, "url": { "path": [ "v1", "market-data", "snapshot" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Comma-separated instrument IDs (UUID) or symbols (equity tickers or OSI option symbols). Required; accepts 1 to 100 IDs. Duplicate resolved ids collapse to a single row.", "type": "text/plain" }, "key": "instrument_ids", "value": "," } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "e73fdea4-2df7-4e02-a083-c3b50804923c", "name": "Market data snapshots", "originalRequest": { "url": { "path": [ "v1", "market-data", "snapshot" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Comma-separated instrument IDs (UUID) or symbols (equity tickers or OSI option symbols). Required; accepts 1 to 100 IDs. Duplicate resolved ids collapse to a single row.", "type": "text/plain" }, "key": "instrument_ids", "value": "," } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"instrument_id\": \"\",\n \"symbol\": \"\",\n \"session\": {\n \"ohlv_applicable\": \"\",\n \"change\": \"\",\n \"change_percent\": \"\",\n \"cumulative_volume\": \"\",\n \"high\": \"\",\n \"low\": \"\",\n \"ohlv_date\": \"\",\n \"open\": \"\",\n \"previous_close\": \"\",\n \"previous_close_unadjusted\": \"\"\n },\n \"short_sale_restricted\": \"\",\n \"cumulative_volume\": \"\",\n \"greeks\": \"\",\n \"last_quote\": \"\",\n \"last_trade\": \"\",\n \"name\": \"\",\n \"open_interest\": \"\"\n },\n {\n \"instrument_id\": \"\",\n \"symbol\": \"\",\n \"session\": {\n \"ohlv_applicable\": \"\",\n \"change\": \"\",\n \"change_percent\": \"\",\n \"cumulative_volume\": \"\",\n \"high\": \"\",\n \"low\": \"\",\n \"ohlv_date\": \"\",\n \"open\": \"\",\n \"previous_close\": \"\",\n \"previous_close_unadjusted\": \"\"\n },\n \"short_sale_restricted\": \"\",\n \"cumulative_volume\": \"\",\n \"greeks\": \"\",\n \"last_quote\": \"\",\n \"last_trade\": \"\",\n \"name\": \"\",\n \"open_interest\": \"\"\n }\n ],\n \"metadata\": {\n \"request_id\": \"\",\n \"next_page_token\": \"\",\n \"page_number\": \"\",\n \"previous_page_token\": \"\",\n \"total_items\": \"\",\n \"total_pages\": \"\"\n },\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "273a1944-ebd0-44dd-a0f8-e9d4e823336c", "name": "One or more instrument ids failed to be found", "originalRequest": { "url": { "path": [ "v1", "market-data", "snapshot" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Comma-separated instrument IDs (UUID) or symbols (equity tickers or OSI option symbols). Required; accepts 1 to 100 IDs. Duplicate resolved ids collapse to a single row.", "type": "text/plain" }, "key": "instrument_ids", "value": "," } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Multi-Status (WebDAV) (RFC 4918)", "code": 207, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"instrument_id\": \"\",\n \"symbol\": \"\",\n \"session\": {\n \"ohlv_applicable\": \"\",\n \"change\": \"\",\n \"change_percent\": \"\",\n \"cumulative_volume\": \"\",\n \"high\": \"\",\n \"low\": \"\",\n \"ohlv_date\": \"\",\n \"open\": \"\",\n \"previous_close\": \"\",\n \"previous_close_unadjusted\": \"\"\n },\n \"short_sale_restricted\": \"\",\n \"cumulative_volume\": \"\",\n \"greeks\": \"\",\n \"last_quote\": \"\",\n \"last_trade\": \"\",\n \"name\": \"\",\n \"open_interest\": \"\"\n },\n {\n \"instrument_id\": \"\",\n \"symbol\": \"\",\n \"session\": {\n \"ohlv_applicable\": \"\",\n \"change\": \"\",\n \"change_percent\": \"\",\n \"cumulative_volume\": \"\",\n \"high\": \"\",\n \"low\": \"\",\n \"ohlv_date\": \"\",\n \"open\": \"\",\n \"previous_close\": \"\",\n \"previous_close_unadjusted\": \"\"\n },\n \"short_sale_restricted\": \"\",\n \"cumulative_volume\": \"\",\n \"greeks\": \"\",\n \"last_quote\": \"\",\n \"last_trade\": \"\",\n \"name\": \"\",\n \"open_interest\": \"\"\n }\n ],\n \"metadata\": {\n \"request_id\": \"\",\n \"next_page_token\": \"\",\n \"page_number\": \"\",\n \"previous_page_token\": \"\",\n \"total_items\": \"\",\n \"total_pages\": \"\"\n },\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c8b8a33e-b3fd-4961-b51d-4e15d6ced664", "name": "Invalid, empty, or over-cap instrument_ids", "originalRequest": { "url": { "path": [ "v1", "market-data", "snapshot" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Comma-separated instrument IDs (UUID) or symbols (equity tickers or OSI option symbols). Required; accepts 1 to 100 IDs. Duplicate resolved ids collapse to a single row.", "type": "text/plain" }, "key": "instrument_ids", "value": "," } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"sunt_f\": false,\n \"magnae59\": 67421727\n },\n {\n \"minim48\": false,\n \"fugiat94d\": -43856089.03091218\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e154a076-b6f6-4b0b-ad76-060f4c19ada1", "name": "All instrument ids failed to be found", "originalRequest": { "url": { "path": [ "v1", "market-data", "snapshot" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Comma-separated instrument IDs (UUID) or symbols (equity tickers or OSI option symbols). Required; accepts 1 to 100 IDs. Duplicate resolved ids collapse to a single row.", "type": "text/plain" }, "key": "instrument_ids", "value": "," } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"sunt_f\": false,\n \"magnae59\": 67421727\n },\n {\n \"minim48\": false,\n \"fugiat94d\": -43856089.03091218\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e26a40a3-987a-47d2-8db0-1c1c991e24ae", "name": "Get News", "request": { "name": "Get News", "description": { "content": "Retrieves news items with optional filtering by security IDs, time range, publisher,\ntype, and text query.\n\nPagination metadata does not include `total_items` or `total_pages` for this\nendpoint. Use `next_page_token` to detect whether more results exist.", "type": "text/plain" }, "url": { "path": [ "v1", "news" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The number of items to return per page. Only used when page_token is not provided.", "type": "text/plain" }, "key": "page_size", "value": "1000" }, { "disabled": false, "description": { "content": "Token for retrieving the next or previous page of results. Contains encoded pagination state; when provided, page_size is ignored.", "type": "text/plain" }, "key": "page_token", "value": "" }, { "disabled": false, "description": { "content": "Inclusive start timestamp. Accepts `YYYY-MM-DD` or RFC3339 datetime.", "type": "text/plain" }, "key": "from", "value": "" }, { "disabled": false, "description": { "content": "Inclusive end timestamp. Accepts `YYYY-MM-DD` or RFC3339 datetime.", "type": "text/plain" }, "key": "to", "value": "" }, { "disabled": false, "description": { "content": "Comma-separated list of publishers to include (mutually exclusive with exclude_publishers).", "type": "text/plain" }, "key": "include_publishers", "value": "" }, { "disabled": false, "description": { "content": "Comma-separated list of publishers to exclude (mutually exclusive with include_publishers).", "type": "text/plain" }, "key": "exclude_publishers", "value": "" }, { "disabled": false, "description": { "content": "Filter by news type.", "type": "text/plain" }, "key": "news_type", "value": "PRESS_RELEASE" }, { "disabled": false, "description": { "content": "Free-text query matched against title/text and associated security IDs.", "type": "text/plain" }, "key": "search_query", "value": "" }, { "disabled": false, "description": { "content": "Comma-delimited instrument identifiers to filter by.", "type": "text/plain" }, "key": "instrument_ids", "value": "," }, { "disabled": false, "description": { "content": "Comma-separated sector values to filter by.", "type": "text/plain" }, "key": "sectors", "value": "FINANCIAL_SERVICES,INDUSTRIALS" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "e64e3d6c-a5ee-4a47-8489-051f09c0771a", "name": "News items", "originalRequest": { "url": { "path": [ "v1", "news" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The number of items to return per page. Only used when page_token is not provided.", "type": "text/plain" }, "key": "page_size", "value": "1000" }, { "disabled": false, "description": { "content": "Token for retrieving the next or previous page of results. Contains encoded pagination state; when provided, page_size is ignored.", "type": "text/plain" }, "key": "page_token", "value": "" }, { "disabled": false, "description": { "content": "Inclusive start timestamp. Accepts `YYYY-MM-DD` or RFC3339 datetime.", "type": "text/plain" }, "key": "from", "value": "" }, { "disabled": false, "description": { "content": "Inclusive end timestamp. Accepts `YYYY-MM-DD` or RFC3339 datetime.", "type": "text/plain" }, "key": "to", "value": "" }, { "disabled": false, "description": { "content": "Comma-separated list of publishers to include (mutually exclusive with exclude_publishers).", "type": "text/plain" }, "key": "include_publishers", "value": "" }, { "disabled": false, "description": { "content": "Comma-separated list of publishers to exclude (mutually exclusive with include_publishers).", "type": "text/plain" }, "key": "exclude_publishers", "value": "" }, { "disabled": false, "description": { "content": "Filter by news type.", "type": "text/plain" }, "key": "news_type", "value": "PRESS_RELEASE" }, { "disabled": false, "description": { "content": "Free-text query matched against title/text and associated security IDs.", "type": "text/plain" }, "key": "search_query", "value": "" }, { "disabled": false, "description": { "content": "Comma-delimited instrument identifiers to filter by.", "type": "text/plain" }, "key": "instrument_ids", "value": "," }, { "disabled": false, "description": { "content": "Comma-separated sector values to filter by.", "type": "text/plain" }, "key": "sectors", "value": "FINANCIAL_SERVICES,INDUSTRIALS" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"news_type\": \"NEWS\",\n \"published_at\": \"\",\n \"publisher\": \"\",\n \"title\": \"\",\n \"url\": \"\",\n \"instruments\": [\n {\n \"instrument_id\": \"\",\n \"name\": \"\",\n \"symbol\": \"\"\n },\n {\n \"instrument_id\": \"\",\n \"name\": \"\",\n \"symbol\": \"\"\n }\n ],\n \"image_url\": \"\",\n \"site\": \"\",\n \"text\": \"\"\n },\n {\n \"news_type\": \"NEWS\",\n \"published_at\": \"\",\n \"publisher\": \"\",\n \"title\": \"\",\n \"url\": \"\",\n \"instruments\": [\n {\n \"instrument_id\": \"\",\n \"name\": \"\",\n \"symbol\": \"\"\n },\n {\n \"instrument_id\": \"\",\n \"name\": \"\",\n \"symbol\": \"\"\n }\n ],\n \"image_url\": \"\",\n \"site\": \"\",\n \"text\": \"\"\n }\n ],\n \"metadata\": {\n \"request_id\": \"\",\n \"next_page_token\": \"\",\n \"page_number\": \"\",\n \"previous_page_token\": \"\",\n \"total_items\": \"\",\n \"total_pages\": \"\"\n },\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "827c68b0-97dd-43d5-b95f-c96ad707b639", "name": "Invalid query parameters", "originalRequest": { "url": { "path": [ "v1", "news" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The number of items to return per page. Only used when page_token is not provided.", "type": "text/plain" }, "key": "page_size", "value": "1000" }, { "disabled": false, "description": { "content": "Token for retrieving the next or previous page of results. Contains encoded pagination state; when provided, page_size is ignored.", "type": "text/plain" }, "key": "page_token", "value": "" }, { "disabled": false, "description": { "content": "Inclusive start timestamp. Accepts `YYYY-MM-DD` or RFC3339 datetime.", "type": "text/plain" }, "key": "from", "value": "" }, { "disabled": false, "description": { "content": "Inclusive end timestamp. Accepts `YYYY-MM-DD` or RFC3339 datetime.", "type": "text/plain" }, "key": "to", "value": "" }, { "disabled": false, "description": { "content": "Comma-separated list of publishers to include (mutually exclusive with exclude_publishers).", "type": "text/plain" }, "key": "include_publishers", "value": "" }, { "disabled": false, "description": { "content": "Comma-separated list of publishers to exclude (mutually exclusive with include_publishers).", "type": "text/plain" }, "key": "exclude_publishers", "value": "" }, { "disabled": false, "description": { "content": "Filter by news type.", "type": "text/plain" }, "key": "news_type", "value": "PRESS_RELEASE" }, { "disabled": false, "description": { "content": "Free-text query matched against title/text and associated security IDs.", "type": "text/plain" }, "key": "search_query", "value": "" }, { "disabled": false, "description": { "content": "Comma-delimited instrument identifiers to filter by.", "type": "text/plain" }, "key": "instrument_ids", "value": "," }, { "disabled": false, "description": { "content": "Comma-separated sector values to filter by.", "type": "text/plain" }, "key": "sectors", "value": "FINANCIAL_SERVICES,INDUSTRIALS" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"sunt_f\": false,\n \"magnae59\": 67421727\n },\n {\n \"minim48\": false,\n \"fugiat94d\": -43856089.03091218\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "144420a4-25cc-484d-be36-d96372cf5d0d", "name": "Internal server error", "originalRequest": { "url": { "path": [ "v1", "news" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The number of items to return per page. Only used when page_token is not provided.", "type": "text/plain" }, "key": "page_size", "value": "1000" }, { "disabled": false, "description": { "content": "Token for retrieving the next or previous page of results. Contains encoded pagination state; when provided, page_size is ignored.", "type": "text/plain" }, "key": "page_token", "value": "" }, { "disabled": false, "description": { "content": "Inclusive start timestamp. Accepts `YYYY-MM-DD` or RFC3339 datetime.", "type": "text/plain" }, "key": "from", "value": "" }, { "disabled": false, "description": { "content": "Inclusive end timestamp. Accepts `YYYY-MM-DD` or RFC3339 datetime.", "type": "text/plain" }, "key": "to", "value": "" }, { "disabled": false, "description": { "content": "Comma-separated list of publishers to include (mutually exclusive with exclude_publishers).", "type": "text/plain" }, "key": "include_publishers", "value": "" }, { "disabled": false, "description": { "content": "Comma-separated list of publishers to exclude (mutually exclusive with include_publishers).", "type": "text/plain" }, "key": "exclude_publishers", "value": "" }, { "disabled": false, "description": { "content": "Filter by news type.", "type": "text/plain" }, "key": "news_type", "value": "PRESS_RELEASE" }, { "disabled": false, "description": { "content": "Free-text query matched against title/text and associated security IDs.", "type": "text/plain" }, "key": "search_query", "value": "" }, { "disabled": false, "description": { "content": "Comma-delimited instrument identifiers to filter by.", "type": "text/plain" }, "key": "instrument_ids", "value": "," }, { "disabled": false, "description": { "content": "Comma-separated sector values to filter by.", "type": "text/plain" }, "key": "sectors", "value": "FINANCIAL_SERVICES,INDUSTRIALS" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"sunt_f\": false,\n \"magnae59\": 67421727\n },\n {\n \"minim48\": false,\n \"fugiat94d\": -43856089.03091218\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Calendar", "description": "Access clocks and financial calendars for market sessions and events.", "item": [ { "id": "b75c8bad-7d8c-42f1-b1d3-901c77f8550e", "name": "Get Market Hours Calendar.", "request": { "name": "Get Market Hours Calendar.", "description": { "content": "Retrieves comprehensive trading hours including pre-market, regular, and after-hours sessions.\nReturns market status, session times, and next session schedules.", "type": "text/plain" }, "url": { "path": [ "v1", "calendars", "market-hours" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The date to query market hours for (YYYY-MM-DD). Defaults to today.", "type": "text/plain" }, "key": "date", "value": "" }, { "disabled": false, "description": { "content": "Market type to query (us_equities, us_options). If omitted, returns all markets.", "type": "text/plain" }, "key": "market", "value": "us_equities" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "db8ba3c2-ce61-4042-9c6d-96b7828460fe", "name": "Market hours calendar", "originalRequest": { "url": { "path": [ "v1", "calendars", "market-hours" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The date to query market hours for (YYYY-MM-DD). Defaults to today.", "type": "text/plain" }, "key": "date", "value": "" }, { "disabled": false, "description": { "content": "Market type to query (us_equities, us_options). If omitted, returns all markets.", "type": "text/plain" }, "key": "market", "value": "us_equities" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"market\": \"us_equities\",\n \"market_name\": \"\",\n \"date\": \"\",\n \"timezone\": \"\",\n \"current_time\": \"\",\n \"status\": {\n \"day_type\": \"WEEKEND\",\n \"is_open\": \"\",\n \"current_session\": \"\"\n },\n \"today_sessions\": {\n \"after_hours\": \"\",\n \"overnight\": \"\",\n \"pre_market\": \"\",\n \"regular\": \"\"\n },\n \"next_sessions\": {\n \"after_hours\": \"\",\n \"overnight\": \"\",\n \"pre_market\": \"\",\n \"regular\": \"\"\n }\n },\n {\n \"market\": \"us_equities\",\n \"market_name\": \"\",\n \"date\": \"\",\n \"timezone\": \"\",\n \"current_time\": \"\",\n \"status\": {\n \"day_type\": \"WEEKEND\",\n \"is_open\": \"\",\n \"current_session\": \"\"\n },\n \"today_sessions\": {\n \"after_hours\": \"\",\n \"overnight\": \"\",\n \"pre_market\": \"\",\n \"regular\": \"\"\n },\n \"next_sessions\": {\n \"after_hours\": \"\",\n \"overnight\": \"\",\n \"pre_market\": \"\",\n \"regular\": \"\"\n }\n }\n ],\n \"metadata\": {\n \"request_id\": \"\",\n \"next_page_token\": \"\",\n \"page_number\": \"\",\n \"previous_page_token\": \"\",\n \"total_items\": \"\",\n \"total_pages\": \"\"\n },\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4e68918f-baa9-44bc-b5d6-f9dcd8f28e2d", "name": "Get Clock", "request": { "name": "Get Clock", "description": { "content": "Returns the current server time in UTC.", "type": "text/plain" }, "url": { "path": [ "v1", "clock" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "bd207fb7-1377-4d49-baf4-10e70bba5e25", "name": "Current server time", "originalRequest": { "url": { "path": [ "v1", "clock" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"clock\": \"\"\n },\n \"metadata\": {\n \"request_id\": \"\",\n \"next_page_token\": \"\",\n \"page_number\": \"\",\n \"previous_page_token\": \"\",\n \"total_items\": \"\",\n \"total_pages\": \"\"\n },\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Screener", "description": "Search instruments and manage saved screeners.", "item": [ { "id": "8616061b-6dd3-45c5-bd99-6fda1f56b687", "name": "Get Screeners", "request": { "name": "Get Screeners", "description": { "content": "List saved screener configurations.\n\nReturns all screener configurations for the authenticated user.", "type": "text/plain" }, "url": { "path": [ "v1", "saved-screeners" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "ba292dc6-e334-420d-8665-565e8c95fb75", "name": "List of saved screeners", "originalRequest": { "url": { "path": [ "v1", "saved-screeners" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"filters\": [\n {\n \"left\": {\n \"name\": \"\",\n \"lookback\": \"\",\n \"period\": \"\",\n \"value_type\": \"\"\n },\n \"op\": \"\",\n \"right\": null\n },\n {\n \"left\": {\n \"name\": \"\",\n \"lookback\": \"\",\n \"period\": \"\",\n \"value_type\": \"\"\n },\n \"op\": \"\",\n \"right\": [\n {\n \"value\": \"\",\n \"variable\": \"\"\n },\n {\n \"value\": \"\",\n \"variable\": \"\"\n }\n ]\n }\n ],\n \"shared\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"columns\": null,\n \"sorts\": null\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"filters\": [\n {\n \"left\": {\n \"name\": \"\",\n \"lookback\": \"\",\n \"period\": \"\",\n \"value_type\": \"\"\n },\n \"op\": \"\",\n \"right\": [\n {\n \"value\": \"\",\n \"variable\": \"\"\n },\n {\n \"value\": \"\",\n \"variable\": \"\"\n }\n ]\n },\n {\n \"left\": {\n \"name\": \"\",\n \"lookback\": \"\",\n \"period\": \"\",\n \"value_type\": \"\"\n },\n \"op\": \"\",\n \"right\": null\n }\n ],\n \"shared\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"columns\": null,\n \"sorts\": [\n {\n \"field\": {\n \"name\": \"\",\n \"lookback\": \"\",\n \"period\": \"\",\n \"value_type\": \"\"\n },\n \"direction\": \"DESC\"\n },\n {\n \"field\": {\n \"name\": \"\",\n \"lookback\": \"\",\n \"period\": \"\",\n \"value_type\": \"\"\n },\n \"direction\": \"ASC\"\n }\n ]\n }\n ],\n \"metadata\": {\n \"request_id\": \"\",\n \"next_page_token\": \"\",\n \"page_number\": \"\",\n \"previous_page_token\": \"\",\n \"total_items\": \"\",\n \"total_pages\": \"\"\n },\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3fc44721-b522-4df2-933b-4cf9febfd5ae", "name": "Internal server error", "originalRequest": { "url": { "path": [ "v1", "saved-screeners" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"sunt_f\": false,\n \"magnae59\": 67421727\n },\n {\n \"minim48\": false,\n \"fugiat94d\": -43856089.03091218\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1b6b12d2-8357-4465-bce3-9ec2d9187582", "name": "Create Screener", "request": { "name": "Create Screener", "description": { "content": "Create a saved screener configuration.\n\nPersists a screener configuration for the authenticated user.", "type": "text/plain" }, "url": { "path": [ "v1", "saved-screeners" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"columns\": null,\n \"filters\": [\n {\n \"left\": {\n \"name\": \"\",\n \"lookback\": \"\",\n \"period\": \"\",\n \"value_type\": \"\"\n },\n \"op\": \"\",\n \"right\": [\n {\n \"value\": \"\",\n \"variable\": \"\"\n },\n {\n \"value\": \"\",\n \"variable\": \"\"\n }\n ]\n },\n {\n \"left\": {\n \"name\": \"\",\n \"lookback\": \"\",\n \"period\": \"\",\n \"value_type\": \"\"\n },\n \"op\": \"\",\n \"right\": null\n }\n ],\n \"name\": \"\",\n \"shared\": \"\",\n \"sorts\": null\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "38a38658-ad80-4e49-85bf-0844bc61be30", "name": "Screener created successfully", "originalRequest": { "url": { "path": [ "v1", "saved-screeners" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"columns\": null,\n \"filters\": [\n {\n \"left\": {\n \"name\": \"\",\n \"lookback\": \"\",\n \"period\": \"\",\n \"value_type\": \"\"\n },\n \"op\": \"\",\n \"right\": [\n {\n \"value\": \"\",\n \"variable\": \"\"\n },\n {\n \"value\": \"\",\n \"variable\": \"\"\n }\n ]\n },\n {\n \"left\": {\n \"name\": \"\",\n \"lookback\": \"\",\n \"period\": \"\",\n \"value_type\": \"\"\n },\n \"op\": \"\",\n \"right\": null\n }\n ],\n \"name\": \"\",\n \"shared\": \"\",\n \"sorts\": null\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"\",\n \"name\": \"\",\n \"filters\": [\n {\n \"left\": {\n \"name\": \"\",\n \"lookback\": \"\",\n \"period\": \"\",\n \"value_type\": \"\"\n },\n \"op\": \"\",\n \"right\": [\n {\n \"value\": \"\",\n \"variable\": \"\"\n },\n {\n \"value\": \"\",\n \"variable\": \"\"\n }\n ]\n },\n {\n \"left\": {\n \"name\": \"\",\n \"lookback\": \"\",\n \"period\": \"\",\n \"value_type\": \"\"\n },\n \"op\": \"\",\n \"right\": null\n }\n ],\n \"shared\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"columns\": null,\n \"sorts\": [\n {\n \"field\": {\n \"name\": \"\",\n \"lookback\": \"\",\n \"period\": \"\",\n \"value_type\": \"\"\n },\n \"direction\": \"DESC\"\n },\n {\n \"field\": {\n \"name\": \"\",\n \"lookback\": \"\",\n \"period\": \"\",\n \"value_type\": \"\"\n },\n \"direction\": \"DESC\"\n }\n ]\n },\n \"metadata\": {\n \"request_id\": \"\",\n \"next_page_token\": \"\",\n \"page_number\": \"\",\n \"previous_page_token\": \"\",\n \"total_items\": \"\",\n \"total_pages\": \"\"\n },\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d1315244-28ff-4429-b436-1eca08d72896", "name": "Invalid request", "originalRequest": { "url": { "path": [ "v1", "saved-screeners" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"columns\": null,\n \"filters\": [\n {\n \"left\": {\n \"name\": \"\",\n \"lookback\": \"\",\n \"period\": \"\",\n \"value_type\": \"\"\n },\n \"op\": \"\",\n \"right\": [\n {\n \"value\": \"\",\n \"variable\": \"\"\n },\n {\n \"value\": \"\",\n \"variable\": \"\"\n }\n ]\n },\n {\n \"left\": {\n \"name\": \"\",\n \"lookback\": \"\",\n \"period\": \"\",\n \"value_type\": \"\"\n },\n \"op\": \"\",\n \"right\": null\n }\n ],\n \"name\": \"\",\n \"shared\": \"\",\n \"sorts\": null\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"sunt_f\": false,\n \"magnae59\": 67421727\n },\n {\n \"minim48\": false,\n \"fugiat94d\": -43856089.03091218\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "65e6ae6a-60cf-4865-b323-f52249a73d2f", "name": "Internal server error", "originalRequest": { "url": { "path": [ "v1", "saved-screeners" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"columns\": null,\n \"filters\": [\n {\n \"left\": {\n \"name\": \"\",\n \"lookback\": \"\",\n \"period\": \"\",\n \"value_type\": \"\"\n },\n \"op\": \"\",\n \"right\": [\n {\n \"value\": \"\",\n \"variable\": \"\"\n },\n {\n \"value\": \"\",\n \"variable\": \"\"\n }\n ]\n },\n {\n \"left\": {\n \"name\": \"\",\n \"lookback\": \"\",\n \"period\": \"\",\n \"value_type\": \"\"\n },\n \"op\": \"\",\n \"right\": null\n }\n ],\n \"name\": \"\",\n \"shared\": \"\",\n \"sorts\": null\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"sunt_f\": false,\n \"magnae59\": 67421727\n },\n {\n \"minim48\": false,\n \"fugiat94d\": -43856089.03091218\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "98b7ec32-3364-470a-b278-ac39e93b1ae1", "name": "Get Screener By ID", "request": { "name": "Get Screener By ID", "description": { "content": "Get a saved screener configuration by ID.\n\nReturns a single screener configuration for the authenticated user.", "type": "text/plain" }, "url": { "path": [ "v1", "saved-screeners", ":screener_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "screener_id", "disabled": false, "description": { "content": "(Required) Screener ID", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "149ee996-817e-4c35-aa19-ca56b97c01ed", "name": "Screener details", "originalRequest": { "url": { "path": [ "v1", "saved-screeners", ":screener_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"\",\n \"name\": \"\",\n \"filters\": [\n {\n \"left\": {\n \"name\": \"\",\n \"lookback\": \"\",\n \"period\": \"\",\n \"value_type\": \"\"\n },\n \"op\": \"\",\n \"right\": [\n {\n \"value\": \"\",\n \"variable\": \"\"\n },\n {\n \"value\": \"\",\n \"variable\": \"\"\n }\n ]\n },\n {\n \"left\": {\n \"name\": \"\",\n \"lookback\": \"\",\n \"period\": \"\",\n \"value_type\": \"\"\n },\n \"op\": \"\",\n \"right\": null\n }\n ],\n \"shared\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"columns\": null,\n \"sorts\": [\n {\n \"field\": {\n \"name\": \"\",\n \"lookback\": \"\",\n \"period\": \"\",\n \"value_type\": \"\"\n },\n \"direction\": \"DESC\"\n },\n {\n \"field\": {\n \"name\": \"\",\n \"lookback\": \"\",\n \"period\": \"\",\n \"value_type\": \"\"\n },\n \"direction\": \"DESC\"\n }\n ]\n },\n \"metadata\": {\n \"request_id\": \"\",\n \"next_page_token\": \"\",\n \"page_number\": \"\",\n \"previous_page_token\": \"\",\n \"total_items\": \"\",\n \"total_pages\": \"\"\n },\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "24c547ca-f003-4db1-a00b-149929ccd3b5", "name": "Invalid request", "originalRequest": { "url": { "path": [ "v1", "saved-screeners", ":screener_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"sunt_f\": false,\n \"magnae59\": 67421727\n },\n {\n \"minim48\": false,\n \"fugiat94d\": -43856089.03091218\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7412ae65-7e8b-4810-b1b6-5943f44bbf1e", "name": "Screener not found", "originalRequest": { "url": { "path": [ "v1", "saved-screeners", ":screener_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"sunt_f\": false,\n \"magnae59\": 67421727\n },\n {\n \"minim48\": false,\n \"fugiat94d\": -43856089.03091218\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3b14f3d8-07d1-48aa-bc35-55b84de6ee25", "name": "Internal server error", "originalRequest": { "url": { "path": [ "v1", "saved-screeners", ":screener_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"sunt_f\": false,\n \"magnae59\": 67421727\n },\n {\n \"minim48\": false,\n \"fugiat94d\": -43856089.03091218\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f3e2c97a-671a-410c-8fee-b1f554de2614", "name": "Replace Screener", "request": { "name": "Replace Screener", "description": { "content": "Update a saved screener configuration.\n\nReplaces the screener configuration for the authenticated user.\nIf `name` is null, the existing name is preserved.\n\nDeprecated -- use `PATCH /saved-screeners/{screener_id}`; PUT replaces\nomitted `columns`, `filters` and `sorts` with empty values.", "type": "text/plain" }, "url": { "path": [ "v1", "saved-screeners", ":screener_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "screener_id", "disabled": false, "description": { "content": "(Required) Screener ID", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"columns\": null,\n \"filters\": [\n {\n \"left\": {\n \"name\": \"\",\n \"lookback\": \"\",\n \"period\": \"\",\n \"value_type\": \"\"\n },\n \"op\": \"\",\n \"right\": [\n {\n \"value\": \"\",\n \"variable\": \"\"\n },\n {\n \"value\": \"\",\n \"variable\": \"\"\n }\n ]\n },\n {\n \"left\": {\n \"name\": \"\",\n \"lookback\": \"\",\n \"period\": \"\",\n \"value_type\": \"\"\n },\n \"op\": \"\",\n \"right\": null\n }\n ],\n \"name\": \"\",\n \"shared\": \"\",\n \"sorts\": null\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "fae5338b-71fd-4ad0-807f-72d6905f0066", "name": "Screener updated successfully", "originalRequest": { "url": { "path": [ "v1", "saved-screeners", ":screener_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"columns\": null,\n \"filters\": [\n {\n \"left\": {\n \"name\": \"\",\n \"lookback\": \"\",\n \"period\": \"\",\n \"value_type\": \"\"\n },\n \"op\": \"\",\n \"right\": [\n {\n \"value\": \"\",\n \"variable\": \"\"\n },\n {\n \"value\": \"\",\n \"variable\": \"\"\n }\n ]\n },\n {\n \"left\": {\n \"name\": \"\",\n \"lookback\": \"\",\n \"period\": \"\",\n \"value_type\": \"\"\n },\n \"op\": \"\",\n \"right\": null\n }\n ],\n \"name\": \"\",\n \"shared\": \"\",\n \"sorts\": null\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"\",\n \"name\": \"\",\n \"filters\": [\n {\n \"left\": {\n \"name\": \"\",\n \"lookback\": \"\",\n \"period\": \"\",\n \"value_type\": \"\"\n },\n \"op\": \"\",\n \"right\": [\n {\n \"value\": \"\",\n \"variable\": \"\"\n },\n {\n \"value\": \"\",\n \"variable\": \"\"\n }\n ]\n },\n {\n \"left\": {\n \"name\": \"\",\n \"lookback\": \"\",\n \"period\": \"\",\n \"value_type\": \"\"\n },\n \"op\": \"\",\n \"right\": null\n }\n ],\n \"shared\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"columns\": null,\n \"sorts\": [\n {\n \"field\": {\n \"name\": \"\",\n \"lookback\": \"\",\n \"period\": \"\",\n \"value_type\": \"\"\n },\n \"direction\": \"DESC\"\n },\n {\n \"field\": {\n \"name\": \"\",\n \"lookback\": \"\",\n \"period\": \"\",\n \"value_type\": \"\"\n },\n \"direction\": \"DESC\"\n }\n ]\n },\n \"metadata\": {\n \"request_id\": \"\",\n \"next_page_token\": \"\",\n \"page_number\": \"\",\n \"previous_page_token\": \"\",\n \"total_items\": \"\",\n \"total_pages\": \"\"\n },\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c3c0a4b5-ea39-41b7-ab0d-94511ee510b8", "name": "Invalid request", "originalRequest": { "url": { "path": [ "v1", "saved-screeners", ":screener_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"columns\": null,\n \"filters\": [\n {\n \"left\": {\n \"name\": \"\",\n \"lookback\": \"\",\n \"period\": \"\",\n \"value_type\": \"\"\n },\n \"op\": \"\",\n \"right\": [\n {\n \"value\": \"\",\n \"variable\": \"\"\n },\n {\n \"value\": \"\",\n \"variable\": \"\"\n }\n ]\n },\n {\n \"left\": {\n \"name\": \"\",\n \"lookback\": \"\",\n \"period\": \"\",\n \"value_type\": \"\"\n },\n \"op\": \"\",\n \"right\": null\n }\n ],\n \"name\": \"\",\n \"shared\": \"\",\n \"sorts\": null\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"sunt_f\": false,\n \"magnae59\": 67421727\n },\n {\n \"minim48\": false,\n \"fugiat94d\": -43856089.03091218\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1d9ea0f5-c570-4b63-8a39-bd456545e227", "name": "Screener not found", "originalRequest": { "url": { "path": [ "v1", "saved-screeners", ":screener_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"columns\": null,\n \"filters\": [\n {\n \"left\": {\n \"name\": \"\",\n \"lookback\": \"\",\n \"period\": \"\",\n \"value_type\": \"\"\n },\n \"op\": \"\",\n \"right\": [\n {\n \"value\": \"\",\n \"variable\": \"\"\n },\n {\n \"value\": \"\",\n \"variable\": \"\"\n }\n ]\n },\n {\n \"left\": {\n \"name\": \"\",\n \"lookback\": \"\",\n \"period\": \"\",\n \"value_type\": \"\"\n },\n \"op\": \"\",\n \"right\": null\n }\n ],\n \"name\": \"\",\n \"shared\": \"\",\n \"sorts\": null\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"sunt_f\": false,\n \"magnae59\": 67421727\n },\n {\n \"minim48\": false,\n \"fugiat94d\": -43856089.03091218\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c9a753ed-aaab-4fa9-b014-27de712ee361", "name": "Internal server error", "originalRequest": { "url": { "path": [ "v1", "saved-screeners", ":screener_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"columns\": null,\n \"filters\": [\n {\n \"left\": {\n \"name\": \"\",\n \"lookback\": \"\",\n \"period\": \"\",\n \"value_type\": \"\"\n },\n \"op\": \"\",\n \"right\": [\n {\n \"value\": \"\",\n \"variable\": \"\"\n },\n {\n \"value\": \"\",\n \"variable\": \"\"\n }\n ]\n },\n {\n \"left\": {\n \"name\": \"\",\n \"lookback\": \"\",\n \"period\": \"\",\n \"value_type\": \"\"\n },\n \"op\": \"\",\n \"right\": null\n }\n ],\n \"name\": \"\",\n \"shared\": \"\",\n \"sorts\": null\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"sunt_f\": false,\n \"magnae59\": 67421727\n },\n {\n \"minim48\": false,\n \"fugiat94d\": -43856089.03091218\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "38b5fb21-ba36-4a63-bb27-692451434923", "name": "Delete Screener", "request": { "name": "Delete Screener", "description": { "content": "Delete a saved screener configuration.\n\nDeletes the screener configuration for the authenticated user.", "type": "text/plain" }, "url": { "path": [ "v1", "saved-screeners", ":screener_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "screener_id", "disabled": false, "description": { "content": "(Required) Screener ID", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "95df721d-f94f-4942-a773-6159f9bd519d", "name": "Screener deleted successfully", "originalRequest": { "url": { "path": [ "v1", "saved-screeners", ":screener_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "eae2d412-4ad2-4b08-accb-1657201dc99d", "name": "Screener not found", "originalRequest": { "url": { "path": [ "v1", "saved-screeners", ":screener_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"sunt_f\": false,\n \"magnae59\": 67421727\n },\n {\n \"minim48\": false,\n \"fugiat94d\": -43856089.03091218\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2ed7e2f8-4e18-4c6d-b786-44aa13344795", "name": "Internal server error", "originalRequest": { "url": { "path": [ "v1", "saved-screeners", ":screener_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"sunt_f\": false,\n \"magnae59\": 67421727\n },\n {\n \"minim48\": false,\n \"fugiat94d\": -43856089.03091218\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "fc8a7d9a-c643-47b1-a8d9-8599ac2348c4", "name": "Patch Screener", "request": { "name": "Patch Screener", "description": { "content": "Partially update a saved screener configuration.\n\nEvery field is optional. Omitting a field, or sending it as `null`,\nleaves the stored value unchanged. Sending a field's empty value clears\nit: `columns: []` clears the stored columns, `sorts: []` clears the\nstored sort, and `filters: []` clears the stored filters. `name: \"\"` is\nrejected -- a screener's name cannot be cleared. `shared: false` sets it\nto `false`; it is a value, not a clear.\n\nUnknown fields are rejected with a 422.", "type": "text/plain" }, "url": { "path": [ "v1", "saved-screeners", ":screener_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "screener_id", "disabled": false, "description": { "content": "(Required) Screener ID", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"columns\": null,\n \"filters\": [\n {\n \"left\": {\n \"name\": \"\",\n \"lookback\": \"\",\n \"period\": \"\",\n \"value_type\": \"\"\n },\n \"op\": \"\",\n \"right\": [\n {\n \"value\": \"\",\n \"variable\": \"\"\n },\n {\n \"value\": \"\",\n \"variable\": \"\"\n }\n ]\n },\n {\n \"left\": {\n \"name\": \"\",\n \"lookback\": \"\",\n \"period\": \"\",\n \"value_type\": \"\"\n },\n \"op\": \"\",\n \"right\": [\n {\n \"value\": \"\",\n \"variable\": \"\"\n },\n {\n \"value\": \"\",\n \"variable\": \"\"\n }\n ]\n }\n ],\n \"name\": \"\",\n \"shared\": \"\",\n \"sorts\": null\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "ebe15421-2b77-4913-adec-53e095bd45fa", "name": "Screener updated successfully", "originalRequest": { "url": { "path": [ "v1", "saved-screeners", ":screener_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"columns\": null,\n \"filters\": [\n {\n \"left\": {\n \"name\": \"\",\n \"lookback\": \"\",\n \"period\": \"\",\n \"value_type\": \"\"\n },\n \"op\": \"\",\n \"right\": [\n {\n \"value\": \"\",\n \"variable\": \"\"\n },\n {\n \"value\": \"\",\n \"variable\": \"\"\n }\n ]\n },\n {\n \"left\": {\n \"name\": \"\",\n \"lookback\": \"\",\n \"period\": \"\",\n \"value_type\": \"\"\n },\n \"op\": \"\",\n \"right\": [\n {\n \"value\": \"\",\n \"variable\": \"\"\n },\n {\n \"value\": \"\",\n \"variable\": \"\"\n }\n ]\n }\n ],\n \"name\": \"\",\n \"shared\": \"\",\n \"sorts\": null\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"\",\n \"name\": \"\",\n \"filters\": [\n {\n \"left\": {\n \"name\": \"\",\n \"lookback\": \"\",\n \"period\": \"\",\n \"value_type\": \"\"\n },\n \"op\": \"\",\n \"right\": [\n {\n \"value\": \"\",\n \"variable\": \"\"\n },\n {\n \"value\": \"\",\n \"variable\": \"\"\n }\n ]\n },\n {\n \"left\": {\n \"name\": \"\",\n \"lookback\": \"\",\n \"period\": \"\",\n \"value_type\": \"\"\n },\n \"op\": \"\",\n \"right\": null\n }\n ],\n \"shared\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"columns\": null,\n \"sorts\": [\n {\n \"field\": {\n \"name\": \"\",\n \"lookback\": \"\",\n \"period\": \"\",\n \"value_type\": \"\"\n },\n \"direction\": \"DESC\"\n },\n {\n \"field\": {\n \"name\": \"\",\n \"lookback\": \"\",\n \"period\": \"\",\n \"value_type\": \"\"\n },\n \"direction\": \"DESC\"\n }\n ]\n },\n \"metadata\": {\n \"request_id\": \"\",\n \"next_page_token\": \"\",\n \"page_number\": \"\",\n \"previous_page_token\": \"\",\n \"total_items\": \"\",\n \"total_pages\": \"\"\n },\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "07fa4f70-446e-48e4-a94a-0e6adff857d5", "name": "Invalid request", "originalRequest": { "url": { "path": [ "v1", "saved-screeners", ":screener_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"columns\": null,\n \"filters\": [\n {\n \"left\": {\n \"name\": \"\",\n \"lookback\": \"\",\n \"period\": \"\",\n \"value_type\": \"\"\n },\n \"op\": \"\",\n \"right\": [\n {\n \"value\": \"\",\n \"variable\": \"\"\n },\n {\n \"value\": \"\",\n \"variable\": \"\"\n }\n ]\n },\n {\n \"left\": {\n \"name\": \"\",\n \"lookback\": \"\",\n \"period\": \"\",\n \"value_type\": \"\"\n },\n \"op\": \"\",\n \"right\": [\n {\n \"value\": \"\",\n \"variable\": \"\"\n },\n {\n \"value\": \"\",\n \"variable\": \"\"\n }\n ]\n }\n ],\n \"name\": \"\",\n \"shared\": \"\",\n \"sorts\": null\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"sunt_f\": false,\n \"magnae59\": 67421727\n },\n {\n \"minim48\": false,\n \"fugiat94d\": -43856089.03091218\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1844c4c0-6e1d-4777-aa37-f659576702e6", "name": "Screener not found", "originalRequest": { "url": { "path": [ "v1", "saved-screeners", ":screener_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"columns\": null,\n \"filters\": [\n {\n \"left\": {\n \"name\": \"\",\n \"lookback\": \"\",\n \"period\": \"\",\n \"value_type\": \"\"\n },\n \"op\": \"\",\n \"right\": [\n {\n \"value\": \"\",\n \"variable\": \"\"\n },\n {\n \"value\": \"\",\n \"variable\": \"\"\n }\n ]\n },\n {\n \"left\": {\n \"name\": \"\",\n \"lookback\": \"\",\n \"period\": \"\",\n \"value_type\": \"\"\n },\n \"op\": \"\",\n \"right\": [\n {\n \"value\": \"\",\n \"variable\": \"\"\n },\n {\n \"value\": \"\",\n \"variable\": \"\"\n }\n ]\n }\n ],\n \"name\": \"\",\n \"shared\": \"\",\n \"sorts\": null\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"sunt_f\": false,\n \"magnae59\": 67421727\n },\n {\n \"minim48\": false,\n \"fugiat94d\": -43856089.03091218\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f2d2ede3-995f-4b18-a487-d69f9553e087", "name": "Malformed request payload", "originalRequest": { "url": { "path": [ "v1", "saved-screeners", ":screener_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"columns\": null,\n \"filters\": [\n {\n \"left\": {\n \"name\": \"\",\n \"lookback\": \"\",\n \"period\": \"\",\n \"value_type\": \"\"\n },\n \"op\": \"\",\n \"right\": [\n {\n \"value\": \"\",\n \"variable\": \"\"\n },\n {\n \"value\": \"\",\n \"variable\": \"\"\n }\n ]\n },\n {\n \"left\": {\n \"name\": \"\",\n \"lookback\": \"\",\n \"period\": \"\",\n \"value_type\": \"\"\n },\n \"op\": \"\",\n \"right\": [\n {\n \"value\": \"\",\n \"variable\": \"\"\n },\n {\n \"value\": \"\",\n \"variable\": \"\"\n }\n ]\n }\n ],\n \"name\": \"\",\n \"shared\": \"\",\n \"sorts\": null\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"sunt_f\": false,\n \"magnae59\": 67421727\n },\n {\n \"minim48\": false,\n \"fugiat94d\": -43856089.03091218\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3f08ad3d-20ef-4a75-baef-0aedd56f59c6", "name": "Internal server error", "originalRequest": { "url": { "path": [ "v1", "saved-screeners", ":screener_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"columns\": null,\n \"filters\": [\n {\n \"left\": {\n \"name\": \"\",\n \"lookback\": \"\",\n \"period\": \"\",\n \"value_type\": \"\"\n },\n \"op\": \"\",\n \"right\": [\n {\n \"value\": \"\",\n \"variable\": \"\"\n },\n {\n \"value\": \"\",\n \"variable\": \"\"\n }\n ]\n },\n {\n \"left\": {\n \"name\": \"\",\n \"lookback\": \"\",\n \"period\": \"\",\n \"value_type\": \"\"\n },\n \"op\": \"\",\n \"right\": [\n {\n \"value\": \"\",\n \"variable\": \"\"\n },\n {\n \"value\": \"\",\n \"variable\": \"\"\n }\n ]\n }\n ],\n \"name\": \"\",\n \"shared\": \"\",\n \"sorts\": null\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"sunt_f\": false,\n \"magnae59\": 67421727\n },\n {\n \"minim48\": false,\n \"fugiat94d\": -43856089.03091218\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "872d5b1f-cc33-4cb4-a3d3-cd762b9ac266", "name": "Search Screener", "request": { "name": "Search Screener", "description": { "content": "Search instruments using structured filters.\n\nCompose a request with `filters`, plus optional `sorts`, `columns`, and\n`page_size`/`page_token` for pagination. Each filter pairs a field reference\n(`left`) with an operator (`op`, e.g. `GREATER_OR_EQUAL`, `BETWEEN`) and\ncomparison values (`right`), which can be literals or date variables such as\n`today` with a modifier. Field names, periods, and lookbacks come from the\nscreener field catalog. `sorts` order results; `columns` selects which\nfields appear in each row (the default field set when omitted).\n\nThe response is a paginated, columnar list of matching instruments. Each row\nis an array of column objects, each with a display `name`, the `field`\nreference, an optional value `type` hint (e.g. `CURR_USD`, `PERCENT`), and\nthe `value`. An `instrument_id` column is always prepended. Metadata carries\n`total_items`, `total_pages`, and `next_page_token` for paging.\n\nScreener results can shuffle between calls; reconcile by re-checking rows\nacross pages rather than assuming stable ordering.", "type": "text/plain" }, "url": { "path": [ "v1", "screener" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"page_size\": \"\",\n \"page_token\": \"\",\n \"columns\": [\n {\n \"name\": \"\",\n \"lookback\": \"\",\n \"period\": \"\",\n \"value_type\": \"\"\n },\n {\n \"name\": \"\",\n \"lookback\": \"\",\n \"period\": \"\",\n \"value_type\": \"\"\n }\n ],\n \"filters\": [\n {\n \"left\": {\n \"name\": \"\",\n \"lookback\": \"\",\n \"period\": \"\",\n \"value_type\": \"\"\n },\n \"op\": \"\",\n \"right\": null\n },\n {\n \"left\": {\n \"name\": \"\",\n \"lookback\": \"\",\n \"period\": \"\",\n \"value_type\": \"\"\n },\n \"op\": \"\",\n \"right\": [\n {\n \"value\": \"\",\n \"variable\": \"\"\n },\n {\n \"value\": \"\",\n \"variable\": \"\"\n }\n ]\n }\n ],\n \"sort_case_sensitive\": \"\",\n \"sorts\": null\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "ba4c0ea5-8328-4921-872d-10afd429264d", "name": "Screener results", "originalRequest": { "url": { "path": [ "v1", "screener" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"page_size\": \"\",\n \"page_token\": \"\",\n \"columns\": [\n {\n \"name\": \"\",\n \"lookback\": \"\",\n \"period\": \"\",\n \"value_type\": \"\"\n },\n {\n \"name\": \"\",\n \"lookback\": \"\",\n \"period\": \"\",\n \"value_type\": \"\"\n }\n ],\n \"filters\": [\n {\n \"left\": {\n \"name\": \"\",\n \"lookback\": \"\",\n \"period\": \"\",\n \"value_type\": \"\"\n },\n \"op\": \"\",\n \"right\": null\n },\n {\n \"left\": {\n \"name\": \"\",\n \"lookback\": \"\",\n \"period\": \"\",\n \"value_type\": \"\"\n },\n \"op\": \"\",\n \"right\": [\n {\n \"value\": \"\",\n \"variable\": \"\"\n },\n {\n \"value\": \"\",\n \"variable\": \"\"\n }\n ]\n }\n ],\n \"sort_case_sensitive\": \"\",\n \"sorts\": null\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n [\n {\n \"name\": \"\",\n \"field\": {\n \"name\": \"\",\n \"lookback\": \"\",\n \"period\": \"\",\n \"value_type\": \"\"\n },\n \"value\": \"\",\n \"type\": \"\"\n },\n {\n \"name\": \"\",\n \"field\": {\n \"name\": \"\",\n \"lookback\": \"\",\n \"period\": \"\",\n \"value_type\": \"\"\n },\n \"value\": \"\",\n \"type\": \"\"\n }\n ],\n [\n {\n \"name\": \"\",\n \"field\": {\n \"name\": \"\",\n \"lookback\": \"\",\n \"period\": \"\",\n \"value_type\": \"\"\n },\n \"value\": \"\",\n \"type\": \"\"\n },\n {\n \"name\": \"\",\n \"field\": {\n \"name\": \"\",\n \"lookback\": \"\",\n \"period\": \"\",\n \"value_type\": \"\"\n },\n \"value\": \"\",\n \"type\": \"\"\n }\n ]\n ],\n \"metadata\": {\n \"request_id\": \"\",\n \"next_page_token\": \"\",\n \"page_number\": \"\",\n \"previous_page_token\": \"\",\n \"total_items\": \"\",\n \"total_pages\": \"\"\n },\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "87fd2c46-da4e-4ecd-8565-0e1e673b87f0", "name": "Invalid request", "originalRequest": { "url": { "path": [ "v1", "screener" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"page_size\": \"\",\n \"page_token\": \"\",\n \"columns\": [\n {\n \"name\": \"\",\n \"lookback\": \"\",\n \"period\": \"\",\n \"value_type\": \"\"\n },\n {\n \"name\": \"\",\n \"lookback\": \"\",\n \"period\": \"\",\n \"value_type\": \"\"\n }\n ],\n \"filters\": [\n {\n \"left\": {\n \"name\": \"\",\n \"lookback\": \"\",\n \"period\": \"\",\n \"value_type\": \"\"\n },\n \"op\": \"\",\n \"right\": null\n },\n {\n \"left\": {\n \"name\": \"\",\n \"lookback\": \"\",\n \"period\": \"\",\n \"value_type\": \"\"\n },\n \"op\": \"\",\n \"right\": [\n {\n \"value\": \"\",\n \"variable\": \"\"\n },\n {\n \"value\": \"\",\n \"variable\": \"\"\n }\n ]\n }\n ],\n \"sort_case_sensitive\": \"\",\n \"sorts\": null\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"sunt_f\": false,\n \"magnae59\": 67421727\n },\n {\n \"minim48\": false,\n \"fugiat94d\": -43856089.03091218\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d0793705-73a4-41ed-bcb2-9ba73ed7fa09", "name": "Malformed request payload", "originalRequest": { "url": { "path": [ "v1", "screener" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"page_size\": \"\",\n \"page_token\": \"\",\n \"columns\": [\n {\n \"name\": \"\",\n \"lookback\": \"\",\n \"period\": \"\",\n \"value_type\": \"\"\n },\n {\n \"name\": \"\",\n \"lookback\": \"\",\n \"period\": \"\",\n \"value_type\": \"\"\n }\n ],\n \"filters\": [\n {\n \"left\": {\n \"name\": \"\",\n \"lookback\": \"\",\n \"period\": \"\",\n \"value_type\": \"\"\n },\n \"op\": \"\",\n \"right\": null\n },\n {\n \"left\": {\n \"name\": \"\",\n \"lookback\": \"\",\n \"period\": \"\",\n \"value_type\": \"\"\n },\n \"op\": \"\",\n \"right\": [\n {\n \"value\": \"\",\n \"variable\": \"\"\n },\n {\n \"value\": \"\",\n \"variable\": \"\"\n }\n ]\n }\n ],\n \"sort_case_sensitive\": \"\",\n \"sorts\": null\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"sunt_f\": false,\n \"magnae59\": 67421727\n },\n {\n \"minim48\": false,\n \"fugiat94d\": -43856089.03091218\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4fee679a-f4ee-4204-836d-13bbb1f61437", "name": "Internal server error", "originalRequest": { "url": { "path": [ "v1", "screener" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"page_size\": \"\",\n \"page_token\": \"\",\n \"columns\": [\n {\n \"name\": \"\",\n \"lookback\": \"\",\n \"period\": \"\",\n \"value_type\": \"\"\n },\n {\n \"name\": \"\",\n \"lookback\": \"\",\n \"period\": \"\",\n \"value_type\": \"\"\n }\n ],\n \"filters\": [\n {\n \"left\": {\n \"name\": \"\",\n \"lookback\": \"\",\n \"period\": \"\",\n \"value_type\": \"\"\n },\n \"op\": \"\",\n \"right\": null\n },\n {\n \"left\": {\n \"name\": \"\",\n \"lookback\": \"\",\n \"period\": \"\",\n \"value_type\": \"\"\n },\n \"op\": \"\",\n \"right\": [\n {\n \"value\": \"\",\n \"variable\": \"\"\n },\n {\n \"value\": \"\",\n \"variable\": \"\"\n }\n ]\n }\n ],\n \"sort_case_sensitive\": \"\",\n \"sorts\": null\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"sunt_f\": false,\n \"magnae59\": 67421727\n },\n {\n \"minim48\": false,\n \"fugiat94d\": -43856089.03091218\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e12a3c98-f6ee-4a87-9cf0-fecd0ce55607", "name": "Get Screener Catalog", "request": { "name": "Get Screener Catalog", "description": { "content": "Returns the complete screener field catalog: the field `kinds`, the\nper-field data, the enum universes, the request-side `rules`, the built-in\nvariables and modifiers, and the `POST /screener` default response fields.\n\n`POST /screener` field references are validated against this catalog; its\n`rules` object documents how to compose a valid request.", "type": "text/plain" }, "url": { "path": [ "v1", "screener", "catalog" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "66bfc1db-5404-4684-8f0b-ba097b96aada", "name": "Screener field catalog", "originalRequest": { "url": { "path": [ "v1", "screener", "catalog" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"enums\": {\n \"category\": [\n \"\",\n \"\"\n ],\n \"format\": [\n \"\",\n \"\"\n ],\n \"lookback\": [\n \"\",\n \"\"\n ],\n \"operator\": [\n \"\",\n \"\"\n ],\n \"period\": [\n \"\",\n \"\"\n ],\n \"value_type\": [\n \"\",\n \"\"\n ],\n \"builtin_variable\": [\n \"\",\n \"\"\n ],\n \"modifier_op\": [\n \"\",\n \"\"\n ],\n \"date_unit\": [\n \"\",\n \"\"\n ],\n \"operator_arg\": [\n \"\",\n \"\"\n ]\n },\n \"suffixes\": {\n \"et_e9\": \"\"\n },\n \"operators_by_value_type\": {\n \"minim_e\": [\n \"\",\n \"\"\n ],\n \"adipisicing_6\": [\n \"\",\n \"\"\n ]\n },\n \"rules\": {\n \"api_name_composition\": \"\",\n \"axes\": \"\",\n \"defaults\": \"\",\n \"operators\": \"\",\n \"variables\": \"\",\n \"modifiers\": \"\"\n },\n \"variables\": [\n {\n \"name\": \"\",\n \"resolves_to\": \"\",\n \"description\": \"\"\n },\n {\n \"name\": \"\",\n \"resolves_to\": \"\",\n \"description\": \"\"\n }\n ],\n \"modifiers\": [\n {\n \"name\": \"\",\n \"args\": [\n {\n \"type\": [\n \"string\",\n \"null\"\n ],\n \"description\": \"For optional args: the value used when the arg is omitted.\",\n \"default\": \"\"\n },\n {\n \"type\": [\n \"string\",\n \"null\"\n ],\n \"description\": \"For optional args: the value used when the arg is omitted.\",\n \"default\": \"\"\n }\n ]\n },\n {\n \"name\": \"\",\n \"args\": [\n {\n \"type\": [\n \"string\",\n \"null\"\n ],\n \"description\": \"For optional args: the value used when the arg is omitted.\",\n \"default\": \"\"\n },\n {\n \"type\": [\n \"string\",\n \"null\"\n ],\n \"description\": \"For optional args: the value used when the arg is omitted.\",\n \"default\": \"\"\n }\n ]\n }\n ],\n \"kinds\": [\n {\n \"category\": \"\",\n \"format\": \"\",\n \"value_type\": \"\",\n \"combinations\": [\n {\n \"lookback\": \"\",\n \"period\": \"\"\n },\n {\n \"lookback\": \"\",\n \"period\": \"\"\n }\n ],\n \"default_combination\": {\n \"lookback\": \"\",\n \"period\": \"\"\n }\n },\n {\n \"category\": \"\",\n \"format\": \"\",\n \"value_type\": \"\",\n \"combinations\": [\n {\n \"lookback\": \"\",\n \"period\": \"\"\n },\n {\n \"lookback\": \"\",\n \"period\": \"\"\n }\n ],\n \"default_combination\": {\n \"lookback\": \"\",\n \"period\": \"\"\n }\n }\n ],\n \"fields\": {\n \"kind\": [\n \"\",\n \"\"\n ],\n \"name\": [\n \"\",\n \"\"\n ],\n \"display_name\": [\n \"\",\n \"\"\n ],\n \"description\": [\n \"\",\n \"\"\n ]\n },\n \"default_response_fields\": [\n \"\",\n \"\"\n ]\n },\n \"metadata\": {\n \"request_id\": \"\",\n \"next_page_token\": \"\",\n \"page_number\": \"\",\n \"previous_page_token\": \"\",\n \"total_items\": \"\",\n \"total_pages\": \"\"\n },\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "46c88a74-a529-4d6a-81aa-dcd53785d606", "name": "Internal server error", "originalRequest": { "url": { "path": [ "v1", "screener", "catalog" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"sunt_f\": false,\n \"magnae59\": 67421727\n },\n {\n \"minim48\": false,\n \"fugiat94d\": -43856089.03091218\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Websocket", "description": "Manage real-time market data and order update subscriptions over WebSocket.", "item": [] }, { "name": "Omni AI", "description": "Thread-centric AI assistant for conversational trading. Create threads to start conversations, poll response objects for in-progress output, and read finalized messages from thread history. Thread/message/response endpoints require an explicit account_id. Entitlement endpoints are caller-scoped and use account_ids.", "item": [ { "id": "f63a7a28-440f-4641-9e49-6b32df09d55b", "name": "Get Entitlement Agreements", "request": { "name": "Get Entitlement Agreements", "description": { "content": "List current signable entitlement agreements for consent UX.", "type": "text/plain" }, "url": { "path": [ "v1", "omni-ai", "entitlement-agreements" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "6eb241b3-e588-4e92-b3fe-7fb75b1de09a", "name": "Current signable entitlement agreements", "originalRequest": { "url": { "path": [ "v1", "omni-ai", "entitlement-agreements" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"agreement_id\": \"\",\n \"agreement_key\": \"omni_account_data_access\",\n \"version\": \"\",\n \"title\": \"\",\n \"document_content\": \"\",\n \"document_sha256\": \"\",\n \"entitlement_codes\": [\n \"omni.account_data\",\n \"omni.account_data\"\n ]\n },\n {\n \"agreement_id\": \"\",\n \"agreement_key\": \"omni_account_data_access\",\n \"version\": \"\",\n \"title\": \"\",\n \"document_content\": \"\",\n \"document_sha256\": \"\",\n \"entitlement_codes\": [\n \"omni.account_data\",\n \"omni.account_data\"\n ]\n }\n ],\n \"metadata\": {\n \"request_id\": \"\",\n \"next_page_token\": \"\",\n \"page_number\": \"\",\n \"previous_page_token\": \"\",\n \"total_items\": \"\",\n \"total_pages\": \"\"\n },\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "32d9c05d-610f-44c9-9ae0-dfecb63436ad", "name": "No active signable agreements", "originalRequest": { "url": { "path": [ "v1", "omni-ai", "entitlement-agreements" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"sunt_f\": false,\n \"magnae59\": 67421727\n },\n {\n \"minim48\": false,\n \"fugiat94d\": -43856089.03091218\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fbce3718-dbb6-4754-ae3e-eadd1095c671", "name": "Internal server error", "originalRequest": { "url": { "path": [ "v1", "omni-ai", "entitlement-agreements" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"sunt_f\": false,\n \"magnae59\": 67421727\n },\n {\n \"minim48\": false,\n \"fugiat94d\": -43856089.03091218\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0556d7c9-9580-41f5-85d8-9d588d65c55a", "name": "Get Entitlements", "request": { "name": "Get Entitlements", "description": { "content": "List caller's active entitlement grants.", "type": "text/plain" }, "url": { "path": [ "v1", "omni-ai", "entitlements" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "account_id", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "24f6e0ba-c794-4022-9483-1dcb634fa40f", "name": "Caller's active entitlement grants", "originalRequest": { "url": { "path": [ "v1", "omni-ai", "entitlements" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "account_id", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"entitlement_id\": \"\",\n \"account_id\": \"\",\n \"entitlement_code\": \"omni.account_data\",\n \"agreement_id\": \"\",\n \"granted_at\": \"\"\n },\n {\n \"entitlement_id\": \"\",\n \"account_id\": \"\",\n \"entitlement_code\": \"omni.account_data\",\n \"agreement_id\": \"\",\n \"granted_at\": \"\"\n }\n ],\n \"metadata\": {\n \"request_id\": \"\",\n \"next_page_token\": \"\",\n \"page_number\": \"\",\n \"previous_page_token\": \"\",\n \"total_items\": \"\",\n \"total_pages\": \"\"\n },\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "33670e52-6224-412a-8f52-cfbf24e3aaa5", "name": "Caller lacks access to requested account", "originalRequest": { "url": { "path": [ "v1", "omni-ai", "entitlements" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "account_id", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"sunt_f\": false,\n \"magnae59\": 67421727\n },\n {\n \"minim48\": false,\n \"fugiat94d\": -43856089.03091218\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "66fa7307-f6d4-4289-8f68-c5c200ad1e5e", "name": "Internal server error", "originalRequest": { "url": { "path": [ "v1", "omni-ai", "entitlements" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "account_id", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"sunt_f\": false,\n \"magnae59\": 67421727\n },\n {\n \"minim48\": false,\n \"fugiat94d\": -43856089.03091218\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "13914add-808b-48c1-b004-d6242aa3edb9", "name": "Create Entitlements", "request": { "name": "Create Entitlements", "description": { "content": "Record consent and upsert one-or-more active grants.", "type": "text/plain" }, "url": { "path": [ "v1", "omni-ai", "entitlements" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"agreement_id\": \"\",\n \"entitlement_codes\": [\n \"omni.account_data\",\n \"omni.account_data\"\n ],\n \"account_ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "631f8c47-84d8-43a0-9f4c-c40a4e28a206", "name": "Resulting active grants for requested scope", "originalRequest": { "url": { "path": [ "v1", "omni-ai", "entitlements" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"agreement_id\": \"\",\n \"entitlement_codes\": [\n \"omni.account_data\",\n \"omni.account_data\"\n ],\n \"account_ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"entitlement_id\": \"\",\n \"account_id\": \"\",\n \"entitlement_code\": \"omni.account_data\",\n \"agreement_id\": \"\",\n \"granted_at\": \"\"\n },\n {\n \"entitlement_id\": \"\",\n \"account_id\": \"\",\n \"entitlement_code\": \"omni.account_data\",\n \"agreement_id\": \"\",\n \"granted_at\": \"\"\n }\n ],\n \"metadata\": {\n \"request_id\": \"\",\n \"next_page_token\": \"\",\n \"page_number\": \"\",\n \"previous_page_token\": \"\",\n \"total_items\": \"\",\n \"total_pages\": \"\"\n },\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e0dc8a33-aef6-48a6-9b17-f3e6a5b095a2", "name": "Invalid request payload", "originalRequest": { "url": { "path": [ "v1", "omni-ai", "entitlements" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"agreement_id\": \"\",\n \"entitlement_codes\": [\n \"omni.account_data\",\n \"omni.account_data\"\n ],\n \"account_ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"sunt_f\": false,\n \"magnae59\": 67421727\n },\n {\n \"minim48\": false,\n \"fugiat94d\": -43856089.03091218\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5a00d83e-bf0f-4c83-a751-6f78268904e1", "name": "Caller lacks access to one or more requested accounts", "originalRequest": { "url": { "path": [ "v1", "omni-ai", "entitlements" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"agreement_id\": \"\",\n \"entitlement_codes\": [\n \"omni.account_data\",\n \"omni.account_data\"\n ],\n \"account_ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"sunt_f\": false,\n \"magnae59\": 67421727\n },\n {\n \"minim48\": false,\n \"fugiat94d\": -43856089.03091218\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f31e3264-28c8-43cf-b8be-2700affcc8c5", "name": "Internal server error", "originalRequest": { "url": { "path": [ "v1", "omni-ai", "entitlements" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"agreement_id\": \"\",\n \"entitlement_codes\": [\n \"omni.account_data\",\n \"omni.account_data\"\n ],\n \"account_ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"sunt_f\": false,\n \"magnae59\": 67421727\n },\n {\n \"minim48\": false,\n \"fugiat94d\": -43856089.03091218\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b6b7a5fd-4ff2-49a8-a0ae-9046fcc58867", "name": "Delete Entitlement", "request": { "name": "Delete Entitlement", "description": { "content": "Revoke one entitlement grant by id.", "type": "text/plain" }, "url": { "path": [ "v1", "omni-ai", "entitlements", ":entitlement_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "entitlement_id", "disabled": false, "description": { "content": "(Required) Entitlement grant id", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "3dc2cbc5-7855-4761-b35b-cbd0411eb3cd", "name": "Grant revoked", "originalRequest": { "url": { "path": [ "v1", "omni-ai", "entitlements", ":entitlement_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"entitlement_id\": \"\",\n \"revoked\": \"\"\n },\n \"metadata\": {\n \"request_id\": \"\",\n \"next_page_token\": \"\",\n \"page_number\": \"\",\n \"previous_page_token\": \"\",\n \"total_items\": \"\",\n \"total_pages\": \"\"\n },\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f293a583-b6de-4148-b632-1512e48e5a2a", "name": "Grant not found", "originalRequest": { "url": { "path": [ "v1", "omni-ai", "entitlements", ":entitlement_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"sunt_f\": false,\n \"magnae59\": 67421727\n },\n {\n \"minim48\": false,\n \"fugiat94d\": -43856089.03091218\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5166e936-1216-4e6f-a131-c2a65082e5ad", "name": "Grant already inactive", "originalRequest": { "url": { "path": [ "v1", "omni-ai", "entitlements", ":entitlement_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"sunt_f\": false,\n \"magnae59\": 67421727\n },\n {\n \"minim48\": false,\n \"fugiat94d\": -43856089.03091218\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ffe25b3f-4a9c-4556-abbb-344393000b49", "name": "Internal server error", "originalRequest": { "url": { "path": [ "v1", "omni-ai", "entitlements", ":entitlement_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"sunt_f\": false,\n \"magnae59\": 67421727\n },\n {\n \"minim48\": false,\n \"fugiat94d\": -43856089.03091218\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c11f68ed-cefb-4b57-903d-749438646f22", "name": "Get Message", "request": { "name": "Get Message", "description": { "content": "Read a finalized message using its parent thread for ownership and\nlinked-account authorization. In-progress assistant messages are not\navailable here; use the response polling endpoint instead.", "type": "text/plain" }, "url": { "path": [ "v1", "omni-ai", "messages", ":message_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Lists only conversations for this account, or unlinked conversations when omitted.\nOther reads authorize the resource's linked account.\nOmit when no account is selected; empty values and the string null are invalid.", "type": "text/plain" }, "key": "account_id", "value": "" } ], "variable": [ { "type": "any", "value": "", "key": "message_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "7ce141e8-a30b-4b5f-8beb-9415be8e7d88", "name": "Finalized message with content parts", "originalRequest": { "url": { "path": [ "v1", "omni-ai", "messages", ":message_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Lists only conversations for this account, or unlinked conversations when omitted.\nOther reads authorize the resource's linked account.\nOmit when no account is selected; empty values and the string null are invalid.", "type": "text/plain" }, "key": "account_id", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"\",\n \"thread_id\": \"\",\n \"created_at\": \"\",\n \"seq\": \"\",\n \"role\": \"USER\",\n \"outcome\": \"errored\",\n \"content\": {\n \"parts\": [\n {\n \"text\": \"\",\n \"type\": \"text\"\n },\n {\n \"text\": \"\",\n \"type\": \"text\"\n }\n ]\n },\n \"context\": \"\",\n \"error\": \"\"\n },\n \"metadata\": {\n \"request_id\": \"\",\n \"next_page_token\": \"\",\n \"page_number\": \"\",\n \"previous_page_token\": \"\",\n \"total_items\": \"\",\n \"total_pages\": \"\"\n },\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f469268e-521a-4716-b05e-1f774c034ea2", "name": "Invalid request or supplied account ID", "originalRequest": { "url": { "path": [ "v1", "omni-ai", "messages", ":message_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Lists only conversations for this account, or unlinked conversations when omitted.\nOther reads authorize the resource's linked account.\nOmit when no account is selected; empty values and the string null are invalid.", "type": "text/plain" }, "key": "account_id", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"elit_5c8\": -44988772,\n \"proident_9\": -8115168,\n \"dolore_711\": \"cillum\"\n },\n {\n \"est_9\": \"sit nisi cupidatat pariatur\",\n \"pariatur_a\": 46992893\n }\n ]\n },\n \"metadata\": {\n \"request_id\": \"\",\n \"next_page_token\": \"\",\n \"page_number\": \"\",\n \"previous_page_token\": \"\",\n \"total_items\": \"\",\n \"total_pages\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2001ff69-f21a-40dc-b455-71834e330965", "name": "Authentication required", "originalRequest": { "url": { "path": [ "v1", "omni-ai", "messages", ":message_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Lists only conversations for this account, or unlinked conversations when omitted.\nOther reads authorize the resource's linked account.\nOmit when no account is selected; empty values and the string null are invalid.", "type": "text/plain" }, "key": "account_id", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"elit_5c8\": -44988772,\n \"proident_9\": -8115168,\n \"dolore_711\": \"cillum\"\n },\n {\n \"est_9\": \"sit nisi cupidatat pariatur\",\n \"pariatur_a\": 46992893\n }\n ]\n },\n \"metadata\": {\n \"request_id\": \"\",\n \"next_page_token\": \"\",\n \"page_number\": \"\",\n \"previous_page_token\": \"\",\n \"total_items\": \"\",\n \"total_pages\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "87a31b2d-ac11-4541-a309-a988fcef2a8e", "name": "Caller lacks linked-account access", "originalRequest": { "url": { "path": [ "v1", "omni-ai", "messages", ":message_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Lists only conversations for this account, or unlinked conversations when omitted.\nOther reads authorize the resource's linked account.\nOmit when no account is selected; empty values and the string null are invalid.", "type": "text/plain" }, "key": "account_id", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"elit_5c8\": -44988772,\n \"proident_9\": -8115168,\n \"dolore_711\": \"cillum\"\n },\n {\n \"est_9\": \"sit nisi cupidatat pariatur\",\n \"pariatur_a\": 46992893\n }\n ]\n },\n \"metadata\": {\n \"request_id\": \"\",\n \"next_page_token\": \"\",\n \"page_number\": \"\",\n \"previous_page_token\": \"\",\n \"total_items\": \"\",\n \"total_pages\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "94590912-21f3-4b35-b916-09c95074de8e", "name": "Resource not found or not owned by caller", "originalRequest": { "url": { "path": [ "v1", "omni-ai", "messages", ":message_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Lists only conversations for this account, or unlinked conversations when omitted.\nOther reads authorize the resource's linked account.\nOmit when no account is selected; empty values and the string null are invalid.", "type": "text/plain" }, "key": "account_id", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"elit_5c8\": -44988772,\n \"proident_9\": -8115168,\n \"dolore_711\": \"cillum\"\n },\n {\n \"est_9\": \"sit nisi cupidatat pariatur\",\n \"pariatur_a\": 46992893\n }\n ]\n },\n \"metadata\": {\n \"request_id\": \"\",\n \"next_page_token\": \"\",\n \"page_number\": \"\",\n \"previous_page_token\": \"\",\n \"total_items\": \"\",\n \"total_pages\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4868e45a-a993-41a9-bbdf-3c2c92249cad", "name": "Thread scope changed, active response, or conflicting retry; refresh before retrying", "originalRequest": { "url": { "path": [ "v1", "omni-ai", "messages", ":message_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Lists only conversations for this account, or unlinked conversations when omitted.\nOther reads authorize the resource's linked account.\nOmit when no account is selected; empty values and the string null are invalid.", "type": "text/plain" }, "key": "account_id", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"elit_5c8\": -44988772,\n \"proident_9\": -8115168,\n \"dolore_711\": \"cillum\"\n },\n {\n \"est_9\": \"sit nisi cupidatat pariatur\",\n \"pariatur_a\": 46992893\n }\n ]\n },\n \"metadata\": {\n \"request_id\": \"\",\n \"next_page_token\": \"\",\n \"page_number\": \"\",\n \"previous_page_token\": \"\",\n \"total_items\": \"\",\n \"total_pages\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a56802f6-5022-44ad-b3cf-0647b299a019", "name": "Internal server error", "originalRequest": { "url": { "path": [ "v1", "omni-ai", "messages", ":message_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Lists only conversations for this account, or unlinked conversations when omitted.\nOther reads authorize the resource's linked account.\nOmit when no account is selected; empty values and the string null are invalid.", "type": "text/plain" }, "key": "account_id", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"elit_5c8\": -44988772,\n \"proident_9\": -8115168,\n \"dolore_711\": \"cillum\"\n },\n {\n \"est_9\": \"sit nisi cupidatat pariatur\",\n \"pariatur_a\": 46992893\n }\n ]\n },\n \"metadata\": {\n \"request_id\": \"\",\n \"next_page_token\": \"\",\n \"page_number\": \"\",\n \"previous_page_token\": \"\",\n \"total_items\": \"\",\n \"total_pages\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "88afb466-2ad9-4871-b4dd-9ec78d6c7a5c", "name": "Submit Feedback", "request": { "name": "Submit Feedback", "description": { "content": "Attach a score and optional comment to a finalized assistant message.\nFeedback is only valid for messages with role `ASSISTANT` that have reached\na terminal outcome.\n\nThe current thread account governs access even when the message predates\nits account link.", "type": "text/plain" }, "url": { "path": [ "v1", "omni-ai", "messages", ":message_id", "feedback" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "message_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"score\": \"\",\n \"account_id\": \"\",\n \"comment\": \"\",\n \"metadata\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "793e8117-be3c-4709-ad7b-b3f94dbe7921", "name": "Feedback recorded", "originalRequest": { "url": { "path": [ "v1", "omni-ai", "messages", ":message_id", "feedback" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"score\": \"\",\n \"account_id\": \"\",\n \"comment\": \"\",\n \"metadata\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"created_at\": \"\",\n \"feedback_id\": \"\"\n },\n \"metadata\": {\n \"request_id\": \"\",\n \"next_page_token\": \"\",\n \"page_number\": \"\",\n \"previous_page_token\": \"\",\n \"total_items\": \"\",\n \"total_pages\": \"\"\n },\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6a9a5104-8c27-447c-9b2a-b7850902a9ac", "name": "Invalid request or supplied account ID", "originalRequest": { "url": { "path": [ "v1", "omni-ai", "messages", ":message_id", "feedback" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"score\": \"\",\n \"account_id\": \"\",\n \"comment\": \"\",\n \"metadata\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"elit_5c8\": -44988772,\n \"proident_9\": -8115168,\n \"dolore_711\": \"cillum\"\n },\n {\n \"est_9\": \"sit nisi cupidatat pariatur\",\n \"pariatur_a\": 46992893\n }\n ]\n },\n \"metadata\": {\n \"request_id\": \"\",\n \"next_page_token\": \"\",\n \"page_number\": \"\",\n \"previous_page_token\": \"\",\n \"total_items\": \"\",\n \"total_pages\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b2cfbf97-f3ae-4c79-952e-e82d01393943", "name": "Authentication required", "originalRequest": { "url": { "path": [ "v1", "omni-ai", "messages", ":message_id", "feedback" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"score\": \"\",\n \"account_id\": \"\",\n \"comment\": \"\",\n \"metadata\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"elit_5c8\": -44988772,\n \"proident_9\": -8115168,\n \"dolore_711\": \"cillum\"\n },\n {\n \"est_9\": \"sit nisi cupidatat pariatur\",\n \"pariatur_a\": 46992893\n }\n ]\n },\n \"metadata\": {\n \"request_id\": \"\",\n \"next_page_token\": \"\",\n \"page_number\": \"\",\n \"previous_page_token\": \"\",\n \"total_items\": \"\",\n \"total_pages\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "713ed45c-0ceb-4c4b-98ed-41bea602d3c2", "name": "Caller lacks linked-account access", "originalRequest": { "url": { "path": [ "v1", "omni-ai", "messages", ":message_id", "feedback" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"score\": \"\",\n \"account_id\": \"\",\n \"comment\": \"\",\n \"metadata\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"elit_5c8\": -44988772,\n \"proident_9\": -8115168,\n \"dolore_711\": \"cillum\"\n },\n {\n \"est_9\": \"sit nisi cupidatat pariatur\",\n \"pariatur_a\": 46992893\n }\n ]\n },\n \"metadata\": {\n \"request_id\": \"\",\n \"next_page_token\": \"\",\n \"page_number\": \"\",\n \"previous_page_token\": \"\",\n \"total_items\": \"\",\n \"total_pages\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2836a4f1-144e-4a3d-bd0c-0548077028f8", "name": "Resource not found or not owned by caller", "originalRequest": { "url": { "path": [ "v1", "omni-ai", "messages", ":message_id", "feedback" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"score\": \"\",\n \"account_id\": \"\",\n \"comment\": \"\",\n \"metadata\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"elit_5c8\": -44988772,\n \"proident_9\": -8115168,\n \"dolore_711\": \"cillum\"\n },\n {\n \"est_9\": \"sit nisi cupidatat pariatur\",\n \"pariatur_a\": 46992893\n }\n ]\n },\n \"metadata\": {\n \"request_id\": \"\",\n \"next_page_token\": \"\",\n \"page_number\": \"\",\n \"previous_page_token\": \"\",\n \"total_items\": \"\",\n \"total_pages\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f3e0a864-bdd3-41be-9ed8-ac9512008b1e", "name": "Thread scope changed, active response, or conflicting retry; refresh before retrying", "originalRequest": { "url": { "path": [ "v1", "omni-ai", "messages", ":message_id", "feedback" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"score\": \"\",\n \"account_id\": \"\",\n \"comment\": \"\",\n \"metadata\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"elit_5c8\": -44988772,\n \"proident_9\": -8115168,\n \"dolore_711\": \"cillum\"\n },\n {\n \"est_9\": \"sit nisi cupidatat pariatur\",\n \"pariatur_a\": 46992893\n }\n ]\n },\n \"metadata\": {\n \"request_id\": \"\",\n \"next_page_token\": \"\",\n \"page_number\": \"\",\n \"previous_page_token\": \"\",\n \"total_items\": \"\",\n \"total_pages\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "88137214-f1a9-4d05-bf88-3fe429d505e0", "name": "Malformed request payload", "originalRequest": { "url": { "path": [ "v1", "omni-ai", "messages", ":message_id", "feedback" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"score\": \"\",\n \"account_id\": \"\",\n \"comment\": \"\",\n \"metadata\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"elit_5c8\": -44988772,\n \"proident_9\": -8115168,\n \"dolore_711\": \"cillum\"\n },\n {\n \"est_9\": \"sit nisi cupidatat pariatur\",\n \"pariatur_a\": 46992893\n }\n ]\n },\n \"metadata\": {\n \"request_id\": \"\",\n \"next_page_token\": \"\",\n \"page_number\": \"\",\n \"previous_page_token\": \"\",\n \"total_items\": \"\",\n \"total_pages\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e918fb87-3610-446e-804e-6f438b2c7fd3", "name": "Internal server error", "originalRequest": { "url": { "path": [ "v1", "omni-ai", "messages", ":message_id", "feedback" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"score\": \"\",\n \"account_id\": \"\",\n \"comment\": \"\",\n \"metadata\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"elit_5c8\": -44988772,\n \"proident_9\": -8115168,\n \"dolore_711\": \"cillum\"\n },\n {\n \"est_9\": \"sit nisi cupidatat pariatur\",\n \"pariatur_a\": 46992893\n }\n ]\n },\n \"metadata\": {\n \"request_id\": \"\",\n \"next_page_token\": \"\",\n \"page_number\": \"\",\n \"previous_page_token\": \"\",\n \"total_items\": \"\",\n \"total_pages\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1f689fe8-6c08-4361-8ea0-ddb2eb0631a7", "name": "Get Response By ID", "request": { "name": "Get Response By ID", "description": { "content": "Poll the current snapshot of an in-progress or completed assistant response.\nWhile its status is `queued` or `running`, content may be partial and include\nthinking parts. Continue polling until it becomes `succeeded`, `failed`,\nor `canceled`.\n\nOnce terminal, the finalized message is available through\n`GET /omni-ai/threads/{thread_id}/messages`. Authorization uses the current\nparent thread account, including for responses created before the account link.", "type": "text/plain" }, "url": { "path": [ "v1", "omni-ai", "responses", ":response_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Lists only conversations for this account, or unlinked conversations when omitted.\nOther reads authorize the resource's linked account.\nOmit when no account is selected; empty values and the string null are invalid.", "type": "text/plain" }, "key": "account_id", "value": "" } ], "variable": [ { "type": "any", "value": "", "key": "response_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "bb7f554d-85ce-4d3e-a8ea-5234d919654a", "name": "Current response snapshot with status and partial content", "originalRequest": { "url": { "path": [ "v1", "omni-ai", "responses", ":response_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Lists only conversations for this account, or unlinked conversations when omitted.\nOther reads authorize the resource's linked account.\nOmit when no account is selected; empty values and the string null are invalid.", "type": "text/plain" }, "key": "account_id", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"\",\n \"status\": \"failed\",\n \"thread_id\": \"\",\n \"user_message_id\": \"\",\n \"content\": \"\",\n \"error\": \"\",\n \"output_message_id\": \"\"\n },\n \"metadata\": {\n \"request_id\": \"\",\n \"next_page_token\": \"\",\n \"page_number\": \"\",\n \"previous_page_token\": \"\",\n \"total_items\": \"\",\n \"total_pages\": \"\"\n },\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "60217791-b147-43cb-b6a8-1ada96b2c85c", "name": "Invalid request or supplied account ID", "originalRequest": { "url": { "path": [ "v1", "omni-ai", "responses", ":response_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Lists only conversations for this account, or unlinked conversations when omitted.\nOther reads authorize the resource's linked account.\nOmit when no account is selected; empty values and the string null are invalid.", "type": "text/plain" }, "key": "account_id", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"elit_5c8\": -44988772,\n \"proident_9\": -8115168,\n \"dolore_711\": \"cillum\"\n },\n {\n \"est_9\": \"sit nisi cupidatat pariatur\",\n \"pariatur_a\": 46992893\n }\n ]\n },\n \"metadata\": {\n \"request_id\": \"\",\n \"next_page_token\": \"\",\n \"page_number\": \"\",\n \"previous_page_token\": \"\",\n \"total_items\": \"\",\n \"total_pages\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "15156e05-1d4a-465e-a207-096bd7fb5c25", "name": "Authentication required", "originalRequest": { "url": { "path": [ "v1", "omni-ai", "responses", ":response_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Lists only conversations for this account, or unlinked conversations when omitted.\nOther reads authorize the resource's linked account.\nOmit when no account is selected; empty values and the string null are invalid.", "type": "text/plain" }, "key": "account_id", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"elit_5c8\": -44988772,\n \"proident_9\": -8115168,\n \"dolore_711\": \"cillum\"\n },\n {\n \"est_9\": \"sit nisi cupidatat pariatur\",\n \"pariatur_a\": 46992893\n }\n ]\n },\n \"metadata\": {\n \"request_id\": \"\",\n \"next_page_token\": \"\",\n \"page_number\": \"\",\n \"previous_page_token\": \"\",\n \"total_items\": \"\",\n \"total_pages\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7a0fdc7e-5212-43e0-8fa2-2e271b618002", "name": "Caller lacks linked-account access", "originalRequest": { "url": { "path": [ "v1", "omni-ai", "responses", ":response_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Lists only conversations for this account, or unlinked conversations when omitted.\nOther reads authorize the resource's linked account.\nOmit when no account is selected; empty values and the string null are invalid.", "type": "text/plain" }, "key": "account_id", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"elit_5c8\": -44988772,\n \"proident_9\": -8115168,\n \"dolore_711\": \"cillum\"\n },\n {\n \"est_9\": \"sit nisi cupidatat pariatur\",\n \"pariatur_a\": 46992893\n }\n ]\n },\n \"metadata\": {\n \"request_id\": \"\",\n \"next_page_token\": \"\",\n \"page_number\": \"\",\n \"previous_page_token\": \"\",\n \"total_items\": \"\",\n \"total_pages\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4df38abf-fda2-43ba-a4b8-f60fa5004ae0", "name": "Resource not found or not owned by caller", "originalRequest": { "url": { "path": [ "v1", "omni-ai", "responses", ":response_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Lists only conversations for this account, or unlinked conversations when omitted.\nOther reads authorize the resource's linked account.\nOmit when no account is selected; empty values and the string null are invalid.", "type": "text/plain" }, "key": "account_id", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"elit_5c8\": -44988772,\n \"proident_9\": -8115168,\n \"dolore_711\": \"cillum\"\n },\n {\n \"est_9\": \"sit nisi cupidatat pariatur\",\n \"pariatur_a\": 46992893\n }\n ]\n },\n \"metadata\": {\n \"request_id\": \"\",\n \"next_page_token\": \"\",\n \"page_number\": \"\",\n \"previous_page_token\": \"\",\n \"total_items\": \"\",\n \"total_pages\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e37652e7-e6a5-4b11-9fc1-1ce620905142", "name": "Thread scope changed, active response, or conflicting retry; refresh before retrying", "originalRequest": { "url": { "path": [ "v1", "omni-ai", "responses", ":response_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Lists only conversations for this account, or unlinked conversations when omitted.\nOther reads authorize the resource's linked account.\nOmit when no account is selected; empty values and the string null are invalid.", "type": "text/plain" }, "key": "account_id", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"elit_5c8\": -44988772,\n \"proident_9\": -8115168,\n \"dolore_711\": \"cillum\"\n },\n {\n \"est_9\": \"sit nisi cupidatat pariatur\",\n \"pariatur_a\": 46992893\n }\n ]\n },\n \"metadata\": {\n \"request_id\": \"\",\n \"next_page_token\": \"\",\n \"page_number\": \"\",\n \"previous_page_token\": \"\",\n \"total_items\": \"\",\n \"total_pages\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7938dab6-4d32-436f-884c-249211c3a175", "name": "Internal server error", "originalRequest": { "url": { "path": [ "v1", "omni-ai", "responses", ":response_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Lists only conversations for this account, or unlinked conversations when omitted.\nOther reads authorize the resource's linked account.\nOmit when no account is selected; empty values and the string null are invalid.", "type": "text/plain" }, "key": "account_id", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"elit_5c8\": -44988772,\n \"proident_9\": -8115168,\n \"dolore_711\": \"cillum\"\n },\n {\n \"est_9\": \"sit nisi cupidatat pariatur\",\n \"pariatur_a\": 46992893\n }\n ]\n },\n \"metadata\": {\n \"request_id\": \"\",\n \"next_page_token\": \"\",\n \"page_number\": \"\",\n \"previous_page_token\": \"\",\n \"total_items\": \"\",\n \"total_pages\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0b69a224-1e34-4a83-b1a8-82c50f868276", "name": "Cancel Response", "request": { "name": "Cancel Response", "description": { "content": "Cancel a queued or running response. Cancellation is idempotent after the\nresponse becomes terminal. A canceled turn still produces a finalized\nassistant message with outcome `canceled` in the thread history.\n\nAuthorization uses the linked account before any cancellation.", "type": "text/plain" }, "url": { "path": [ "v1", "omni-ai", "responses", ":response_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Lists only conversations for this account, or unlinked conversations when omitted.\nOther reads authorize the resource's linked account.\nOmit when no account is selected; empty values and the string null are invalid.", "type": "text/plain" }, "key": "account_id", "value": "" } ], "variable": [ { "type": "any", "value": "", "key": "response_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "9e0662ba-fb99-4a54-a586-7c8e5d3db00a", "name": "Cancellation accepted (idempotent)", "originalRequest": { "url": { "path": [ "v1", "omni-ai", "responses", ":response_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Lists only conversations for this account, or unlinked conversations when omitted.\nOther reads authorize the resource's linked account.\nOmit when no account is selected; empty values and the string null are invalid.", "type": "text/plain" }, "key": "account_id", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"canceled\": \"\"\n },\n \"metadata\": {\n \"request_id\": \"\",\n \"next_page_token\": \"\",\n \"page_number\": \"\",\n \"previous_page_token\": \"\",\n \"total_items\": \"\",\n \"total_pages\": \"\"\n },\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4ab27985-83e8-4308-8576-e0b5f57bf195", "name": "Invalid request or supplied account ID", "originalRequest": { "url": { "path": [ "v1", "omni-ai", "responses", ":response_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Lists only conversations for this account, or unlinked conversations when omitted.\nOther reads authorize the resource's linked account.\nOmit when no account is selected; empty values and the string null are invalid.", "type": "text/plain" }, "key": "account_id", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"elit_5c8\": -44988772,\n \"proident_9\": -8115168,\n \"dolore_711\": \"cillum\"\n },\n {\n \"est_9\": \"sit nisi cupidatat pariatur\",\n \"pariatur_a\": 46992893\n }\n ]\n },\n \"metadata\": {\n \"request_id\": \"\",\n \"next_page_token\": \"\",\n \"page_number\": \"\",\n \"previous_page_token\": \"\",\n \"total_items\": \"\",\n \"total_pages\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "914df0dc-c891-4982-bdd6-914f929ee03e", "name": "Authentication required", "originalRequest": { "url": { "path": [ "v1", "omni-ai", "responses", ":response_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Lists only conversations for this account, or unlinked conversations when omitted.\nOther reads authorize the resource's linked account.\nOmit when no account is selected; empty values and the string null are invalid.", "type": "text/plain" }, "key": "account_id", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"elit_5c8\": -44988772,\n \"proident_9\": -8115168,\n \"dolore_711\": \"cillum\"\n },\n {\n \"est_9\": \"sit nisi cupidatat pariatur\",\n \"pariatur_a\": 46992893\n }\n ]\n },\n \"metadata\": {\n \"request_id\": \"\",\n \"next_page_token\": \"\",\n \"page_number\": \"\",\n \"previous_page_token\": \"\",\n \"total_items\": \"\",\n \"total_pages\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "914eb247-ff9e-40fe-af17-8ca37e5a5aee", "name": "Caller lacks linked-account access", "originalRequest": { "url": { "path": [ "v1", "omni-ai", "responses", ":response_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Lists only conversations for this account, or unlinked conversations when omitted.\nOther reads authorize the resource's linked account.\nOmit when no account is selected; empty values and the string null are invalid.", "type": "text/plain" }, "key": "account_id", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"elit_5c8\": -44988772,\n \"proident_9\": -8115168,\n \"dolore_711\": \"cillum\"\n },\n {\n \"est_9\": \"sit nisi cupidatat pariatur\",\n \"pariatur_a\": 46992893\n }\n ]\n },\n \"metadata\": {\n \"request_id\": \"\",\n \"next_page_token\": \"\",\n \"page_number\": \"\",\n \"previous_page_token\": \"\",\n \"total_items\": \"\",\n \"total_pages\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c601e2a7-c6e9-4cc4-b1ff-66ea3b9e8e8e", "name": "Resource not found or not owned by caller", "originalRequest": { "url": { "path": [ "v1", "omni-ai", "responses", ":response_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Lists only conversations for this account, or unlinked conversations when omitted.\nOther reads authorize the resource's linked account.\nOmit when no account is selected; empty values and the string null are invalid.", "type": "text/plain" }, "key": "account_id", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"elit_5c8\": -44988772,\n \"proident_9\": -8115168,\n \"dolore_711\": \"cillum\"\n },\n {\n \"est_9\": \"sit nisi cupidatat pariatur\",\n \"pariatur_a\": 46992893\n }\n ]\n },\n \"metadata\": {\n \"request_id\": \"\",\n \"next_page_token\": \"\",\n \"page_number\": \"\",\n \"previous_page_token\": \"\",\n \"total_items\": \"\",\n \"total_pages\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5f1d3e5c-3b59-4fd1-87ba-a5eb65e8a93b", "name": "Thread scope changed, active response, or conflicting retry; refresh before retrying", "originalRequest": { "url": { "path": [ "v1", "omni-ai", "responses", ":response_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Lists only conversations for this account, or unlinked conversations when omitted.\nOther reads authorize the resource's linked account.\nOmit when no account is selected; empty values and the string null are invalid.", "type": "text/plain" }, "key": "account_id", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"elit_5c8\": -44988772,\n \"proident_9\": -8115168,\n \"dolore_711\": \"cillum\"\n },\n {\n \"est_9\": \"sit nisi cupidatat pariatur\",\n \"pariatur_a\": 46992893\n }\n ]\n },\n \"metadata\": {\n \"request_id\": \"\",\n \"next_page_token\": \"\",\n \"page_number\": \"\",\n \"previous_page_token\": \"\",\n \"total_items\": \"\",\n \"total_pages\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2dc5f35e-53b4-47f4-88ac-608dc9fe299d", "name": "Internal server error", "originalRequest": { "url": { "path": [ "v1", "omni-ai", "responses", ":response_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Lists only conversations for this account, or unlinked conversations when omitted.\nOther reads authorize the resource's linked account.\nOmit when no account is selected; empty values and the string null are invalid.", "type": "text/plain" }, "key": "account_id", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"elit_5c8\": -44988772,\n \"proident_9\": -8115168,\n \"dolore_711\": \"cillum\"\n },\n {\n \"est_9\": \"sit nisi cupidatat pariatur\",\n \"pariatur_a\": 46992893\n }\n ]\n },\n \"metadata\": {\n \"request_id\": \"\",\n \"next_page_token\": \"\",\n \"page_number\": \"\",\n \"previous_page_token\": \"\",\n \"total_items\": \"\",\n \"total_pages\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5caf2dec-739f-4c18-a348-f7d07ea95073", "name": "Get Threads", "request": { "name": "Get Threads", "description": { "content": "List authorized conversation metadata, newest first. Use `page_size` and\n`page_token` for pagination, and the messages endpoint for conversation history.\n\nWith `account_id`, list only conversations linked to that account and require\ncurrent account access. Without it, list only conversations with no linked account.", "type": "text/plain" }, "url": { "path": [ "v1", "omni-ai", "threads" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Lists only conversations for this account, or unlinked conversations when omitted.\nOther reads authorize the resource's linked account.\nOmit when no account is selected; empty values and the string null are invalid.", "type": "text/plain" }, "key": "account_id", "value": "" }, { "disabled": false, "description": { "content": "The number of items to return per page. Only used when page_token is not provided.", "type": "text/plain" }, "key": "page_size", "value": "100" }, { "disabled": false, "description": { "content": "Token for retrieving the next or previous page of results. Contains encoded pagination state; when provided, page_size is ignored.", "type": "text/plain" }, "key": "page_token", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "731a8385-ffe7-46e1-ae5a-572e38e078e9", "name": "Paginated list of thread metadata", "originalRequest": { "url": { "path": [ "v1", "omni-ai", "threads" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Lists only conversations for this account, or unlinked conversations when omitted.\nOther reads authorize the resource's linked account.\nOmit when no account is selected; empty values and the string null are invalid.", "type": "text/plain" }, "key": "account_id", "value": "" }, { "disabled": false, "description": { "content": "The number of items to return per page. Only used when page_token is not provided.", "type": "text/plain" }, "key": "page_size", "value": "100" }, { "disabled": false, "description": { "content": "Token for retrieving the next or previous page of results. Contains encoded pagination state; when provided, page_size is ignored.", "type": "text/plain" }, "key": "page_token", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"title\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n {\n \"id\": \"\",\n \"title\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n ],\n \"metadata\": {\n \"request_id\": \"\",\n \"next_page_token\": \"\",\n \"page_number\": \"\",\n \"previous_page_token\": \"\",\n \"total_items\": \"\",\n \"total_pages\": \"\"\n },\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4cd07731-4540-4363-a545-ed95570b7608", "name": "Invalid request or supplied account ID", "originalRequest": { "url": { "path": [ "v1", "omni-ai", "threads" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Lists only conversations for this account, or unlinked conversations when omitted.\nOther reads authorize the resource's linked account.\nOmit when no account is selected; empty values and the string null are invalid.", "type": "text/plain" }, "key": "account_id", "value": "" }, { "disabled": false, "description": { "content": "The number of items to return per page. Only used when page_token is not provided.", "type": "text/plain" }, "key": "page_size", "value": "100" }, { "disabled": false, "description": { "content": "Token for retrieving the next or previous page of results. Contains encoded pagination state; when provided, page_size is ignored.", "type": "text/plain" }, "key": "page_token", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"elit_5c8\": -44988772,\n \"proident_9\": -8115168,\n \"dolore_711\": \"cillum\"\n },\n {\n \"est_9\": \"sit nisi cupidatat pariatur\",\n \"pariatur_a\": 46992893\n }\n ]\n },\n \"metadata\": {\n \"request_id\": \"\",\n \"next_page_token\": \"\",\n \"page_number\": \"\",\n \"previous_page_token\": \"\",\n \"total_items\": \"\",\n \"total_pages\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0050687a-10ed-4d04-8e61-daeb98132458", "name": "Authentication required", "originalRequest": { "url": { "path": [ "v1", "omni-ai", "threads" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Lists only conversations for this account, or unlinked conversations when omitted.\nOther reads authorize the resource's linked account.\nOmit when no account is selected; empty values and the string null are invalid.", "type": "text/plain" }, "key": "account_id", "value": "" }, { "disabled": false, "description": { "content": "The number of items to return per page. Only used when page_token is not provided.", "type": "text/plain" }, "key": "page_size", "value": "100" }, { "disabled": false, "description": { "content": "Token for retrieving the next or previous page of results. Contains encoded pagination state; when provided, page_size is ignored.", "type": "text/plain" }, "key": "page_token", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"elit_5c8\": -44988772,\n \"proident_9\": -8115168,\n \"dolore_711\": \"cillum\"\n },\n {\n \"est_9\": \"sit nisi cupidatat pariatur\",\n \"pariatur_a\": 46992893\n }\n ]\n },\n \"metadata\": {\n \"request_id\": \"\",\n \"next_page_token\": \"\",\n \"page_number\": \"\",\n \"previous_page_token\": \"\",\n \"total_items\": \"\",\n \"total_pages\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "995aecf1-2a6d-429c-9717-c27cd72bbad6", "name": "Caller lacks linked-account access", "originalRequest": { "url": { "path": [ "v1", "omni-ai", "threads" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Lists only conversations for this account, or unlinked conversations when omitted.\nOther reads authorize the resource's linked account.\nOmit when no account is selected; empty values and the string null are invalid.", "type": "text/plain" }, "key": "account_id", "value": "" }, { "disabled": false, "description": { "content": "The number of items to return per page. Only used when page_token is not provided.", "type": "text/plain" }, "key": "page_size", "value": "100" }, { "disabled": false, "description": { "content": "Token for retrieving the next or previous page of results. Contains encoded pagination state; when provided, page_size is ignored.", "type": "text/plain" }, "key": "page_token", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"elit_5c8\": -44988772,\n \"proident_9\": -8115168,\n \"dolore_711\": \"cillum\"\n },\n {\n \"est_9\": \"sit nisi cupidatat pariatur\",\n \"pariatur_a\": 46992893\n }\n ]\n },\n \"metadata\": {\n \"request_id\": \"\",\n \"next_page_token\": \"\",\n \"page_number\": \"\",\n \"previous_page_token\": \"\",\n \"total_items\": \"\",\n \"total_pages\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4e350fa0-0072-46d5-92b9-50430c291035", "name": "Resource not found or not owned by caller", "originalRequest": { "url": { "path": [ "v1", "omni-ai", "threads" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Lists only conversations for this account, or unlinked conversations when omitted.\nOther reads authorize the resource's linked account.\nOmit when no account is selected; empty values and the string null are invalid.", "type": "text/plain" }, "key": "account_id", "value": "" }, { "disabled": false, "description": { "content": "The number of items to return per page. Only used when page_token is not provided.", "type": "text/plain" }, "key": "page_size", "value": "100" }, { "disabled": false, "description": { "content": "Token for retrieving the next or previous page of results. Contains encoded pagination state; when provided, page_size is ignored.", "type": "text/plain" }, "key": "page_token", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"elit_5c8\": -44988772,\n \"proident_9\": -8115168,\n \"dolore_711\": \"cillum\"\n },\n {\n \"est_9\": \"sit nisi cupidatat pariatur\",\n \"pariatur_a\": 46992893\n }\n ]\n },\n \"metadata\": {\n \"request_id\": \"\",\n \"next_page_token\": \"\",\n \"page_number\": \"\",\n \"previous_page_token\": \"\",\n \"total_items\": \"\",\n \"total_pages\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "21006040-23fc-4204-bf51-957f11cac97f", "name": "Thread scope changed, active response, or conflicting retry; refresh before retrying", "originalRequest": { "url": { "path": [ "v1", "omni-ai", "threads" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Lists only conversations for this account, or unlinked conversations when omitted.\nOther reads authorize the resource's linked account.\nOmit when no account is selected; empty values and the string null are invalid.", "type": "text/plain" }, "key": "account_id", "value": "" }, { "disabled": false, "description": { "content": "The number of items to return per page. Only used when page_token is not provided.", "type": "text/plain" }, "key": "page_size", "value": "100" }, { "disabled": false, "description": { "content": "Token for retrieving the next or previous page of results. Contains encoded pagination state; when provided, page_size is ignored.", "type": "text/plain" }, "key": "page_token", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"elit_5c8\": -44988772,\n \"proident_9\": -8115168,\n \"dolore_711\": \"cillum\"\n },\n {\n \"est_9\": \"sit nisi cupidatat pariatur\",\n \"pariatur_a\": 46992893\n }\n ]\n },\n \"metadata\": {\n \"request_id\": \"\",\n \"next_page_token\": \"\",\n \"page_number\": \"\",\n \"previous_page_token\": \"\",\n \"total_items\": \"\",\n \"total_pages\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9c56f298-72b1-4d17-a3ee-f8790a709450", "name": "Internal server error", "originalRequest": { "url": { "path": [ "v1", "omni-ai", "threads" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Lists only conversations for this account, or unlinked conversations when omitted.\nOther reads authorize the resource's linked account.\nOmit when no account is selected; empty values and the string null are invalid.", "type": "text/plain" }, "key": "account_id", "value": "" }, { "disabled": false, "description": { "content": "The number of items to return per page. Only used when page_token is not provided.", "type": "text/plain" }, "key": "page_size", "value": "100" }, { "disabled": false, "description": { "content": "Token for retrieving the next or previous page of results. Contains encoded pagination state; when provided, page_size is ignored.", "type": "text/plain" }, "key": "page_token", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"elit_5c8\": -44988772,\n \"proident_9\": -8115168,\n \"dolore_711\": \"cillum\"\n },\n {\n \"est_9\": \"sit nisi cupidatat pariatur\",\n \"pariatur_a\": 46992893\n }\n ]\n },\n \"metadata\": {\n \"request_id\": \"\",\n \"next_page_token\": \"\",\n \"page_number\": \"\",\n \"previous_page_token\": \"\",\n \"total_items\": \"\",\n \"total_pages\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "19a95cdb-b82d-4d2f-8e7a-b8fe51431208", "name": "Create Thread", "request": { "name": "Create Thread", "description": { "content": "Atomically create a conversation and submit its first user turn.\nUse `instant` with `text` for a prompt, or `deep_insights` with a ticker\n`target` and optional `thesis` for long-form research.\n\nPoll the returned `response_id` via `GET /omni-ai/responses/{response_id}`\nfor assistant output.\n\nOmit `account_id` to start without an account. The first accepted turn with\na selected account links that account permanently. Reuse `Idempotency-Key`\nonly for an identical request.", "type": "text/plain" }, "url": { "path": [ "v1", "omni-ai", "threads" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"instant\",\n \"account_id\": \"\",\n \"capabilities\": [\n \"OPEN_SCREENER\",\n \"OPEN_CHART\"\n ],\n \"context\": \"\",\n \"target\": \"\",\n \"text\": \"\",\n \"thesis\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "fceec0e5-5b8d-498c-b2d9-a2e3a6f67822", "name": "Thread created. Poll the returned `response_id` for assistant output.", "originalRequest": { "url": { "path": [ "v1", "omni-ai", "threads" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"instant\",\n \"account_id\": \"\",\n \"capabilities\": [\n \"OPEN_SCREENER\",\n \"OPEN_CHART\"\n ],\n \"context\": \"\",\n \"target\": \"\",\n \"text\": \"\",\n \"thesis\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"response_id\": \"\",\n \"thread_id\": \"\",\n \"user_message_id\": \"\"\n },\n \"metadata\": {\n \"request_id\": \"\",\n \"next_page_token\": \"\",\n \"page_number\": \"\",\n \"previous_page_token\": \"\",\n \"total_items\": \"\",\n \"total_pages\": \"\"\n },\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a53d4187-46f6-4752-97fe-40b0917e2642", "name": "Invalid request or supplied account ID", "originalRequest": { "url": { "path": [ "v1", "omni-ai", "threads" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"instant\",\n \"account_id\": \"\",\n \"capabilities\": [\n \"OPEN_SCREENER\",\n \"OPEN_CHART\"\n ],\n \"context\": \"\",\n \"target\": \"\",\n \"text\": \"\",\n \"thesis\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"elit_5c8\": -44988772,\n \"proident_9\": -8115168,\n \"dolore_711\": \"cillum\"\n },\n {\n \"est_9\": \"sit nisi cupidatat pariatur\",\n \"pariatur_a\": 46992893\n }\n ]\n },\n \"metadata\": {\n \"request_id\": \"\",\n \"next_page_token\": \"\",\n \"page_number\": \"\",\n \"previous_page_token\": \"\",\n \"total_items\": \"\",\n \"total_pages\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "981a1186-5363-4b60-bee9-0d6cf8054123", "name": "Authentication required", "originalRequest": { "url": { "path": [ "v1", "omni-ai", "threads" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"instant\",\n \"account_id\": \"\",\n \"capabilities\": [\n \"OPEN_SCREENER\",\n \"OPEN_CHART\"\n ],\n \"context\": \"\",\n \"target\": \"\",\n \"text\": \"\",\n \"thesis\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"elit_5c8\": -44988772,\n \"proident_9\": -8115168,\n \"dolore_711\": \"cillum\"\n },\n {\n \"est_9\": \"sit nisi cupidatat pariatur\",\n \"pariatur_a\": 46992893\n }\n ]\n },\n \"metadata\": {\n \"request_id\": \"\",\n \"next_page_token\": \"\",\n \"page_number\": \"\",\n \"previous_page_token\": \"\",\n \"total_items\": \"\",\n \"total_pages\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1b4f9c04-9bb1-4494-8591-fc9391fa98fb", "name": "Caller lacks linked-account access", "originalRequest": { "url": { "path": [ "v1", "omni-ai", "threads" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"instant\",\n \"account_id\": \"\",\n \"capabilities\": [\n \"OPEN_SCREENER\",\n \"OPEN_CHART\"\n ],\n \"context\": \"\",\n \"target\": \"\",\n \"text\": \"\",\n \"thesis\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"elit_5c8\": -44988772,\n \"proident_9\": -8115168,\n \"dolore_711\": \"cillum\"\n },\n {\n \"est_9\": \"sit nisi cupidatat pariatur\",\n \"pariatur_a\": 46992893\n }\n ]\n },\n \"metadata\": {\n \"request_id\": \"\",\n \"next_page_token\": \"\",\n \"page_number\": \"\",\n \"previous_page_token\": \"\",\n \"total_items\": \"\",\n \"total_pages\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fbf9ae7d-5079-4dfa-92c5-746d67b22b21", "name": "Resource not found or not owned by caller", "originalRequest": { "url": { "path": [ "v1", "omni-ai", "threads" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"instant\",\n \"account_id\": \"\",\n \"capabilities\": [\n \"OPEN_SCREENER\",\n \"OPEN_CHART\"\n ],\n \"context\": \"\",\n \"target\": \"\",\n \"text\": \"\",\n \"thesis\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"elit_5c8\": -44988772,\n \"proident_9\": -8115168,\n \"dolore_711\": \"cillum\"\n },\n {\n \"est_9\": \"sit nisi cupidatat pariatur\",\n \"pariatur_a\": 46992893\n }\n ]\n },\n \"metadata\": {\n \"request_id\": \"\",\n \"next_page_token\": \"\",\n \"page_number\": \"\",\n \"previous_page_token\": \"\",\n \"total_items\": \"\",\n \"total_pages\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ea43173c-7fae-4018-9c37-c17525ba2db1", "name": "Thread scope changed, active response, or conflicting retry; refresh before retrying", "originalRequest": { "url": { "path": [ "v1", "omni-ai", "threads" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"instant\",\n \"account_id\": \"\",\n \"capabilities\": [\n \"OPEN_SCREENER\",\n \"OPEN_CHART\"\n ],\n \"context\": \"\",\n \"target\": \"\",\n \"text\": \"\",\n \"thesis\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"elit_5c8\": -44988772,\n \"proident_9\": -8115168,\n \"dolore_711\": \"cillum\"\n },\n {\n \"est_9\": \"sit nisi cupidatat pariatur\",\n \"pariatur_a\": 46992893\n }\n ]\n },\n \"metadata\": {\n \"request_id\": \"\",\n \"next_page_token\": \"\",\n \"page_number\": \"\",\n \"previous_page_token\": \"\",\n \"total_items\": \"\",\n \"total_pages\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cf6b9719-11c6-48a5-b823-0fbf5fc5fad1", "name": "Malformed request payload", "originalRequest": { "url": { "path": [ "v1", "omni-ai", "threads" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"instant\",\n \"account_id\": \"\",\n \"capabilities\": [\n \"OPEN_SCREENER\",\n \"OPEN_CHART\"\n ],\n \"context\": \"\",\n \"target\": \"\",\n \"text\": \"\",\n \"thesis\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"elit_5c8\": -44988772,\n \"proident_9\": -8115168,\n \"dolore_711\": \"cillum\"\n },\n {\n \"est_9\": \"sit nisi cupidatat pariatur\",\n \"pariatur_a\": 46992893\n }\n ]\n },\n \"metadata\": {\n \"request_id\": \"\",\n \"next_page_token\": \"\",\n \"page_number\": \"\",\n \"previous_page_token\": \"\",\n \"total_items\": \"\",\n \"total_pages\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6e29910e-b4f6-4922-aa2b-ec1c29940d3f", "name": "Internal server error", "originalRequest": { "url": { "path": [ "v1", "omni-ai", "threads" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"instant\",\n \"account_id\": \"\",\n \"capabilities\": [\n \"OPEN_SCREENER\",\n \"OPEN_CHART\"\n ],\n \"context\": \"\",\n \"target\": \"\",\n \"text\": \"\",\n \"thesis\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"elit_5c8\": -44988772,\n \"proident_9\": -8115168,\n \"dolore_711\": \"cillum\"\n },\n {\n \"est_9\": \"sit nisi cupidatat pariatur\",\n \"pariatur_a\": 46992893\n }\n ]\n },\n \"metadata\": {\n \"request_id\": \"\",\n \"next_page_token\": \"\",\n \"page_number\": \"\",\n \"previous_page_token\": \"\",\n \"total_items\": \"\",\n \"total_pages\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d652d739-e7bb-4de8-bac8-a9cb0c1d4f45", "name": "Get Thread", "request": { "name": "Get Thread", "description": { "content": "Read an owned thread's metadata.\nUse `GET /omni-ai/threads/{thread_id}/messages` for conversation history.\n\nOmission or another account selection does not change authorization.", "type": "text/plain" }, "url": { "path": [ "v1", "omni-ai", "threads", ":thread_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Lists only conversations for this account, or unlinked conversations when omitted.\nOther reads authorize the resource's linked account.\nOmit when no account is selected; empty values and the string null are invalid.", "type": "text/plain" }, "key": "account_id", "value": "" } ], "variable": [ { "type": "any", "value": "", "key": "thread_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "95ac8e86-3163-437f-9aca-23f9e362970d", "name": "Thread metadata", "originalRequest": { "url": { "path": [ "v1", "omni-ai", "threads", ":thread_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Lists only conversations for this account, or unlinked conversations when omitted.\nOther reads authorize the resource's linked account.\nOmit when no account is selected; empty values and the string null are invalid.", "type": "text/plain" }, "key": "account_id", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"\",\n \"title\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n \"metadata\": {\n \"request_id\": \"\",\n \"next_page_token\": \"\",\n \"page_number\": \"\",\n \"previous_page_token\": \"\",\n \"total_items\": \"\",\n \"total_pages\": \"\"\n },\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e4a1d632-b602-4857-85f1-598477d9fba5", "name": "Invalid request or supplied account ID", "originalRequest": { "url": { "path": [ "v1", "omni-ai", "threads", ":thread_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Lists only conversations for this account, or unlinked conversations when omitted.\nOther reads authorize the resource's linked account.\nOmit when no account is selected; empty values and the string null are invalid.", "type": "text/plain" }, "key": "account_id", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"elit_5c8\": -44988772,\n \"proident_9\": -8115168,\n \"dolore_711\": \"cillum\"\n },\n {\n \"est_9\": \"sit nisi cupidatat pariatur\",\n \"pariatur_a\": 46992893\n }\n ]\n },\n \"metadata\": {\n \"request_id\": \"\",\n \"next_page_token\": \"\",\n \"page_number\": \"\",\n \"previous_page_token\": \"\",\n \"total_items\": \"\",\n \"total_pages\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "efc40789-f5a8-4683-8a13-5bff792d6d56", "name": "Authentication required", "originalRequest": { "url": { "path": [ "v1", "omni-ai", "threads", ":thread_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Lists only conversations for this account, or unlinked conversations when omitted.\nOther reads authorize the resource's linked account.\nOmit when no account is selected; empty values and the string null are invalid.", "type": "text/plain" }, "key": "account_id", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"elit_5c8\": -44988772,\n \"proident_9\": -8115168,\n \"dolore_711\": \"cillum\"\n },\n {\n \"est_9\": \"sit nisi cupidatat pariatur\",\n \"pariatur_a\": 46992893\n }\n ]\n },\n \"metadata\": {\n \"request_id\": \"\",\n \"next_page_token\": \"\",\n \"page_number\": \"\",\n \"previous_page_token\": \"\",\n \"total_items\": \"\",\n \"total_pages\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3f903e9c-3048-43c5-9ece-ddb3ff32b4ef", "name": "Caller lacks linked-account access", "originalRequest": { "url": { "path": [ "v1", "omni-ai", "threads", ":thread_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Lists only conversations for this account, or unlinked conversations when omitted.\nOther reads authorize the resource's linked account.\nOmit when no account is selected; empty values and the string null are invalid.", "type": "text/plain" }, "key": "account_id", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"elit_5c8\": -44988772,\n \"proident_9\": -8115168,\n \"dolore_711\": \"cillum\"\n },\n {\n \"est_9\": \"sit nisi cupidatat pariatur\",\n \"pariatur_a\": 46992893\n }\n ]\n },\n \"metadata\": {\n \"request_id\": \"\",\n \"next_page_token\": \"\",\n \"page_number\": \"\",\n \"previous_page_token\": \"\",\n \"total_items\": \"\",\n \"total_pages\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4c93fa57-a703-4c44-9047-631048c82e8f", "name": "Resource not found or not owned by caller", "originalRequest": { "url": { "path": [ "v1", "omni-ai", "threads", ":thread_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Lists only conversations for this account, or unlinked conversations when omitted.\nOther reads authorize the resource's linked account.\nOmit when no account is selected; empty values and the string null are invalid.", "type": "text/plain" }, "key": "account_id", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"elit_5c8\": -44988772,\n \"proident_9\": -8115168,\n \"dolore_711\": \"cillum\"\n },\n {\n \"est_9\": \"sit nisi cupidatat pariatur\",\n \"pariatur_a\": 46992893\n }\n ]\n },\n \"metadata\": {\n \"request_id\": \"\",\n \"next_page_token\": \"\",\n \"page_number\": \"\",\n \"previous_page_token\": \"\",\n \"total_items\": \"\",\n \"total_pages\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fbe31d60-f77e-4ca5-9106-ee9141fca38f", "name": "Thread scope changed, active response, or conflicting retry; refresh before retrying", "originalRequest": { "url": { "path": [ "v1", "omni-ai", "threads", ":thread_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Lists only conversations for this account, or unlinked conversations when omitted.\nOther reads authorize the resource's linked account.\nOmit when no account is selected; empty values and the string null are invalid.", "type": "text/plain" }, "key": "account_id", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"elit_5c8\": -44988772,\n \"proident_9\": -8115168,\n \"dolore_711\": \"cillum\"\n },\n {\n \"est_9\": \"sit nisi cupidatat pariatur\",\n \"pariatur_a\": 46992893\n }\n ]\n },\n \"metadata\": {\n \"request_id\": \"\",\n \"next_page_token\": \"\",\n \"page_number\": \"\",\n \"previous_page_token\": \"\",\n \"total_items\": \"\",\n \"total_pages\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e80aa6d2-b168-4b05-a9f4-86ea6670375d", "name": "Internal server error", "originalRequest": { "url": { "path": [ "v1", "omni-ai", "threads", ":thread_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Lists only conversations for this account, or unlinked conversations when omitted.\nOther reads authorize the resource's linked account.\nOmit when no account is selected; empty values and the string null are invalid.", "type": "text/plain" }, "key": "account_id", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"elit_5c8\": -44988772,\n \"proident_9\": -8115168,\n \"dolore_711\": \"cillum\"\n },\n {\n \"est_9\": \"sit nisi cupidatat pariatur\",\n \"pariatur_a\": 46992893\n }\n ]\n },\n \"metadata\": {\n \"request_id\": \"\",\n \"next_page_token\": \"\",\n \"page_number\": \"\",\n \"previous_page_token\": \"\",\n \"total_items\": \"\",\n \"total_pages\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8cc52361-4a66-4a89-9785-602700c35506", "name": "Get Messages", "request": { "name": "Get Messages", "description": { "content": "List finalized messages, including messages created before the account link.\nReturn the latest page by default, in chronological order within each page.\nUse the returned page token to navigate history.\n\nIn-progress assistant output is not included. Poll\n`GET /omni-ai/responses/{response_id}` until the response reaches a terminal\nstatus, then read its finalized message here.", "type": "text/plain" }, "url": { "path": [ "v1", "omni-ai", "threads", ":thread_id", "messages" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Lists only conversations for this account, or unlinked conversations when omitted.\nOther reads authorize the resource's linked account.\nOmit when no account is selected; empty values and the string null are invalid.", "type": "text/plain" }, "key": "account_id", "value": "" }, { "disabled": false, "description": { "content": "The number of items to return per page. Only used when page_token is not provided.", "type": "text/plain" }, "key": "page_size", "value": "100" }, { "disabled": false, "description": { "content": "Token for retrieving the next or previous page of results. Contains encoded pagination state; when provided, page_size is ignored.", "type": "text/plain" }, "key": "page_token", "value": "" } ], "variable": [ { "type": "any", "value": "", "key": "thread_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "11354089-cb4f-4793-a1fc-5b19436d0e4e", "name": "Paginated list of finalized messages; latest page by default, chronological within each page", "originalRequest": { "url": { "path": [ "v1", "omni-ai", "threads", ":thread_id", "messages" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Lists only conversations for this account, or unlinked conversations when omitted.\nOther reads authorize the resource's linked account.\nOmit when no account is selected; empty values and the string null are invalid.", "type": "text/plain" }, "key": "account_id", "value": "" }, { "disabled": false, "description": { "content": "The number of items to return per page. Only used when page_token is not provided.", "type": "text/plain" }, "key": "page_size", "value": "100" }, { "disabled": false, "description": { "content": "Token for retrieving the next or previous page of results. Contains encoded pagination state; when provided, page_size is ignored.", "type": "text/plain" }, "key": "page_token", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"thread_id\": \"\",\n \"created_at\": \"\",\n \"seq\": \"\",\n \"role\": \"USER\",\n \"outcome\": \"errored\",\n \"content\": {\n \"parts\": [\n {\n \"text\": \"\",\n \"type\": \"text\"\n },\n {\n \"text\": \"\",\n \"type\": \"text\"\n }\n ]\n },\n \"context\": \"\",\n \"error\": \"\"\n },\n {\n \"id\": \"\",\n \"thread_id\": \"\",\n \"created_at\": \"\",\n \"seq\": \"\",\n \"role\": \"USER\",\n \"outcome\": \"completed\",\n \"content\": {\n \"parts\": [\n {\n \"text\": \"\",\n \"type\": \"text\"\n },\n {\n \"text\": \"\",\n \"type\": \"text\"\n }\n ]\n },\n \"context\": \"\",\n \"error\": \"\"\n }\n ],\n \"metadata\": {\n \"request_id\": \"\",\n \"next_page_token\": \"\",\n \"page_number\": \"\",\n \"previous_page_token\": \"\",\n \"total_items\": \"\",\n \"total_pages\": \"\"\n },\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5accfec1-b724-44a8-9f42-217b2b2c9b74", "name": "Invalid request or supplied account ID", "originalRequest": { "url": { "path": [ "v1", "omni-ai", "threads", ":thread_id", "messages" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Lists only conversations for this account, or unlinked conversations when omitted.\nOther reads authorize the resource's linked account.\nOmit when no account is selected; empty values and the string null are invalid.", "type": "text/plain" }, "key": "account_id", "value": "" }, { "disabled": false, "description": { "content": "The number of items to return per page. Only used when page_token is not provided.", "type": "text/plain" }, "key": "page_size", "value": "100" }, { "disabled": false, "description": { "content": "Token for retrieving the next or previous page of results. Contains encoded pagination state; when provided, page_size is ignored.", "type": "text/plain" }, "key": "page_token", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"elit_5c8\": -44988772,\n \"proident_9\": -8115168,\n \"dolore_711\": \"cillum\"\n },\n {\n \"est_9\": \"sit nisi cupidatat pariatur\",\n \"pariatur_a\": 46992893\n }\n ]\n },\n \"metadata\": {\n \"request_id\": \"\",\n \"next_page_token\": \"\",\n \"page_number\": \"\",\n \"previous_page_token\": \"\",\n \"total_items\": \"\",\n \"total_pages\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3b99a1d9-121f-4dc8-b7f3-945ad3195a82", "name": "Authentication required", "originalRequest": { "url": { "path": [ "v1", "omni-ai", "threads", ":thread_id", "messages" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Lists only conversations for this account, or unlinked conversations when omitted.\nOther reads authorize the resource's linked account.\nOmit when no account is selected; empty values and the string null are invalid.", "type": "text/plain" }, "key": "account_id", "value": "" }, { "disabled": false, "description": { "content": "The number of items to return per page. Only used when page_token is not provided.", "type": "text/plain" }, "key": "page_size", "value": "100" }, { "disabled": false, "description": { "content": "Token for retrieving the next or previous page of results. Contains encoded pagination state; when provided, page_size is ignored.", "type": "text/plain" }, "key": "page_token", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"elit_5c8\": -44988772,\n \"proident_9\": -8115168,\n \"dolore_711\": \"cillum\"\n },\n {\n \"est_9\": \"sit nisi cupidatat pariatur\",\n \"pariatur_a\": 46992893\n }\n ]\n },\n \"metadata\": {\n \"request_id\": \"\",\n \"next_page_token\": \"\",\n \"page_number\": \"\",\n \"previous_page_token\": \"\",\n \"total_items\": \"\",\n \"total_pages\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b9f9215e-459a-40a5-b35e-a7c070a71bd4", "name": "Caller lacks linked-account access", "originalRequest": { "url": { "path": [ "v1", "omni-ai", "threads", ":thread_id", "messages" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Lists only conversations for this account, or unlinked conversations when omitted.\nOther reads authorize the resource's linked account.\nOmit when no account is selected; empty values and the string null are invalid.", "type": "text/plain" }, "key": "account_id", "value": "" }, { "disabled": false, "description": { "content": "The number of items to return per page. Only used when page_token is not provided.", "type": "text/plain" }, "key": "page_size", "value": "100" }, { "disabled": false, "description": { "content": "Token for retrieving the next or previous page of results. Contains encoded pagination state; when provided, page_size is ignored.", "type": "text/plain" }, "key": "page_token", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"elit_5c8\": -44988772,\n \"proident_9\": -8115168,\n \"dolore_711\": \"cillum\"\n },\n {\n \"est_9\": \"sit nisi cupidatat pariatur\",\n \"pariatur_a\": 46992893\n }\n ]\n },\n \"metadata\": {\n \"request_id\": \"\",\n \"next_page_token\": \"\",\n \"page_number\": \"\",\n \"previous_page_token\": \"\",\n \"total_items\": \"\",\n \"total_pages\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "acbfe023-0238-4689-a871-544433ab305b", "name": "Resource not found or not owned by caller", "originalRequest": { "url": { "path": [ "v1", "omni-ai", "threads", ":thread_id", "messages" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Lists only conversations for this account, or unlinked conversations when omitted.\nOther reads authorize the resource's linked account.\nOmit when no account is selected; empty values and the string null are invalid.", "type": "text/plain" }, "key": "account_id", "value": "" }, { "disabled": false, "description": { "content": "The number of items to return per page. Only used when page_token is not provided.", "type": "text/plain" }, "key": "page_size", "value": "100" }, { "disabled": false, "description": { "content": "Token for retrieving the next or previous page of results. Contains encoded pagination state; when provided, page_size is ignored.", "type": "text/plain" }, "key": "page_token", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"elit_5c8\": -44988772,\n \"proident_9\": -8115168,\n \"dolore_711\": \"cillum\"\n },\n {\n \"est_9\": \"sit nisi cupidatat pariatur\",\n \"pariatur_a\": 46992893\n }\n ]\n },\n \"metadata\": {\n \"request_id\": \"\",\n \"next_page_token\": \"\",\n \"page_number\": \"\",\n \"previous_page_token\": \"\",\n \"total_items\": \"\",\n \"total_pages\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3ee87941-4990-4445-9701-8d75aedcc1b6", "name": "Thread scope changed, active response, or conflicting retry; refresh before retrying", "originalRequest": { "url": { "path": [ "v1", "omni-ai", "threads", ":thread_id", "messages" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Lists only conversations for this account, or unlinked conversations when omitted.\nOther reads authorize the resource's linked account.\nOmit when no account is selected; empty values and the string null are invalid.", "type": "text/plain" }, "key": "account_id", "value": "" }, { "disabled": false, "description": { "content": "The number of items to return per page. Only used when page_token is not provided.", "type": "text/plain" }, "key": "page_size", "value": "100" }, { "disabled": false, "description": { "content": "Token for retrieving the next or previous page of results. Contains encoded pagination state; when provided, page_size is ignored.", "type": "text/plain" }, "key": "page_token", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"elit_5c8\": -44988772,\n \"proident_9\": -8115168,\n \"dolore_711\": \"cillum\"\n },\n {\n \"est_9\": \"sit nisi cupidatat pariatur\",\n \"pariatur_a\": 46992893\n }\n ]\n },\n \"metadata\": {\n \"request_id\": \"\",\n \"next_page_token\": \"\",\n \"page_number\": \"\",\n \"previous_page_token\": \"\",\n \"total_items\": \"\",\n \"total_pages\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bd9d1d2f-0271-40ed-ba24-99236533b1e6", "name": "Internal server error", "originalRequest": { "url": { "path": [ "v1", "omni-ai", "threads", ":thread_id", "messages" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Lists only conversations for this account, or unlinked conversations when omitted.\nOther reads authorize the resource's linked account.\nOmit when no account is selected; empty values and the string null are invalid.", "type": "text/plain" }, "key": "account_id", "value": "" }, { "disabled": false, "description": { "content": "The number of items to return per page. Only used when page_token is not provided.", "type": "text/plain" }, "key": "page_size", "value": "100" }, { "disabled": false, "description": { "content": "Token for retrieving the next or previous page of results. Contains encoded pagination state; when provided, page_size is ignored.", "type": "text/plain" }, "key": "page_token", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"elit_5c8\": -44988772,\n \"proident_9\": -8115168,\n \"dolore_711\": \"cillum\"\n },\n {\n \"est_9\": \"sit nisi cupidatat pariatur\",\n \"pariatur_a\": 46992893\n }\n ]\n },\n \"metadata\": {\n \"request_id\": \"\",\n \"next_page_token\": \"\",\n \"page_number\": \"\",\n \"previous_page_token\": \"\",\n \"total_items\": \"\",\n \"total_pages\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6f821cc7-e544-47cb-9ebf-486c0d020039", "name": "Create Message", "request": { "name": "Create Message", "description": { "content": "Append a user message to an existing thread and start an assistant response.\nPoll the returned `response_id` via `GET /omni-ai/responses/{response_id}`\nfor assistant output.\n\nOnly one response may be active per thread. Wait for it to reach a terminal\nstatus before submitting another turn; otherwise this endpoint returns 409.\n\nThe first accepted selected-account message links an unlinked thread.\nA linked thread keeps its account regardless of omission or another\nselection. A changed scope also returns 409 without accepting a turn.", "type": "text/plain" }, "url": { "path": [ "v1", "omni-ai", "threads", ":thread_id", "messages" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "thread_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"text\": \"\",\n \"account_id\": \"\",\n \"capabilities\": [\n \"OPEN_SCREENER\",\n \"OPEN_CHART\"\n ],\n \"context\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "d6fe8a1c-af77-4dd7-9361-5d5de18b0932", "name": "Message accepted. Poll the returned `response_id` for assistant output.", "originalRequest": { "url": { "path": [ "v1", "omni-ai", "threads", ":thread_id", "messages" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"text\": \"\",\n \"account_id\": \"\",\n \"capabilities\": [\n \"OPEN_SCREENER\",\n \"OPEN_CHART\"\n ],\n \"context\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"response_id\": \"\",\n \"thread_id\": \"\",\n \"user_message_id\": \"\"\n },\n \"metadata\": {\n \"request_id\": \"\",\n \"next_page_token\": \"\",\n \"page_number\": \"\",\n \"previous_page_token\": \"\",\n \"total_items\": \"\",\n \"total_pages\": \"\"\n },\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "39f0762e-fb96-4cee-98d1-a221693c6b11", "name": "Invalid request or supplied account ID", "originalRequest": { "url": { "path": [ "v1", "omni-ai", "threads", ":thread_id", "messages" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"text\": \"\",\n \"account_id\": \"\",\n \"capabilities\": [\n \"OPEN_SCREENER\",\n \"OPEN_CHART\"\n ],\n \"context\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"elit_5c8\": -44988772,\n \"proident_9\": -8115168,\n \"dolore_711\": \"cillum\"\n },\n {\n \"est_9\": \"sit nisi cupidatat pariatur\",\n \"pariatur_a\": 46992893\n }\n ]\n },\n \"metadata\": {\n \"request_id\": \"\",\n \"next_page_token\": \"\",\n \"page_number\": \"\",\n \"previous_page_token\": \"\",\n \"total_items\": \"\",\n \"total_pages\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1d386e7a-f388-40c6-ad07-1a5e17f661a3", "name": "Authentication required", "originalRequest": { "url": { "path": [ "v1", "omni-ai", "threads", ":thread_id", "messages" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"text\": \"\",\n \"account_id\": \"\",\n \"capabilities\": [\n \"OPEN_SCREENER\",\n \"OPEN_CHART\"\n ],\n \"context\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"elit_5c8\": -44988772,\n \"proident_9\": -8115168,\n \"dolore_711\": \"cillum\"\n },\n {\n \"est_9\": \"sit nisi cupidatat pariatur\",\n \"pariatur_a\": 46992893\n }\n ]\n },\n \"metadata\": {\n \"request_id\": \"\",\n \"next_page_token\": \"\",\n \"page_number\": \"\",\n \"previous_page_token\": \"\",\n \"total_items\": \"\",\n \"total_pages\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ceffa7c7-25e1-4860-9268-325b24774b9b", "name": "Caller lacks linked-account access", "originalRequest": { "url": { "path": [ "v1", "omni-ai", "threads", ":thread_id", "messages" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"text\": \"\",\n \"account_id\": \"\",\n \"capabilities\": [\n \"OPEN_SCREENER\",\n \"OPEN_CHART\"\n ],\n \"context\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"elit_5c8\": -44988772,\n \"proident_9\": -8115168,\n \"dolore_711\": \"cillum\"\n },\n {\n \"est_9\": \"sit nisi cupidatat pariatur\",\n \"pariatur_a\": 46992893\n }\n ]\n },\n \"metadata\": {\n \"request_id\": \"\",\n \"next_page_token\": \"\",\n \"page_number\": \"\",\n \"previous_page_token\": \"\",\n \"total_items\": \"\",\n \"total_pages\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "54d96ffc-47ad-475e-8a52-9ed7dc67c4e1", "name": "Resource not found or not owned by caller", "originalRequest": { "url": { "path": [ "v1", "omni-ai", "threads", ":thread_id", "messages" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"text\": \"\",\n \"account_id\": \"\",\n \"capabilities\": [\n \"OPEN_SCREENER\",\n \"OPEN_CHART\"\n ],\n \"context\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"elit_5c8\": -44988772,\n \"proident_9\": -8115168,\n \"dolore_711\": \"cillum\"\n },\n {\n \"est_9\": \"sit nisi cupidatat pariatur\",\n \"pariatur_a\": 46992893\n }\n ]\n },\n \"metadata\": {\n \"request_id\": \"\",\n \"next_page_token\": \"\",\n \"page_number\": \"\",\n \"previous_page_token\": \"\",\n \"total_items\": \"\",\n \"total_pages\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b1355092-7dac-422d-a3b7-4a325494dddc", "name": "Thread scope changed, active response, or conflicting retry; refresh before retrying", "originalRequest": { "url": { "path": [ "v1", "omni-ai", "threads", ":thread_id", "messages" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"text\": \"\",\n \"account_id\": \"\",\n \"capabilities\": [\n \"OPEN_SCREENER\",\n \"OPEN_CHART\"\n ],\n \"context\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"elit_5c8\": -44988772,\n \"proident_9\": -8115168,\n \"dolore_711\": \"cillum\"\n },\n {\n \"est_9\": \"sit nisi cupidatat pariatur\",\n \"pariatur_a\": 46992893\n }\n ]\n },\n \"metadata\": {\n \"request_id\": \"\",\n \"next_page_token\": \"\",\n \"page_number\": \"\",\n \"previous_page_token\": \"\",\n \"total_items\": \"\",\n \"total_pages\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0068782f-6b3a-4f68-a318-04bd202e68d2", "name": "Malformed request payload", "originalRequest": { "url": { "path": [ "v1", "omni-ai", "threads", ":thread_id", "messages" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"text\": \"\",\n \"account_id\": \"\",\n \"capabilities\": [\n \"OPEN_SCREENER\",\n \"OPEN_CHART\"\n ],\n \"context\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"elit_5c8\": -44988772,\n \"proident_9\": -8115168,\n \"dolore_711\": \"cillum\"\n },\n {\n \"est_9\": \"sit nisi cupidatat pariatur\",\n \"pariatur_a\": 46992893\n }\n ]\n },\n \"metadata\": {\n \"request_id\": \"\",\n \"next_page_token\": \"\",\n \"page_number\": \"\",\n \"previous_page_token\": \"\",\n \"total_items\": \"\",\n \"total_pages\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e04ebf08-a2e4-4d4c-a455-8c334ff61c03", "name": "Internal server error", "originalRequest": { "url": { "path": [ "v1", "omni-ai", "threads", ":thread_id", "messages" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"text\": \"\",\n \"account_id\": \"\",\n \"capabilities\": [\n \"OPEN_SCREENER\",\n \"OPEN_CHART\"\n ],\n \"context\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"elit_5c8\": -44988772,\n \"proident_9\": -8115168,\n \"dolore_711\": \"cillum\"\n },\n {\n \"est_9\": \"sit nisi cupidatat pariatur\",\n \"pariatur_a\": 46992893\n }\n ]\n },\n \"metadata\": {\n \"request_id\": \"\",\n \"next_page_token\": \"\",\n \"page_number\": \"\",\n \"previous_page_token\": \"\",\n \"total_items\": \"\",\n \"total_pages\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "515b21a9-5265-4d02-81f6-60b04afcfb8e", "name": "Get Thread Response", "request": { "name": "Get Thread Response", "description": { "content": "Look up the currently active response without knowing its `response_id`.\nUse this endpoint when reopening a thread whose assistant turn may still\nbe in progress.\n\nAn idle owned thread returns HTTP 200 with `data: null`.", "type": "text/plain" }, "url": { "path": [ "v1", "omni-ai", "threads", ":thread_id", "response" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Lists only conversations for this account, or unlinked conversations when omitted.\nOther reads authorize the resource's linked account.\nOmit when no account is selected; empty values and the string null are invalid.", "type": "text/plain" }, "key": "account_id", "value": "" } ], "variable": [ { "type": "any", "value": "", "key": "thread_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "1e32e5c3-21d7-4078-90c9-98b043a0352a", "name": "Current response snapshot or idle thread", "originalRequest": { "url": { "path": [ "v1", "omni-ai", "threads", ":thread_id", "response" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Lists only conversations for this account, or unlinked conversations when omitted.\nOther reads authorize the resource's linked account.\nOmit when no account is selected; empty values and the string null are invalid.", "type": "text/plain" }, "key": "account_id", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"\",\n \"status\": \"failed\",\n \"thread_id\": \"\",\n \"user_message_id\": \"\",\n \"content\": \"\",\n \"error\": \"\",\n \"output_message_id\": \"\"\n },\n \"metadata\": {\n \"request_id\": \"\",\n \"next_page_token\": \"\",\n \"page_number\": \"\",\n \"previous_page_token\": \"\",\n \"total_items\": \"\",\n \"total_pages\": \"\"\n },\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5c33bd9b-b2e7-4a29-899c-f395b207cb21", "name": "Invalid request or supplied account ID", "originalRequest": { "url": { "path": [ "v1", "omni-ai", "threads", ":thread_id", "response" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Lists only conversations for this account, or unlinked conversations when omitted.\nOther reads authorize the resource's linked account.\nOmit when no account is selected; empty values and the string null are invalid.", "type": "text/plain" }, "key": "account_id", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"elit_5c8\": -44988772,\n \"proident_9\": -8115168,\n \"dolore_711\": \"cillum\"\n },\n {\n \"est_9\": \"sit nisi cupidatat pariatur\",\n \"pariatur_a\": 46992893\n }\n ]\n },\n \"metadata\": {\n \"request_id\": \"\",\n \"next_page_token\": \"\",\n \"page_number\": \"\",\n \"previous_page_token\": \"\",\n \"total_items\": \"\",\n \"total_pages\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3a55b8bd-a3bc-4bd4-993d-2595fc29d903", "name": "Authentication required", "originalRequest": { "url": { "path": [ "v1", "omni-ai", "threads", ":thread_id", "response" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Lists only conversations for this account, or unlinked conversations when omitted.\nOther reads authorize the resource's linked account.\nOmit when no account is selected; empty values and the string null are invalid.", "type": "text/plain" }, "key": "account_id", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"elit_5c8\": -44988772,\n \"proident_9\": -8115168,\n \"dolore_711\": \"cillum\"\n },\n {\n \"est_9\": \"sit nisi cupidatat pariatur\",\n \"pariatur_a\": 46992893\n }\n ]\n },\n \"metadata\": {\n \"request_id\": \"\",\n \"next_page_token\": \"\",\n \"page_number\": \"\",\n \"previous_page_token\": \"\",\n \"total_items\": \"\",\n \"total_pages\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "535006a8-f0b3-4f90-92ec-a3530a6a243f", "name": "Caller lacks linked-account access", "originalRequest": { "url": { "path": [ "v1", "omni-ai", "threads", ":thread_id", "response" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Lists only conversations for this account, or unlinked conversations when omitted.\nOther reads authorize the resource's linked account.\nOmit when no account is selected; empty values and the string null are invalid.", "type": "text/plain" }, "key": "account_id", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"elit_5c8\": -44988772,\n \"proident_9\": -8115168,\n \"dolore_711\": \"cillum\"\n },\n {\n \"est_9\": \"sit nisi cupidatat pariatur\",\n \"pariatur_a\": 46992893\n }\n ]\n },\n \"metadata\": {\n \"request_id\": \"\",\n \"next_page_token\": \"\",\n \"page_number\": \"\",\n \"previous_page_token\": \"\",\n \"total_items\": \"\",\n \"total_pages\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "39a8bdd1-67b7-4888-ac61-495b2c0f09d4", "name": "Resource not found or not owned by caller", "originalRequest": { "url": { "path": [ "v1", "omni-ai", "threads", ":thread_id", "response" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Lists only conversations for this account, or unlinked conversations when omitted.\nOther reads authorize the resource's linked account.\nOmit when no account is selected; empty values and the string null are invalid.", "type": "text/plain" }, "key": "account_id", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"elit_5c8\": -44988772,\n \"proident_9\": -8115168,\n \"dolore_711\": \"cillum\"\n },\n {\n \"est_9\": \"sit nisi cupidatat pariatur\",\n \"pariatur_a\": 46992893\n }\n ]\n },\n \"metadata\": {\n \"request_id\": \"\",\n \"next_page_token\": \"\",\n \"page_number\": \"\",\n \"previous_page_token\": \"\",\n \"total_items\": \"\",\n \"total_pages\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1d8a78d5-9cdd-4f61-a1ac-1dbb49d21a3d", "name": "Thread scope changed, active response, or conflicting retry; refresh before retrying", "originalRequest": { "url": { "path": [ "v1", "omni-ai", "threads", ":thread_id", "response" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Lists only conversations for this account, or unlinked conversations when omitted.\nOther reads authorize the resource's linked account.\nOmit when no account is selected; empty values and the string null are invalid.", "type": "text/plain" }, "key": "account_id", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"elit_5c8\": -44988772,\n \"proident_9\": -8115168,\n \"dolore_711\": \"cillum\"\n },\n {\n \"est_9\": \"sit nisi cupidatat pariatur\",\n \"pariatur_a\": 46992893\n }\n ]\n },\n \"metadata\": {\n \"request_id\": \"\",\n \"next_page_token\": \"\",\n \"page_number\": \"\",\n \"previous_page_token\": \"\",\n \"total_items\": \"\",\n \"total_pages\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6a8dddf8-554c-4d30-acdc-88c4a27ca1cf", "name": "Internal server error", "originalRequest": { "url": { "path": [ "v1", "omni-ai", "threads", ":thread_id", "response" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Lists only conversations for this account, or unlinked conversations when omitted.\nOther reads authorize the resource's linked account.\nOmit when no account is selected; empty values and the string null are invalid.", "type": "text/plain" }, "key": "account_id", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"elit_5c8\": -44988772,\n \"proident_9\": -8115168,\n \"dolore_711\": \"cillum\"\n },\n {\n \"est_9\": \"sit nisi cupidatat pariatur\",\n \"pariatur_a\": 46992893\n }\n ]\n },\n \"metadata\": {\n \"request_id\": \"\",\n \"next_page_token\": \"\",\n \"page_number\": \"\",\n \"previous_page_token\": \"\",\n \"total_items\": \"\",\n \"total_pages\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Omni Feed", "description": "Personalized feed of market stories: upcoming earnings, dividends, and splits, plus market news. Served per caller in a stable order; item ids double as pagination cursors, so any previously returned page can be re-read.", "item": [] }, { "name": "Locates", "description": "Query locate requests, granted locates, and cached locate borrow rates.", "item": [] }, { "name": "Private Markets", "description": "Browse private-market offerings and their indicative terms. Access requires the account holder to hold an accreditation attestation.", "item": [ { "id": "22045462-157c-4767-9318-17079f9f653f", "name": "Get Company", "request": { "name": "Get Company", "description": { "content": "Fetch one published private-market company with its complete versioned\nprofile. Requires the account holder to have attested. Returns `404` when\nthe company does not exist or is not yet published.", "type": "text/plain" }, "url": { "path": [ "v1", "private-markets", "companies", ":company_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Account whose account-holder entity must hold an accreditation\nattestation to browse private-market offerings.", "type": "text/plain" }, "key": "account_id", "value": "" } ], "variable": [ { "type": "any", "value": "", "key": "company_id", "disabled": false, "description": { "content": "(Required) Company identifier.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "9816862a-c826-448a-879b-3d54d62a5e21", "name": "The company", "originalRequest": { "url": { "path": [ "v1", "private-markets", "companies", ":company_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Account whose account-holder entity must hold an accreditation\nattestation to browse private-market offerings.", "type": "text/plain" }, "key": "account_id", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"\",\n \"name\": \"\",\n \"slug\": \"\",\n \"short_description\": \"\",\n \"profile_schema_version\": \"\",\n \"profile\": {\n \"categories\": [\n {\n \"slug\": \"\",\n \"name\": \"\"\n },\n {\n \"slug\": \"\",\n \"name\": \"\"\n }\n ],\n \"citations\": [\n {\n \"id\": \"\",\n \"title\": \"\",\n \"url\": \"\",\n \"source\": \"\",\n \"published_at\": \"\"\n },\n {\n \"id\": \"\",\n \"title\": \"\",\n \"url\": \"\",\n \"source\": \"\",\n \"published_at\": \"\"\n }\n ],\n \"customers\": [\n {\n \"name\": \"\",\n \"logo_url\": \"\"\n },\n {\n \"name\": \"\",\n \"logo_url\": \"\"\n }\n ],\n \"documents\": [\n {\n \"title\": \"\",\n \"url\": \"\",\n \"document_type\": \"OTHER\",\n \"relation\": \"CONNECTED\",\n \"external_id\": \"\",\n \"preview\": \"\",\n \"published_at\": \"\"\n },\n {\n \"title\": \"\",\n \"url\": \"\",\n \"document_type\": \"OTHER\",\n \"relation\": \"SUBJECT\",\n \"external_id\": \"\",\n \"preview\": \"\",\n \"published_at\": \"\"\n }\n ],\n \"headquarters\": \"\",\n \"legal_entities\": [\n {\n \"name\": \"\",\n \"country\": \"\"\n },\n {\n \"name\": \"\",\n \"country\": \"\"\n }\n ],\n \"metric_series\": [\n {\n \"metric_key\": \"PRICE_PER_SHARE\",\n \"label\": \"\",\n \"unit\": \"PERCENT\",\n \"frequency\": \"QUARTER\",\n \"source\": \"\",\n \"external_id\": \"\",\n \"points\": [\n {\n \"observed_at\": \"\",\n \"value\": \"\",\n \"value_type\": \"HISTORICAL\",\n \"citation_ids\": [\n \"\",\n \"\"\n ],\n \"source_event_id\": \"\",\n \"source_metadata\": {\n \"qui_a9\": \"\",\n \"in997\": \"\",\n \"et75\": \"\"\n }\n },\n {\n \"observed_at\": \"\",\n \"value\": \"\",\n \"value_type\": \"ESTIMATED\",\n \"citation_ids\": [\n \"\",\n \"\"\n ],\n \"source_event_id\": \"\",\n \"source_metadata\": {\n \"quis_1\": \"\"\n }\n }\n ],\n \"source_url\": \"\"\n },\n {\n \"metric_key\": \"ANNUALIZED_REVENUE\",\n \"label\": \"\",\n \"unit\": \"RANK\",\n \"frequency\": \"POINT_IN_TIME\",\n \"source\": \"\",\n \"external_id\": \"\",\n \"points\": [\n {\n \"observed_at\": \"\",\n \"value\": \"\",\n \"value_type\": \"HISTORICAL\",\n \"citation_ids\": [\n \"\",\n \"\"\n ],\n \"source_event_id\": \"\",\n \"source_metadata\": null\n },\n {\n \"observed_at\": \"\",\n \"value\": \"\",\n \"value_type\": \"ESTIMATED\",\n \"citation_ids\": [\n \"\",\n \"\"\n ],\n \"source_event_id\": \"\",\n \"source_metadata\": null\n }\n ],\n \"source_url\": \"\"\n }\n ],\n \"narrative_sections\": [\n {\n \"title\": \"\",\n \"body\": \"\",\n \"display_order\": \"\",\n \"citation_ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"title\": \"\",\n \"body\": \"\",\n \"display_order\": \"\",\n \"citation_ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"overview\": \"\",\n \"people\": [\n {\n \"name\": \"\",\n \"external_id\": \"\",\n \"roles\": [\n \"OTHER\",\n \"OTHER\"\n ]\n },\n {\n \"name\": \"\",\n \"external_id\": \"\",\n \"roles\": [\n \"OTHER\",\n \"FOUNDER\"\n ]\n }\n ],\n \"social\": [\n {\n \"type\": \"X\",\n \"url\": \"\"\n },\n {\n \"type\": \"X\",\n \"url\": \"\"\n }\n ],\n \"tagline\": \"\"\n },\n \"logo_url\": \"\",\n \"primary_domain\": \"\",\n \"published_at\": \"\"\n },\n \"metadata\": {\n \"request_id\": \"\",\n \"next_page_token\": \"\",\n \"page_number\": \"\",\n \"previous_page_token\": \"\",\n \"total_items\": \"\",\n \"total_pages\": \"\"\n },\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f1a1faa9-c93e-4208-a048-207ccf984a89", "name": "Unauthenticated", "originalRequest": { "url": { "path": [ "v1", "private-markets", "companies", ":company_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Account whose account-holder entity must hold an accreditation\nattestation to browse private-market offerings.", "type": "text/plain" }, "key": "account_id", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"sunt_f\": false,\n \"magnae59\": 67421727\n },\n {\n \"minim48\": false,\n \"fugiat94d\": -43856089.03091218\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4d56ad79-25e4-4ef7-876f-43b14fd2984c", "name": "Caller lacks account access, or the account holder has not attested", "originalRequest": { "url": { "path": [ "v1", "private-markets", "companies", ":company_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Account whose account-holder entity must hold an accreditation\nattestation to browse private-market offerings.", "type": "text/plain" }, "key": "account_id", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"sunt_f\": false,\n \"magnae59\": 67421727\n },\n {\n \"minim48\": false,\n \"fugiat94d\": -43856089.03091218\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "10b48008-bd2b-408f-aa8e-a050ccf7c502", "name": "Account not found, or company not found or not published", "originalRequest": { "url": { "path": [ "v1", "private-markets", "companies", ":company_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Account whose account-holder entity must hold an accreditation\nattestation to browse private-market offerings.", "type": "text/plain" }, "key": "account_id", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"sunt_f\": false,\n \"magnae59\": 67421727\n },\n {\n \"minim48\": false,\n \"fugiat94d\": -43856089.03091218\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "88a01967-bcd7-4c87-af3c-167de825995b", "name": "Internal server error", "originalRequest": { "url": { "path": [ "v1", "private-markets", "companies", ":company_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Account whose account-holder entity must hold an accreditation\nattestation to browse private-market offerings.", "type": "text/plain" }, "key": "account_id", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"sunt_f\": false,\n \"magnae59\": 67421727\n },\n {\n \"minim48\": false,\n \"fugiat94d\": -43856089.03091218\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b2de70cf-f508-434d-bf19-a915a687cd42", "name": "List every live IOI for the caller's account-holder entity.", "request": { "name": "List every live IOI for the caller's account-holder entity.", "description": {}, "url": { "path": [ "v1", "private-markets", "iois" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "account_id", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "af0ddaaa-a176-490e-a55c-7e9bf5a06252", "name": "Live entity IOIs", "originalRequest": { "url": { "path": [ "v1", "private-markets", "iois" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "account_id", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"account_id\": \"\",\n \"company\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"created_at\": \"\",\n \"currency\": \"USD\",\n \"id\": \"\",\n \"notional_amount\": \"\",\n \"offering\": {\n \"id\": \"\",\n \"headline\": \"\"\n },\n \"offering_id\": \"\",\n \"updated_at\": \"\",\n \"nda_acceptance\": \"\"\n },\n {\n \"account_id\": \"\",\n \"company\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"created_at\": \"\",\n \"currency\": \"USD\",\n \"id\": \"\",\n \"notional_amount\": \"\",\n \"offering\": {\n \"id\": \"\",\n \"headline\": \"\"\n },\n \"offering_id\": \"\",\n \"updated_at\": \"\",\n \"nda_acceptance\": \"\"\n }\n ],\n \"metadata\": {\n \"request_id\": \"\",\n \"next_page_token\": \"\",\n \"page_number\": \"\",\n \"previous_page_token\": \"\",\n \"total_items\": \"\",\n \"total_pages\": \"\"\n },\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "df115ab8-6ac1-4bb0-9bd1-481b6ef7e6e5", "name": "Unauthenticated", "originalRequest": { "url": { "path": [ "v1", "private-markets", "iois" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "account_id", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"sunt_f\": false,\n \"magnae59\": 67421727\n },\n {\n \"minim48\": false,\n \"fugiat94d\": -43856089.03091218\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4414bd30-d7d1-499b-a351-ded836758f5f", "name": "Caller lacks View permission or the entity has not attested", "originalRequest": { "url": { "path": [ "v1", "private-markets", "iois" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "account_id", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"sunt_f\": false,\n \"magnae59\": 67421727\n },\n {\n \"minim48\": false,\n \"fugiat94d\": -43856089.03091218\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e1c8cef7-debf-4e84-83a2-b233b334454a", "name": "Account not found", "originalRequest": { "url": { "path": [ "v1", "private-markets", "iois" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "account_id", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"sunt_f\": false,\n \"magnae59\": 67421727\n },\n {\n \"minim48\": false,\n \"fugiat94d\": -43856089.03091218\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "465c9652-0338-4b55-8547-a3be64ae0108", "name": "Internal server error", "originalRequest": { "url": { "path": [ "v1", "private-markets", "iois" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "account_id", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"sunt_f\": false,\n \"magnae59\": 67421727\n },\n {\n \"minim48\": false,\n \"fugiat94d\": -43856089.03091218\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "57d67931-f468-41fc-8350-34ea533b4430", "name": "Create an IOI for a visible upcoming offering.", "request": { "name": "Create an IOI for a visible upcoming offering.", "description": {}, "url": { "path": [ "v1", "private-markets", "iois" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "account_id", "value": "" } ], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"offering_id\": \"\",\n \"notional_amount\": \"\",\n \"nda_acceptance\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "a7bd4f6b-0853-45bb-bffa-731c0ede3113", "name": "IOI created", "originalRequest": { "url": { "path": [ "v1", "private-markets", "iois" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "account_id", "value": "" } ], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"offering_id\": \"\",\n \"notional_amount\": \"\",\n \"nda_acceptance\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"account_id\": \"\",\n \"company\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"created_at\": \"\",\n \"currency\": \"USD\",\n \"id\": \"\",\n \"notional_amount\": \"\",\n \"offering\": {\n \"id\": \"\",\n \"headline\": \"\"\n },\n \"offering_id\": \"\",\n \"updated_at\": \"\",\n \"nda_acceptance\": \"\"\n },\n \"metadata\": {\n \"request_id\": \"\",\n \"next_page_token\": \"\",\n \"page_number\": \"\",\n \"previous_page_token\": \"\",\n \"total_items\": \"\",\n \"total_pages\": \"\"\n },\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bfb278be-e4df-4b1e-904e-3eaff1c833c8", "name": "Invalid or irrelevant NDA acceptance", "originalRequest": { "url": { "path": [ "v1", "private-markets", "iois" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "account_id", "value": "" } ], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"offering_id\": \"\",\n \"notional_amount\": \"\",\n \"nda_acceptance\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"sunt_f\": false,\n \"magnae59\": 67421727\n },\n {\n \"minim48\": false,\n \"fugiat94d\": -43856089.03091218\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6d33b7b9-70a7-49cf-832d-9977fd210634", "name": "Unauthenticated", "originalRequest": { "url": { "path": [ "v1", "private-markets", "iois" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "account_id", "value": "" } ], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"offering_id\": \"\",\n \"notional_amount\": \"\",\n \"nda_acceptance\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"sunt_f\": false,\n \"magnae59\": 67421727\n },\n {\n \"minim48\": false,\n \"fugiat94d\": -43856089.03091218\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "75807bfd-9d9a-4d92-9717-711641cebddd", "name": "Caller lacks Trade permission or the entity has not attested", "originalRequest": { "url": { "path": [ "v1", "private-markets", "iois" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "account_id", "value": "" } ], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"offering_id\": \"\",\n \"notional_amount\": \"\",\n \"nda_acceptance\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"sunt_f\": false,\n \"magnae59\": 67421727\n },\n {\n \"minim48\": false,\n \"fugiat94d\": -43856089.03091218\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "598fe3c7-545e-46a4-a410-3a96d4ceb340", "name": "Account or offering not found", "originalRequest": { "url": { "path": [ "v1", "private-markets", "iois" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "account_id", "value": "" } ], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"offering_id\": \"\",\n \"notional_amount\": \"\",\n \"nda_acceptance\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"sunt_f\": false,\n \"magnae59\": 67421727\n },\n {\n \"minim48\": false,\n \"fugiat94d\": -43856089.03091218\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "689cdacd-65b8-4103-9f53-af3e57667fca", "name": "Duplicate live IOI or below-minimum notional", "originalRequest": { "url": { "path": [ "v1", "private-markets", "iois" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "account_id", "value": "" } ], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"offering_id\": \"\",\n \"notional_amount\": \"\",\n \"nda_acceptance\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"sunt_f\": false,\n \"magnae59\": 67421727\n },\n {\n \"minim48\": false,\n \"fugiat94d\": -43856089.03091218\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "63bc3bcf-395e-4a03-ad2b-77f29f687c6a", "name": "Current NDA acceptance required", "originalRequest": { "url": { "path": [ "v1", "private-markets", "iois" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "account_id", "value": "" } ], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"offering_id\": \"\",\n \"notional_amount\": \"\",\n \"nda_acceptance\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"sunt_f\": false,\n \"magnae59\": 67421727\n },\n {\n \"minim48\": false,\n \"fugiat94d\": -43856089.03091218\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "883c4486-d5fa-4442-a80c-40fc260a079b", "name": "Internal server error", "originalRequest": { "url": { "path": [ "v1", "private-markets", "iois" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "account_id", "value": "" } ], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"offering_id\": \"\",\n \"notional_amount\": \"\",\n \"nda_acceptance\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"sunt_f\": false,\n \"magnae59\": 67421727\n },\n {\n \"minim48\": false,\n \"fugiat94d\": -43856089.03091218\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9fd6c7d3-62c8-45c2-9bb3-54383d04d453", "name": "Withdraw a live IOI. Repeating a withdrawal returns 404.", "request": { "name": "Withdraw a live IOI. Repeating a withdrawal returns 404.", "description": {}, "url": { "path": [ "v1", "private-markets", "iois", ":ioi_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "account_id", "value": "" } ], "variable": [ { "type": "any", "value": "", "key": "ioi_id", "disabled": false, "description": { "content": "(Required) IOI id", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "5574aaa0-d7ce-4179-8f0c-7b11e99d87ad", "name": "IOI withdrawn", "originalRequest": { "url": { "path": [ "v1", "private-markets", "iois", ":ioi_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "account_id", "value": "" } ], "variable": [] }, "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e3946134-0484-4fb7-a514-c0ecaa84dc46", "name": "Unauthenticated", "originalRequest": { "url": { "path": [ "v1", "private-markets", "iois", ":ioi_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "account_id", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"sunt_f\": false,\n \"magnae59\": 67421727\n },\n {\n \"minim48\": false,\n \"fugiat94d\": -43856089.03091218\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "330b607f-1bc5-46b4-8833-f0e9aaa07eff", "name": "Caller lacks Trade permission or the entity has not attested", "originalRequest": { "url": { "path": [ "v1", "private-markets", "iois", ":ioi_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "account_id", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"sunt_f\": false,\n \"magnae59\": 67421727\n },\n {\n \"minim48\": false,\n \"fugiat94d\": -43856089.03091218\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "904756b1-5a64-422e-af44-1d8f8a57163f", "name": "IOI or account not found", "originalRequest": { "url": { "path": [ "v1", "private-markets", "iois", ":ioi_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "account_id", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"sunt_f\": false,\n \"magnae59\": 67421727\n },\n {\n \"minim48\": false,\n \"fugiat94d\": -43856089.03091218\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "42ed7088-dbaa-4614-b041-7535cbbf204b", "name": "Internal server error", "originalRequest": { "url": { "path": [ "v1", "private-markets", "iois", ":ioi_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "account_id", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"sunt_f\": false,\n \"magnae59\": 67421727\n },\n {\n \"minim48\": false,\n \"fugiat94d\": -43856089.03091218\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "06ab9cbd-d524-4086-b0a9-7ff1146369a2", "name": "Update an IOI's notional, accepting the current NDA revision when required.", "request": { "name": "Update an IOI's notional, accepting the current NDA revision when required.", "description": {}, "url": { "path": [ "v1", "private-markets", "iois", ":ioi_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "account_id", "value": "" } ], "variable": [ { "type": "any", "value": "", "key": "ioi_id", "disabled": false, "description": { "content": "(Required) IOI id", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"notional_amount\": \"\",\n \"nda_acceptance\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "87480e04-f35b-4b57-9329-59bce28cee38", "name": "IOI updated", "originalRequest": { "url": { "path": [ "v1", "private-markets", "iois", ":ioi_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "account_id", "value": "" } ], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"notional_amount\": \"\",\n \"nda_acceptance\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"account_id\": \"\",\n \"company\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"created_at\": \"\",\n \"currency\": \"USD\",\n \"id\": \"\",\n \"notional_amount\": \"\",\n \"offering\": {\n \"id\": \"\",\n \"headline\": \"\"\n },\n \"offering_id\": \"\",\n \"updated_at\": \"\",\n \"nda_acceptance\": \"\"\n },\n \"metadata\": {\n \"request_id\": \"\",\n \"next_page_token\": \"\",\n \"page_number\": \"\",\n \"previous_page_token\": \"\",\n \"total_items\": \"\",\n \"total_pages\": \"\"\n },\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ccea12cb-d161-4bea-991d-a3b3df57167a", "name": "Invalid or irrelevant NDA acceptance", "originalRequest": { "url": { "path": [ "v1", "private-markets", "iois", ":ioi_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "account_id", "value": "" } ], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"notional_amount\": \"\",\n \"nda_acceptance\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"sunt_f\": false,\n \"magnae59\": 67421727\n },\n {\n \"minim48\": false,\n \"fugiat94d\": -43856089.03091218\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4bb7cd72-9433-4868-9dc3-5ca371e3f18e", "name": "Unauthenticated", "originalRequest": { "url": { "path": [ "v1", "private-markets", "iois", ":ioi_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "account_id", "value": "" } ], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"notional_amount\": \"\",\n \"nda_acceptance\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"sunt_f\": false,\n \"magnae59\": 67421727\n },\n {\n \"minim48\": false,\n \"fugiat94d\": -43856089.03091218\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4088ace0-fb50-437e-a1e8-f176c74192ab", "name": "Caller lacks Trade permission or the entity has not attested", "originalRequest": { "url": { "path": [ "v1", "private-markets", "iois", ":ioi_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "account_id", "value": "" } ], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"notional_amount\": \"\",\n \"nda_acceptance\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"sunt_f\": false,\n \"magnae59\": 67421727\n },\n {\n \"minim48\": false,\n \"fugiat94d\": -43856089.03091218\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1df473b9-f5d0-40bc-bdad-fee545e603b3", "name": "IOI or account not found", "originalRequest": { "url": { "path": [ "v1", "private-markets", "iois", ":ioi_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "account_id", "value": "" } ], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"notional_amount\": \"\",\n \"nda_acceptance\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"sunt_f\": false,\n \"magnae59\": 67421727\n },\n {\n \"minim48\": false,\n \"fugiat94d\": -43856089.03091218\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "59c4f86a-bfc9-4438-823d-b0e0ef55d6e2", "name": "Below-minimum notional", "originalRequest": { "url": { "path": [ "v1", "private-markets", "iois", ":ioi_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "account_id", "value": "" } ], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"notional_amount\": \"\",\n \"nda_acceptance\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"sunt_f\": false,\n \"magnae59\": 67421727\n },\n {\n \"minim48\": false,\n \"fugiat94d\": -43856089.03091218\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "afafa1f5-6d40-492e-b72f-2acf059f9255", "name": "Current NDA acceptance required", "originalRequest": { "url": { "path": [ "v1", "private-markets", "iois", ":ioi_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "account_id", "value": "" } ], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"notional_amount\": \"\",\n \"nda_acceptance\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"sunt_f\": false,\n \"magnae59\": 67421727\n },\n {\n \"minim48\": false,\n \"fugiat94d\": -43856089.03091218\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "85fa1aa8-6252-4ea3-a2ac-514c936779f7", "name": "Internal server error", "originalRequest": { "url": { "path": [ "v1", "private-markets", "iois", ":ioi_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "account_id", "value": "" } ], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"notional_amount\": \"\",\n \"nda_acceptance\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"sunt_f\": false,\n \"magnae59\": 67421727\n },\n {\n \"minim48\": false,\n \"fugiat94d\": -43856089.03091218\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6a77477e-dfc7-44b2-9670-e863492d661c", "name": "List Offerings", "request": { "name": "List Offerings", "description": { "content": "List every visible private-market offering as a card, with its derived\nclass, company and SPV identity, and indicative terms. Requires the account\nholder to have attested.", "type": "text/plain" }, "url": { "path": [ "v1", "private-markets", "offerings" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Account whose account-holder entity must hold an accreditation\nattestation to browse private-market offerings.", "type": "text/plain" }, "key": "account_id", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "6b458e76-7a40-44a8-a986-cf5321e16628", "name": "Visible offerings", "originalRequest": { "url": { "path": [ "v1", "private-markets", "offerings" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Account whose account-holder entity must hold an accreditation\nattestation to browse private-market offerings.", "type": "text/plain" }, "key": "account_id", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"class\": \"UPCOMING\",\n \"headline\": \"\",\n \"summary\": \"\",\n \"company\": {\n \"id\": \"\",\n \"name\": \"\",\n \"slug\": \"\",\n \"short_description\": \"\",\n \"logo_url\": \"\",\n \"primary_domain\": \"\"\n },\n \"currency\": \"USD\",\n \"indicative_price_high\": \"\",\n \"indicative_price_low\": \"\",\n \"indicative_valuation_basis\": \"\",\n \"indicative_valuation_high\": \"\",\n \"indicative_valuation_low\": \"\",\n \"ioi_deadline\": \"\",\n \"minimum_ioi_amount\": \"\",\n \"spv\": \"\"\n },\n {\n \"id\": \"\",\n \"class\": \"ACTIVE\",\n \"headline\": \"\",\n \"summary\": \"\",\n \"company\": {\n \"id\": \"\",\n \"name\": \"\",\n \"slug\": \"\",\n \"short_description\": \"\",\n \"logo_url\": \"\",\n \"primary_domain\": \"\"\n },\n \"currency\": \"USD\",\n \"indicative_price_high\": \"\",\n \"indicative_price_low\": \"\",\n \"indicative_valuation_basis\": \"\",\n \"indicative_valuation_high\": \"\",\n \"indicative_valuation_low\": \"\",\n \"ioi_deadline\": \"\",\n \"minimum_ioi_amount\": \"\",\n \"spv\": \"\"\n }\n ],\n \"metadata\": {\n \"request_id\": \"\",\n \"next_page_token\": \"\",\n \"page_number\": \"\",\n \"previous_page_token\": \"\",\n \"total_items\": \"\",\n \"total_pages\": \"\"\n },\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c8859a3e-ac99-4dcd-8402-e33931649e2c", "name": "Unauthenticated", "originalRequest": { "url": { "path": [ "v1", "private-markets", "offerings" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Account whose account-holder entity must hold an accreditation\nattestation to browse private-market offerings.", "type": "text/plain" }, "key": "account_id", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"sunt_f\": false,\n \"magnae59\": 67421727\n },\n {\n \"minim48\": false,\n \"fugiat94d\": -43856089.03091218\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0471f3fb-26ea-4d0b-9c86-06602a0103a5", "name": "Caller lacks account access, or the account holder has not attested", "originalRequest": { "url": { "path": [ "v1", "private-markets", "offerings" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Account whose account-holder entity must hold an accreditation\nattestation to browse private-market offerings.", "type": "text/plain" }, "key": "account_id", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"sunt_f\": false,\n \"magnae59\": 67421727\n },\n {\n \"minim48\": false,\n \"fugiat94d\": -43856089.03091218\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c915da7a-6f23-43ba-9691-12fcb381eb3c", "name": "Account not found", "originalRequest": { "url": { "path": [ "v1", "private-markets", "offerings" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Account whose account-holder entity must hold an accreditation\nattestation to browse private-market offerings.", "type": "text/plain" }, "key": "account_id", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"sunt_f\": false,\n \"magnae59\": 67421727\n },\n {\n \"minim48\": false,\n \"fugiat94d\": -43856089.03091218\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4411200b-ca5b-40e3-9476-53fcc03d71e6", "name": "Internal server error", "originalRequest": { "url": { "path": [ "v1", "private-markets", "offerings" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Account whose account-holder entity must hold an accreditation\nattestation to browse private-market offerings.", "type": "text/plain" }, "key": "account_id", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"sunt_f\": false,\n \"magnae59\": 67421727\n },\n {\n \"minim48\": false,\n \"fugiat94d\": -43856089.03091218\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3c4000fa-0cde-424b-a75a-0c15332c5cec", "name": "Get Offering", "request": { "name": "Get Offering", "description": { "content": "Fetch one visible private-market offering with its documents, participants,\nand any attached SPV. Requires the account holder to have attested. Returns\n`404` when the offering does not exist or is not currently visible.", "type": "text/plain" }, "url": { "path": [ "v1", "private-markets", "offerings", ":offering_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Account whose account-holder entity must hold an accreditation\nattestation to browse private-market offerings.", "type": "text/plain" }, "key": "account_id", "value": "" } ], "variable": [ { "type": "any", "value": "", "key": "offering_id", "disabled": false, "description": { "content": "(Required) Offering identifier.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "ae1cccca-448f-4944-9ed6-2525e89338d8", "name": "The offering", "originalRequest": { "url": { "path": [ "v1", "private-markets", "offerings", ":offering_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Account whose account-holder entity must hold an accreditation\nattestation to browse private-market offerings.", "type": "text/plain" }, "key": "account_id", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"\",\n \"class\": \"ACTIVE\",\n \"headline\": \"\",\n \"summary\": \"\",\n \"company\": {\n \"id\": \"\",\n \"name\": \"\",\n \"slug\": \"\",\n \"short_description\": \"\",\n \"logo_url\": \"\",\n \"primary_domain\": \"\"\n },\n \"currency\": \"USD\",\n \"indicative_price_high\": \"\",\n \"indicative_price_low\": \"\",\n \"indicative_valuation_basis\": \"\",\n \"indicative_valuation_high\": \"\",\n \"indicative_valuation_low\": \"\",\n \"ioi_deadline\": \"\",\n \"minimum_ioi_amount\": \"\",\n \"spv\": \"\",\n \"disclosures\": \"\",\n \"documents\": [\n {\n \"id\": \"\",\n \"document_type\": \"RISK_FACTORS\",\n \"title\": \"\",\n \"display_order\": \"\",\n \"object_key\": \"\",\n \"published_at\": \"\",\n \"source\": \"\",\n \"source_url\": \"\",\n \"url\": \"\"\n },\n {\n \"id\": \"\",\n \"document_type\": \"PPM\",\n \"title\": \"\",\n \"display_order\": \"\",\n \"object_key\": \"\",\n \"published_at\": \"\",\n \"source\": \"\",\n \"source_url\": \"\",\n \"url\": \"\"\n }\n ],\n \"highlights\": [\n {\n \"metric_key\": \"\",\n \"label\": \"\",\n \"unit\": \"RANK\",\n \"observed_at\": \"\",\n \"value\": \"\",\n \"value_type\": \"\"\n },\n {\n \"metric_key\": \"\",\n \"label\": \"\",\n \"unit\": \"COUNT\",\n \"observed_at\": \"\",\n \"value\": \"\",\n \"value_type\": \"\"\n }\n ],\n \"investment_thesis\": \"\",\n \"key_risks\": [\n {\n \"title\": \"\",\n \"body\": \"\",\n \"citation_ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"title\": \"\",\n \"body\": \"\",\n \"citation_ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"participants\": [\n {\n \"id\": \"\",\n \"role\": \"PLACEMENT_AGENT\",\n \"name\": \"\",\n \"display_order\": \"\"\n },\n {\n \"id\": \"\",\n \"role\": \"PLACEMENT_AGENT\",\n \"name\": \"\",\n \"display_order\": \"\"\n }\n ],\n \"structure_description\": \"\",\n \"why_now\": \"\"\n },\n \"metadata\": {\n \"request_id\": \"\",\n \"next_page_token\": \"\",\n \"page_number\": \"\",\n \"previous_page_token\": \"\",\n \"total_items\": \"\",\n \"total_pages\": \"\"\n },\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "89e8e600-a284-4b96-a8ee-f3104f308a4c", "name": "Unauthenticated", "originalRequest": { "url": { "path": [ "v1", "private-markets", "offerings", ":offering_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Account whose account-holder entity must hold an accreditation\nattestation to browse private-market offerings.", "type": "text/plain" }, "key": "account_id", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"sunt_f\": false,\n \"magnae59\": 67421727\n },\n {\n \"minim48\": false,\n \"fugiat94d\": -43856089.03091218\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2a5eb230-9bba-4778-8285-82486607fb68", "name": "Caller lacks account access, or the account holder has not attested", "originalRequest": { "url": { "path": [ "v1", "private-markets", "offerings", ":offering_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Account whose account-holder entity must hold an accreditation\nattestation to browse private-market offerings.", "type": "text/plain" }, "key": "account_id", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"sunt_f\": false,\n \"magnae59\": 67421727\n },\n {\n \"minim48\": false,\n \"fugiat94d\": -43856089.03091218\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "37071264-5064-47be-abc7-5a115664ed59", "name": "Account not found, or offering not found or not visible", "originalRequest": { "url": { "path": [ "v1", "private-markets", "offerings", ":offering_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Account whose account-holder entity must hold an accreditation\nattestation to browse private-market offerings.", "type": "text/plain" }, "key": "account_id", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"sunt_f\": false,\n \"magnae59\": 67421727\n },\n {\n \"minim48\": false,\n \"fugiat94d\": -43856089.03091218\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fdb59192-e103-469f-8b97-d8f3d02f83c2", "name": "Internal server error", "originalRequest": { "url": { "path": [ "v1", "private-markets", "offerings", ":offering_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Account whose account-holder entity must hold an accreditation\nattestation to browse private-market offerings.", "type": "text/plain" }, "key": "account_id", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"sunt_f\": false,\n \"magnae59\": 67421727\n },\n {\n \"minim48\": false,\n \"fugiat94d\": -43856089.03091218\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "33bbfc24-17ff-4d9f-879e-55e68e878a5f", "name": "Get SPV", "request": { "name": "Get SPV", "description": { "content": "Fetch one private-market SPV's complete economics and fee schedule. Requires\nthe account holder to have attested. Returns `404` unless the SPV is `OPEN`\nand attached to a currently visible `ACTIVE` offering.", "type": "text/plain" }, "url": { "path": [ "v1", "private-markets", "spvs", ":spv_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Account whose account-holder entity must hold an accreditation\nattestation to browse private-market offerings.", "type": "text/plain" }, "key": "account_id", "value": "" } ], "variable": [ { "type": "any", "value": "", "key": "spv_id", "disabled": false, "description": { "content": "(Required) SPV identifier.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "88b5df6a-3aa7-42ad-9380-197b7ddf77f4", "name": "The SPV", "originalRequest": { "url": { "path": [ "v1", "private-markets", "spvs", ":spv_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Account whose account-holder entity must hold an accreditation\nattestation to browse private-market offerings.", "type": "text/plain" }, "key": "account_id", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"\",\n \"company_id\": \"\",\n \"name\": \"\",\n \"status\": \"OPEN\",\n \"currency\": \"USD\",\n \"all_in_price_per_share\": \"\",\n \"custodian_name\": \"\",\n \"fee_per_share\": \"\",\n \"fee_terms\": [\n {\n \"fee_type\": \"OTHER\",\n \"charged_by\": \"THIRD_PARTY\",\n \"frequency\": \"ONE_TIME\",\n \"currency\": \"USD\",\n \"description\": \"\",\n \"amount\": \"\",\n \"duration_years\": \"\",\n \"hurdle_rate\": \"\",\n \"rate\": \"\"\n },\n {\n \"fee_type\": \"MANAGEMENT\",\n \"charged_by\": \"THIRD_PARTY\",\n \"frequency\": \"AT_EXIT\",\n \"currency\": \"USD\",\n \"description\": \"\",\n \"amount\": \"\",\n \"duration_years\": \"\",\n \"hurdle_rate\": \"\",\n \"rate\": \"\"\n }\n ],\n \"funded_percent\": \"\",\n \"funding_deadline\": \"\",\n \"manager_name\": \"\",\n \"minimum_investment_amount\": \"\",\n \"opened_at\": \"\",\n \"price_per_share\": \"\",\n \"remaining_allocation_amount\": \"\",\n \"remaining_share_allocation\": \"\",\n \"share_class\": \"\",\n \"structure_description\": \"\",\n \"total_allocation_amount\": \"\",\n \"total_share_allocation\": \"\",\n \"valuation\": \"\",\n \"valuation_basis\": \"\"\n },\n \"metadata\": {\n \"request_id\": \"\",\n \"next_page_token\": \"\",\n \"page_number\": \"\",\n \"previous_page_token\": \"\",\n \"total_items\": \"\",\n \"total_pages\": \"\"\n },\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "004c879e-2584-42e8-bc08-2da4b29224fe", "name": "Unauthenticated", "originalRequest": { "url": { "path": [ "v1", "private-markets", "spvs", ":spv_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Account whose account-holder entity must hold an accreditation\nattestation to browse private-market offerings.", "type": "text/plain" }, "key": "account_id", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"sunt_f\": false,\n \"magnae59\": 67421727\n },\n {\n \"minim48\": false,\n \"fugiat94d\": -43856089.03091218\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "09100c54-5d9d-42de-ad17-38cac0cd23bc", "name": "Caller lacks account access, or the account holder has not attested", "originalRequest": { "url": { "path": [ "v1", "private-markets", "spvs", ":spv_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Account whose account-holder entity must hold an accreditation\nattestation to browse private-market offerings.", "type": "text/plain" }, "key": "account_id", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"sunt_f\": false,\n \"magnae59\": 67421727\n },\n {\n \"minim48\": false,\n \"fugiat94d\": -43856089.03091218\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "961ca97a-22b1-4313-9945-ed9553927edd", "name": "Account not found, or SPV not found or not currently open and visible", "originalRequest": { "url": { "path": [ "v1", "private-markets", "spvs", ":spv_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Account whose account-holder entity must hold an accreditation\nattestation to browse private-market offerings.", "type": "text/plain" }, "key": "account_id", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"sunt_f\": false,\n \"magnae59\": 67421727\n },\n {\n \"minim48\": false,\n \"fugiat94d\": -43856089.03091218\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "93e8c5da-4e28-44fe-83d3-66f0694e262d", "name": "Internal server error", "originalRequest": { "url": { "path": [ "v1", "private-markets", "spvs", ":spv_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Account whose account-holder entity must hold an accreditation\nattestation to browse private-market offerings.", "type": "text/plain" }, "key": "account_id", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"sunt_f\": false,\n \"magnae59\": 67421727\n },\n {\n \"minim48\": false,\n \"fugiat94d\": -43856089.03091218\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ], "auth": { "type": "bearer", "bearer": [ { "type": "any", "value": "{{bearerToken}}", "key": "token" } ] }, "event": [], "variable": [ { "key": "baseUrl", "value": "https://api.clearstreet.com" } ], "info": { "_postman_id": "ebf03579-e0a1-44fc-a8e7-4e893cd333fd", "name": "Clear Street Trading API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": { "content": "A unified, secure, and high-performance RESTful API for all client interactions with the Active trading platform.\nThis specification provides a single source of truth for the API surface, covering order management, trade execution, market data, and account services.\n\n### Authentication\nAll endpoints require authentication via a JWT Bearer token provided in the `Authorization` header.\n\n### Response Structure\nAll responses, both for success and error, adhere to a standard envelope structure:\n- `data`: Contains the response payload on success, or `null` on error.\n- `error`: Contains a structured error object on failure, or `null` on success.\n- `metadata`: Contains the `request_id` and pagination information.\n\n### WebSockets\nReal-time market data is available via WebSocket connections, which are not formally described in this OpenAPI specification. The following operations are available:\n- `market-data-l1-subscribe`: To start receiving L1 market data updates for a set of symbols.\n- `market-data-l1-unsubscribe`: To stop receiving L1 market data updates.\n\nContact Support:\n Name: Clear Street API Support\n Email: concierge@clearstreet.com", "type": "text/plain" } } }