{ "item": [ { "id": "2b5f4f61-0443-4dd6-9125-b7f5a943c66f", "name": "auditors create", "request": { "name": "auditors create", "description": { "content": "Get the financial auditors of a given company id", "type": "text/plain" }, "url": { "path": [ "api", "v1", "auditors", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "sessionid" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "key": "company_id", "value": "", "description": "(Required) " }, { "disabled": false, "key": "start_year", "value": "" }, { "disabled": false, "key": "end_year", "value": "" }, { "disabled": false, "key": "calendar_type", "value": "" } ] } }, "response": [ { "id": "0dcc958f-8c24-4944-8df3-e05f6619a71f", "name": "Indicates a successful request.", "originalRequest": { "url": { "path": [ "api", "v1", "auditors", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "company_id", "value": "" }, { "disabled": false, "key": "start_year", "value": "" }, { "disabled": false, "key": "end_year", "value": "" }, { "disabled": false, "key": "calendar_type", "value": "" } ] } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"21719\": {\n \"CY2025/FY2025\": [\n {\n \"auditor_company_id\": \"97518\",\n \"auditor_name\": \"Ernst & Young LLP\"\n }\n ],\n \"CY2024/FY2024\": [\n {\n \"auditor_company_id\": \"97518\",\n \"auditor_name\": \"Ernst & Young LLP\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d714b856-7842-4195-b3c6-925e067e621f", "name": "Indicates that the authorization is missing or invalid.", "originalRequest": { "url": { "path": [ "api", "v1", "auditors", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "company_id", "value": "" }, { "disabled": false, "key": "start_year", "value": "" }, { "disabled": false, "key": "end_year", "value": "" }, { "disabled": false, "key": "calendar_type", "value": "" } ] } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2f7d351d-1fe8-4821-8c23-c8962a3b3226", "name": "ciqpro retrieve", "request": { "name": "ciqpro retrieve", "description": { "content": "Given a list of company IDs, return a list of those IDs to their CIQ Pro keys.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "ciqpro", ":company_ids" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "company_ids", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "sessionid" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "bbbfcdc6-d2e4-4d26-8df7-451e52d267f2", "name": "Indicates a successful request.", "originalRequest": { "url": { "path": [ "api", "v1", "ciqpro", ":company_ids" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "company_ids", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"results\": [\n {\n \"company_id\": \"21719\",\n \"ciqpro_key\": \"4023623\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0335c586-8193-4cf5-a516-bf191d263345", "name": "Indicates that the authorization is missing or invalid.", "originalRequest": { "url": { "path": [ "api", "v1", "ciqpro", ":company_ids" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "company_ids", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "dceeaa30-cd48-497e-bdc8-97413b661209", "name": "Get Companies By Location", "request": { "name": "Get Companies By Location", "description": { "content": "Get the list of companies based in a location with filters iso_code and state.\n\nParameters:\n iso_code (string, required): The ISO 3166-1 alpha-2 or alpha-3 code representing the country. This should be a two or three letter code conforming to the ISO 3166-1 standard. Example: \"US\" or \"USA\" for the United States, \"FR\" or \"FRA\" for France, \"IN\" or \"IND\" for India.\n state (string, optional): The ISO 3166-2 subdivision code representing a state, province, or region within the specified country. This code identifies the subdivision without repeating the country code. Example: \"CA\" for California, \"MH\" for Maharashtra.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "company_groups", "geo", "country", ":iso_code", ":state" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "iso_code", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "state", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "sessionid" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "0b889f44-3bac-4b4f-874b-8ce25dc06cc9", "name": "Indicates a successful request.", "originalRequest": { "url": { "path": [ "api", "v1", "company_groups", "geo", "country", ":iso_code", ":state" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "iso_code", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "state", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"companies\": [\n 557556508,\n 915908,\n 326636850,\n 13757207,\n 1780112191,\n 291946353,\n 658420583,\n 408856966\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "13f5c17f-660e-466e-8e2d-1a4f3d7d930a", "name": "Indicates that the query is invalid.", "originalRequest": { "url": { "path": [ "api", "v1", "company_groups", "geo", "country", ":iso_code", ":state" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "iso_code", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "state", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "26975752-e483-40a1-b280-8422c280da66", "name": "Indicates that the authorization information is missing or invalid.", "originalRequest": { "url": { "path": [ "api", "v1", "company_groups", "geo", "country", ":iso_code", ":state" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "iso_code", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "state", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "59a8b783-5487-4f35-9236-9ff09f25429a", "name": "Get Companies By Industry Code", "request": { "name": "Get Companies By Industry Code", "description": { "content": "Get the list of companies that are in the given industry_classification and industry_code", "type": "text/plain" }, "url": { "path": [ "api", "v1", "company_groups", "industry", ":industry_classification", ":industry_code" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "industry_classification", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "industry_code", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "sessionid" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "14ae7d16-cafe-4ecd-b77b-1e04376c66dc", "name": "Indicates a successful request.", "originalRequest": { "url": { "path": [ "api", "v1", "company_groups", "industry", ":industry_classification", ":industry_code" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "industry_classification", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "industry_code", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"companies\": [\n 669200555,\n 1755802872,\n 304098666,\n 20342986,\n 106768890,\n 104931852,\n 1832449314,\n 1841209336,\n 600549462,\n 20374017,\n 3711189\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ce6ab981-5a3d-4229-840c-678a69fb02a4", "name": "Indicates that the query is invalid.", "originalRequest": { "url": { "path": [ "api", "v1", "company_groups", "industry", ":industry_classification", ":industry_code" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "industry_classification", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "industry_code", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "7d47b762-9e0c-44a3-87c1-ff2616e29d83", "name": "Indicates that the authorization information is missing or invalid.", "originalRequest": { "url": { "path": [ "api", "v1", "company_groups", "industry", ":industry_classification", ":industry_code" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "industry_classification", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "industry_code", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5fcf9513-cf98-4eb5-b2b8-9570d0948584", "name": "Get Companies By GICS Code", "request": { "name": "Get Companies By GICS Code", "description": { "content": "Get the list of companies that are classified in the gics_code.\n\nReturns a dictionary of shape {\"companies\": List[]}.\nThe gics_code can be either a 2-digit Sector code, 4-digit Industry Group code, 6-digit Industry code, or 8-digit Sub-industry code.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "company_groups", "industry", "gics", ":gics_code" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "gics_code", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "sessionid" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "0837bdfa-9ff2-4fde-8fed-f9da47c953af", "name": "Indicates a successful request.", "originalRequest": { "url": { "path": [ "api", "v1", "company_groups", "industry", "gics", ":gics_code" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "gics_code", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"companies\": [\n 1905805991,\n 1865646430,\n 1872949585,\n 1813054728,\n 20934664,\n 657206722,\n 718559668,\n 371363826\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "21d92299-db2a-4c11-bc3a-685b367d42e3", "name": "Indicates that the query is invalid.", "originalRequest": { "url": { "path": [ "api", "v1", "company_groups", "industry", "gics", ":gics_code" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "gics_code", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "7868e672-c675-464d-bf3d-0868ac3f65e3", "name": "Indicates that the authorization information is missing or invalid.", "originalRequest": { "url": { "path": [ "api", "v1", "company_groups", "industry", "gics", ":gics_code" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "gics_code", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a8ff3227-7c5a-4648-a2cd-dd37c29a9468", "name": "Get Companies By Simple Industry", "request": { "name": "Get Companies By Simple Industry", "description": { "content": "Get the list of companies that are in the given simple_industry", "type": "text/plain" }, "url": { "path": [ "api", "v1", "company_groups", "industry", "simple", ":simple_industry" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "simple_industry", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "sessionid" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "2e07cbc4-53fd-4074-a84b-1ea9f985a6a2", "name": "Indicates a successful request.", "originalRequest": { "url": { "path": [ "api", "v1", "company_groups", "industry", "simple", ":simple_industry" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "simple_industry", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"companies\": [\n 557556508,\n 915908,\n 326636850,\n 13757207,\n 1780112191,\n 291946353,\n 658420583,\n 408856966\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "53284559-69d9-4a99-9843-c31ab2fac74e", "name": "Indicates that the query is invalid.", "originalRequest": { "url": { "path": [ "api", "v1", "company_groups", "industry", "simple", ":simple_industry" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "simple_industry", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "445bcdb9-d3f6-46f5-9c3d-50d6d0f834ed", "name": "Indicates that the authorization information is missing or invalid.", "originalRequest": { "url": { "path": [ "api", "v1", "company_groups", "industry", "simple", ":simple_industry" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "simple_industry", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e8170e94-52c0-4570-b9ab-fbca0ba90eef", "name": "Get Competitors from Company", "request": { "name": "Get Competitors from Company", "description": { "content": "Get the list of company_id and company_name that are competitors of company_id, optionally filtered by the competitor_source type.\n\nParameters:\n company_id (int): The requested company_id\n competitor_source (CompetitorSourceType): The source type of the competitor information: 'filing' (from SEC filings), 'key_dev' (from key developments), 'contact' (from contact relationships), 'third_party' (from third-party sources), 'self_identified' (self-identified), 'named_by_competitor' (from competitor's perspective).\"\nReturns a dictionary of shape {\"competitors\": List[{“company_id”: , \"company_name\": }]},", "type": "text/plain" }, "url": { "path": [ "api", "v1", "competitors", ":company_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "company_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "sessionid" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "5373733b-39a1-42f9-adb0-11ff869c099d", "name": "Indicates a successful request.", "originalRequest": { "url": { "path": [ "api", "v1", "competitors", ":company_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "company_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"competitors\": [\n {\n \"company_id\": 8122148,\n \"company_name\": \"Experian plc\"\n },\n {\n \"company_id\": 109450,\n \"company_name\": \"MarketAxess Holdings Inc.\"\n },\n {\n \"company_id\": 4973712,\n \"company_name\": \"Stride, Inc.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d7ca4cc8-dd8c-45a2-aa87-9b9a427fd4d5", "name": "Indicates that the authorization information is missing or invalid.", "originalRequest": { "url": { "path": [ "api", "v1", "competitors", ":company_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "company_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "771cfaaa-5373-4506-93ad-bc40f2c32e9f", "name": "Get Competitors from Company 2", "request": { "name": "Get Competitors from Company 2", "description": { "content": "Get the list of company_id and company_name that are competitors of company_id, optionally filtered by the competitor_source type.\n\nParameters:\n company_id (int): The requested company_id\n competitor_source (CompetitorSourceType): The source type of the competitor information: 'filing' (from SEC filings), 'key_dev' (from key developments), 'contact' (from contact relationships), 'third_party' (from third-party sources), 'self_identified' (self-identified), 'named_by_competitor' (from competitor's perspective).\"\nReturns a dictionary of shape {\"competitors\": List[{“company_id”: , \"company_name\": }]},", "type": "text/plain" }, "url": { "path": [ "api", "v1", "competitors", ":company_id", ":competitor_source" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "company_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "competitor_source", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "sessionid" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "483d9b9b-752b-4132-97d6-1b3d0fd4380e", "name": "Indicates a successful request.", "originalRequest": { "url": { "path": [ "api", "v1", "competitors", ":company_id", ":competitor_source" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "company_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "competitor_source", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"competitors\": [\n {\n \"company_id\": 8122148,\n \"company_name\": \"Experian plc\"\n },\n {\n \"company_id\": 109450,\n \"company_name\": \"MarketAxess Holdings Inc.\"\n },\n {\n \"company_id\": 4973712,\n \"company_name\": \"Stride, Inc.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "90c862fe-0687-45d0-92ba-57a1321acb5e", "name": "Indicates that the authorization information is missing or invalid.", "originalRequest": { "url": { "path": [ "api", "v1", "competitors", ":company_id", ":competitor_source" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "company_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "competitor_source", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "07d43133-3fcd-4503-a495-fb3859df61e3", "name": "Get CUSIP", "request": { "name": "Get CUSIP", "description": { "content": "Get the CUSIP for a given security_id", "type": "text/plain" }, "url": { "path": [ "api", "v1", "cusip", ":security_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "security_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "sessionid" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "cf8618c7-8e21-45c3-9053-c0c62499af90", "name": "Indicates a successful request.", "originalRequest": { "url": { "path": [ "api", "v1", "cusip", ":security_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "security_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"cusip\": \"Y11757104\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b12f3767-0dcb-4834-88ea-54129f46524c", "name": "Indicates that the query is invalid.", "originalRequest": { "url": { "path": [ "api", "v1", "cusip", ":security_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "security_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f86a4fb7-ea06-4b5a-bcf0-8dc08937f3f4", "name": "Indicates that the authorization information is missing or invalid.", "originalRequest": { "url": { "path": [ "api", "v1", "cusip", ":security_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "security_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "61999fa3-fd46-429f-8efd-64458bba4b77", "name": "Indicates that no CUSIP was found for the given security_id.", "originalRequest": { "url": { "path": [ "api", "v1", "cusip", ":security_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "security_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ce1892a5-df5e-4070-ac1c-9f0df4b4c951", "name": "Get Earnings Calls", "request": { "name": "Get Earnings Calls", "description": { "content": "Get metadata (name, key dev id, and datetime) for earnings calls for a given company_id.\n\nThe response comprises metadata for all upcoming and past earnings calls in\ndescending order by datetime. The key dev id can be used with the transcript\nendpoints to retrieve the earnings call transcript.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "earnings", ":company_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "company_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "sessionid" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "a23eb943-06bf-45d0-8198-4c4844392496", "name": "Indicates a successful request.", "originalRequest": { "url": { "path": [ "api", "v1", "earnings", ":company_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "company_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"earnings\": [\n {\n \"name\": \"S&P Global Inc., Q1 2025 Earnings Call, Apr 29, 2025\",\n \"key_dev_id\": 1916266380,\n \"datetime\": \"2025-02-11 13:30:00.000\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c6ea88cd-dc34-4cab-9708-a2c306a8131d", "name": "Indicates that request parameters are invalid.", "originalRequest": { "url": { "path": [ "api", "v1", "earnings", ":company_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "company_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "fa4a5d6c-2537-42a9-bb66-c77cb073230d", "name": "Indicates that the authorization information is missing or invalid.", "originalRequest": { "url": { "path": [ "api", "v1", "earnings", ":company_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "company_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b7dae1e3-59d4-4d7c-b341-3f7e84f5c0f9", "name": "Get Earnings Calls Dates", "request": { "name": "Get Earnings Calls Dates", "description": { "content": "Get the earnings calls in datetime for a given company_id in UTC", "type": "text/plain" }, "url": { "path": [ "api", "v1", "earnings", ":company_id", "dates" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "company_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "sessionid" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "b6c7a7b6-6b60-449b-9e03-d302d3b5f505", "name": "Indicates a successful request.", "originalRequest": { "url": { "path": [ "api", "v1", "earnings", ":company_id", "dates" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "company_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"earnings\": [\n \"2024-02-01T22:00:00.000\",\n \"2023-11-02T21:00:00.000\",\n \"2023-08-03T21:00:00.000\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6622da3b-0645-43a1-989a-e5cd1116b50c", "name": "Indicates that request parameters are invalid.", "originalRequest": { "url": { "path": [ "api", "v1", "earnings", ":company_id", "dates" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "company_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "6918cbfa-7ae3-426f-b498-560a9f55c91b", "name": "Indicates that the authorization information is missing or invalid.", "originalRequest": { "url": { "path": [ "api", "v1", "earnings", ":company_id", "dates" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "company_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7013d400-9adc-455b-9ca5-8f51ad175e80", "name": "Get Estimates", "request": { "name": "Get Estimates", "description": { "content": "Get the consensus estimates or guidance for a given company.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "estimates", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "sessionid" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "key": "company_id", "value": "", "description": "(Required) " }, { "disabled": false, "key": "estimate_type", "value": "" }, { "disabled": false, "key": "period_type", "value": "" }, { "disabled": false, "key": "fiscal_start_year", "value": "" }, { "disabled": false, "key": "fiscal_end_year", "value": "" }, { "disabled": false, "key": "fiscal_start_quarter", "value": "" }, { "disabled": false, "key": "fiscal_end_quarter", "value": "" }, { "disabled": false, "key": "num_periods_forward", "value": "" }, { "disabled": false, "key": "num_periods_backward", "value": "" } ] } }, "response": [ { "id": "d2ed6af4-3ca4-4a95-bea7-fd8a9c928ebf", "name": "Indicates a successful request.", "originalRequest": { "url": { "path": [ "api", "v1", "estimates", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "company_id", "value": "" }, { "disabled": false, "key": "estimate_type", "value": "" }, { "disabled": false, "key": "period_type", "value": "" }, { "disabled": false, "key": "fiscal_start_year", "value": "" }, { "disabled": false, "key": "fiscal_end_year", "value": "" }, { "disabled": false, "key": "fiscal_start_quarter", "value": "" }, { "disabled": false, "key": "fiscal_end_quarter", "value": "" }, { "disabled": false, "key": "num_periods_forward", "value": "" }, { "disabled": false, "key": "num_periods_backward", "value": "" } ] } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"results\": {\n \"24937\": {\n \"estimate_type\": \"consensus\",\n \"currency\": \"USD\",\n \"period_type\": \"quarterly\",\n \"periods\": {\n \"FY2025Q4\": {\n \"period_end_date\": \"2025-12-31\",\n \"estimates\": [\n {\n \"name\": \"Revenue Consensus High\",\n \"value\": \"3955000000.000000\"\n },\n {\n \"name\": \"Revenue Consensus Low\",\n \"value\": \"3806400000.000000\"\n },\n {\n \"name\": \"Revenue Consensus Mean\",\n \"value\": \"3881725460.000000\"\n },\n {\n \"name\": \"Revenue Consensus Median\",\n \"value\": \"3883000000.000000\"\n }\n ]\n }\n }\n }\n },\n \"errors\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c7564a4c-5f09-498a-be39-16d0c4ded028", "name": "Indicates that the input parameters are invalid.", "originalRequest": { "url": { "path": [ "api", "v1", "estimates", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "company_id", "value": "" }, { "disabled": false, "key": "estimate_type", "value": "" }, { "disabled": false, "key": "period_type", "value": "" }, { "disabled": false, "key": "fiscal_start_year", "value": "" }, { "disabled": false, "key": "fiscal_end_year", "value": "" }, { "disabled": false, "key": "fiscal_start_quarter", "value": "" }, { "disabled": false, "key": "fiscal_end_quarter", "value": "" }, { "disabled": false, "key": "num_periods_forward", "value": "" }, { "disabled": false, "key": "num_periods_backward", "value": "" } ] } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "5f2e160a-5c49-4cf7-b7a7-3f650e66cbf0", "name": "Indicates that the authorization information is missing or invalid.", "originalRequest": { "url": { "path": [ "api", "v1", "estimates", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "company_id", "value": "" }, { "disabled": false, "key": "estimate_type", "value": "" }, { "disabled": false, "key": "period_type", "value": "" }, { "disabled": false, "key": "fiscal_start_year", "value": "" }, { "disabled": false, "key": "fiscal_end_year", "value": "" }, { "disabled": false, "key": "fiscal_start_quarter", "value": "" }, { "disabled": false, "key": "fiscal_end_quarter", "value": "" }, { "disabled": false, "key": "num_periods_forward", "value": "" }, { "disabled": false, "key": "num_periods_backward", "value": "" } ] } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "df77cab2-2a34-47c2-890c-9007e8c4aad3", "name": "Get Analyst Recommendations", "request": { "name": "Get Analyst Recommendations", "description": { "content": "Get analyst recommendations for a given company_id.\n\nReturns counts of analyst recommendations by rating category and an aggregate analyst consensus score. S&P Global Market Intelligence\nstandardizes ratings across brokers on a 5-point scale: 1 = Buy, 2 = Outperform, 3 = Hold, 4 = Underperform, 5 = Sell.\nIf an analyst does not provide a recommendation, S&P Global assigns a rating of 'No Opinion'.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "estimates", "analyst_recommendations", ":company_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "company_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "sessionid" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "5106ca46-b3de-4a4b-9905-495ac4ee4a7a", "name": "Indicates a successful request.", "originalRequest": { "url": { "path": [ "api", "v1", "estimates", "analyst_recommendations", ":company_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "company_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"results\": {\n \"24937\": {\n \"effective_date\": \"2026-03-03\",\n \"estimates\": [\n {\n \"name\": \"Consensus Recommendation\",\n \"value\": \"1.936170\"\n },\n {\n \"name\": \"# of Analysts No Opinion Recommendation - (In-Consensus)\",\n \"value\": \"2.000000\"\n },\n {\n \"name\": \"# of Analysts Buy Recommendation - (In-Consensus)\",\n \"value\": \"24.000000\"\n },\n {\n \"name\": \"# of Analysts Sell Recommendation - (In-Consensus)\",\n \"value\": \"1.000000\"\n },\n {\n \"name\": \"# of Analysts Hold Recommendation - (In-Consensus)\",\n \"value\": \"16.000000\"\n },\n {\n \"name\": \"# of Analysts Outperform Recommendation - (In-Consensus)\",\n \"value\": \"5.000000\"\n },\n {\n \"name\": \"# of Analysts Underperform Recommendation - (In-Consensus)\",\n \"value\": \"1.000000\"\n }\n ]\n }\n },\n \"errors\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d3046a11-3bee-4ffd-b75b-5ffb80263eea", "name": "Indicates that the input parameters are invalid.", "originalRequest": { "url": { "path": [ "api", "v1", "estimates", "analyst_recommendations", ":company_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "company_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "3a1b48d4-f0c0-4f04-a56b-8bf20377a08a", "name": "Indicates that the authorization information is missing or invalid.", "originalRequest": { "url": { "path": [ "api", "v1", "estimates", "analyst_recommendations", ":company_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "company_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b981f708-904d-4f94-a136-b623932f94bf", "name": "Get Consensus Target Price", "request": { "name": "Get Consensus Target Price", "description": { "content": "Get the consensus target price estimates for a given company_id.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "estimates", "consensus_target_price", ":company_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "company_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "sessionid" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "eb28d7d8-0dae-4ab6-944c-9be354eea963", "name": "Indicates a successful request.", "originalRequest": { "url": { "path": [ "api", "v1", "estimates", "consensus_target_price", ":company_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "company_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"results\": {\n \"24937\": {\n \"currency\": \"USD\",\n \"effective_date\": \"2026-03-03\",\n \"estimates\": [\n {\n \"name\": \"Target Price Consensus Mean\",\n \"value\": \"293.289020\"\n },\n {\n \"name\": \"Target Price Consensus Median\",\n \"value\": \"300.000000\"\n },\n {\n \"name\": \"Target Price Consensus High\",\n \"value\": \"350.000000\"\n },\n {\n \"name\": \"Target Price Consensus Low\",\n \"value\": \"205.000000\"\n },\n {\n \"name\": \"Target Price - # of Estimates\",\n \"value\": \"41.000000\"\n },\n {\n \"name\": \"Target Price - Standard Deviation\",\n \"value\": \"32.468260\"\n }\n ]\n }\n },\n \"errors\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aaf18a7a-d0c3-447a-89a8-8724253f10b8", "name": "Indicates that the input parameters are invalid.", "originalRequest": { "url": { "path": [ "api", "v1", "estimates", "consensus_target_price", ":company_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "company_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "9d13b18b-acb3-4fb5-a957-1c2a9ea1a17d", "name": "Indicates that the authorization information is missing or invalid.", "originalRequest": { "url": { "path": [ "api", "v1", "estimates", "consensus_target_price", ":company_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "company_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "095e5f2e-3f43-499b-9d04-164ced393a42", "name": "fundinground info retrieve", "request": { "name": "fundinground info retrieve", "description": { "content": "Get detailed information about a round of funding.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "fundinground", "info", ":transaction_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "transaction_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "sessionid" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "b3579b98-074b-4f17-8c2e-80fce9465998", "name": "Indicates a successful request.", "originalRequest": { "url": { "path": [ "api", "v1", "fundinground", "info", ":transaction_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "transaction_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"timeline\": {\n \"announced_date\": \"2017-02-09\",\n \"closed_date\": \"2016-12-31\"\n },\n \"participants\": {\n \"target\": {\n \"company_id\": 251994106,\n \"company_name\": \"Kensho Technologies, Inc.\"\n },\n \"investors\": [\n {\n \"company_id\": 21719,\n \"company_name\": \"S&P Global Inc.\",\n \"lead_investor\": true,\n \"investment_value\": null\n },\n {\n \"company_id\": 292891,\n \"company_name\": \"Wells Fargo & Company\",\n \"lead_investor\": false,\n \"investment_value\": null\n }\n ]\n },\n \"transaction\": {\n \"funding_type\": \"Series B\",\n \"amount_offered\": \"50000000.00000000\",\n \"currency\": \"USD\",\n \"legal_fees\": null,\n \"other_fees\": null,\n \"initial_gross_amount_offered\": \"50000000.00000000\",\n \"offering_size_change\": \"Unchanged\",\n \"upsized_amount\": \"0.00000000\",\n \"upsized_amount_percent\": \"0.00000000\",\n \"pre_money_valuation\": \"450000000.00000000\",\n \"post_money_valuation\": \"500000000.00000000\",\n \"aggregate_amount_raised\": \"104961538.00000000\",\n \"liquidation_preference\": null,\n \"anti_dilution_method\": null,\n \"liquidation_price\": null,\n \"option_pool\": null,\n \"participating_preferred_cap\": null,\n \"liquidation_preference_multiple\": null,\n \"use_of_proceeds\": \"Kensho Technologies Inc. will use the proceeds in part toward buying more data sets to supplement its current pool of information and toward bringing its technology to other industries.\",\n \"pre_deal_situation\": null,\n \"redemption\": null,\n \"cumulative_dividends\": null,\n \"reorganization\": null,\n \"pay_to_play\": null,\n \"pay_to_play_penalties\": null\n },\n \"security\": {\n \"dividend_per_share\": null,\n \"annualized_dividend_rate\": null,\n \"seniority_level\": null,\n \"coupon_type\": null,\n \"funding_convertible_type\": null,\n \"security_description\": \"Undisclosed\",\n \"class_series_tranche\": null\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a0e7d9b5-f6d6-40bc-97ae-e80358d6aab0", "name": "Indicates that the query is invalid.", "originalRequest": { "url": { "path": [ "api", "v1", "fundinground", "info", ":transaction_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "transaction_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a66e2dcb-bb77-43cf-82b7-484e12b73638", "name": "Indicates that the authorization information is missing or invalid.", "originalRequest": { "url": { "path": [ "api", "v1", "fundinground", "info", ":transaction_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "transaction_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "8148ab1a-38a3-48ac-b857-0d5ce5dcc686", "name": "Indicates that no round of funding info was found for the given transaction_id.", "originalRequest": { "url": { "path": [ "api", "v1", "fundinground", "info", ":transaction_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "transaction_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7d51e53c-512f-4089-8265-c05e71ba80b2", "name": "fundinground info advisors investor retrieve", "request": { "name": "fundinground info advisors investor retrieve", "description": { "content": "Get the advisors and their types for a company buying into a round of funding.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "fundinground", "info", ":transaction_id", "advisors", "investor", ":advised_company_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "advised_company_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "transaction_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "sessionid" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "61d6b9eb-1c99-4779-a4a3-2483acf38634", "name": "Indicates a successful request.", "originalRequest": { "url": { "path": [ "api", "v1", "fundinground", "info", ":transaction_id", "advisors", "investor", ":advised_company_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "advised_company_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "transaction_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"advisors\": [\n {\n \"advisor_company_id\": 22439,\n \"advisor_company_name\": \"DLA Piper LLP (US)\",\n \"advisor_type_name\": \"Legal Counsel\",\n \"advisor_fee_amount\": \"3750000.0000\",\n \"advisor_fee_currency\": \"USD\",\n \"is_lead\": true\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0f30766b-9fde-4e97-bbb3-20609aacab2a", "name": "Indicates that the authorization information is missing or invalid.", "originalRequest": { "url": { "path": [ "api", "v1", "fundinground", "info", ":transaction_id", "advisors", "investor", ":advised_company_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "advised_company_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "transaction_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "bcb3f3aa-b59c-498f-b96a-72c1379c3bb0", "name": "fundinground info advisors target retrieve", "request": { "name": "fundinground info advisors target retrieve", "description": { "content": "Get the advisors and their types for the company raising a round of funding.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "fundinground", "info", ":transaction_id", "advisors", "target" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "transaction_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "sessionid" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "d777b285-3dc8-402e-9257-9256b4d5357d", "name": "Indicates a successful request.", "originalRequest": { "url": { "path": [ "api", "v1", "fundinground", "info", ":transaction_id", "advisors", "target" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "transaction_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"advisors\": [\n {\n \"advisor_company_id\": 286743412,\n \"advisor_company_name\": \"PJT Partners Inc.\",\n \"advisor_type_name\": \"Financial Adviser\",\n \"advisor_fee_amount\": \"2500000.0000\",\n \"advisor_fee_currency\": \"USD\",\n \"is_lead\": true\n },\n {\n \"advisor_company_id\": 106880,\n \"advisor_company_name\": \"Simpson Thacher & Bartlett LLP\",\n \"advisor_type_name\": \"Legal Counsel\",\n \"advisor_fee_amount\": \"1200000.0000\",\n \"advisor_fee_currency\": \"USD\",\n \"is_lead\": false\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5e57ea62-f184-4db5-8aed-7970235de872", "name": "Indicates that the authorization information is missing or invalid.", "originalRequest": { "url": { "path": [ "api", "v1", "fundinground", "info", ":transaction_id", "advisors", "target" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "transaction_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "893e550d-0667-46e3-a2a8-40f66153b74c", "name": "fundingrounds investor retrieve", "request": { "name": "fundingrounds investor retrieve", "description": { "content": "Get the rounds of funding that the specified company invested in.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "fundingrounds", "investor", ":company_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "company_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "sessionid" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "989440e8-8540-4c70-a8e5-f37e85debf5b", "name": "Indicates a successful request.", "originalRequest": { "url": { "path": [ "api", "v1", "fundingrounds", "investor", ":company_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "company_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"rounds_of_funding\": [\n {\n \"transaction_id\": 444715,\n \"funding_round_notes\": \"e-Builder, Inc. announced a strategic round of funding from new investor The McGraw-Hill Companies, Inc. on May 1, 2000.\",\n \"closed_date\": \"2000-05-01\",\n \"funding_type\": \"Venture\"\n },\n {\n \"transaction_id\": 383751,\n \"funding_round_notes\": \"Gather, Inc. announced that it will raise $2,400,000 through the issuance of equity shares on November 17, 2010. The securities will be issued pursuant to Regulation D.\",\n \"closed_date\": \"2010-11-24\",\n \"funding_type\": \"Series E\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4e27830c-ad93-4cef-b5e8-69b59fae6ea5", "name": "Indicates that the authorization information is missing or invalid.", "originalRequest": { "url": { "path": [ "api", "v1", "fundingrounds", "investor", ":company_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "company_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d382c859-79d3-467b-a395-bd77823826ac", "name": "fundingrounds target retrieve", "request": { "name": "fundingrounds target retrieve", "description": { "content": "Get the rounds of funding that the specified company was in.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "fundingrounds", "target", ":company_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "company_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "sessionid" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "fd2425ea-114b-4580-8e03-d016356ed682", "name": "Indicates a successful request.", "originalRequest": { "url": { "path": [ "api", "v1", "fundingrounds", "target", ":company_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "company_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"rounds_of_funding\": [\n {\n \"transaction_id\": 334220,\n \"funding_round_notes\": \"Kensho Technologies Inc. announced that it has received funding from new investor, Impresa Management LLC in 2013.\",\n \"closed_date\": \"2013-12-31\",\n \"funding_type\": \"Seed\"\n },\n {\n \"transaction_id\": 242311,\n \"funding_round_notes\": \"Kensho Technologies Inc. announced that it will receive $740,000 in funding on January 29, 2014. The company will issue convertible debt securities in the transaction. The company will issue securities pursuant to exemption provided under Regulation D.\",\n \"closed_date\": \"2014-02-13\",\n \"funding_type\": \"Debt\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2489e1a4-e5b9-490e-beb0-50ab7ea00ba6", "name": "Indicates that the authorization information is missing or invalid.", "originalRequest": { "url": { "path": [ "api", "v1", "fundingrounds", "target", ":company_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "company_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b71de82d-efc6-4241-99de-ba97639c5252", "name": "CUSIP to Identification Triple", "request": { "name": "CUSIP to Identification Triple", "description": { "content": "Get the most likely trading_item_id, security_id, and company_id with a given CUSIP.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "id", ":cusip" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "cusip", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "sessionid" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "f6a62434-ea9f-48cf-8c56-2f7d9254d0a1", "name": "Indicates a successful request.", "originalRequest": { "url": { "path": [ "api", "v1", "id", ":cusip" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "cusip", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"trading_item_id\": 2590360,\n \"security_id\": 2590359,\n \"company_id\": 24937,\n \"company_name\": \"Apple, Inc.\",\n \"ticker\": \"NasdaqGS:AAPL\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6694c723-036d-4a0b-a603-2998b5ce8ca4", "name": "Indicates that the query is invalid.", "originalRequest": { "url": { "path": [ "api", "v1", "id", ":cusip" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "cusip", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "720b1ee3-15ec-449a-b81e-cd5191b43f41", "name": "Indicates that the authorization information is missing or invalid.", "originalRequest": { "url": { "path": [ "api", "v1", "id", ":cusip" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "cusip", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4101b15d-91d9-4d9a-b6c8-4437ec944ef4", "name": "ISIN to Identification Triple", "request": { "name": "ISIN to Identification Triple", "description": { "content": "Get the most likely trading_item_id, security_id, and company_id with a given ISIN.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "id", ":isin" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "isin", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "sessionid" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "0fe5f044-387e-46a3-8f52-374f4374b37a", "name": "Indicates a successful request.", "originalRequest": { "url": { "path": [ "api", "v1", "id", ":isin" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "isin", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"trading_item_id\": 2590360,\n \"security_id\": 2590359,\n \"company_id\": 24937,\n \"company_name\": \"Apple, Inc.\",\n \"ticker\": \"NasdaqGS:AAPL\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2f793a2a-1e94-4761-ab7a-015eea62fd4d", "name": "Indicates that the query is invalid.", "originalRequest": { "url": { "path": [ "api", "v1", "id", ":isin" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "isin", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "2c74ad91-7559-43ab-87c1-1bd9462318bc", "name": "Indicates that the authorization information is missing or invalid.", "originalRequest": { "url": { "path": [ "api", "v1", "id", ":isin" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "isin", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d56e5cc7-27ff-45b7-bdbc-37a2cff40a8b", "name": "Ticker to Identification Triple", "request": { "name": "Ticker to Identification Triple", "description": { "content": "Get the most likely trading_item_id, security_id, and company_id with a given ticker symbol.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "id", ":ticker" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "ticker", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "sessionid" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "631fea9c-0113-4df3-92a0-4f5be4d8471f", "name": "Indicates a successful request.", "originalRequest": { "url": { "path": [ "api", "v1", "id", ":ticker" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "ticker", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"trading_item_id\": 2590360,\n \"security_id\": 2590359,\n \"company_id\": 24937,\n \"company_name\": \"Apple, Inc.\",\n \"ticker\": \"NasdaqGS:AAPL\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c562097a-61f2-472d-bb92-a12ada2cd38a", "name": "Indicates that the query is invalid.", "originalRequest": { "url": { "path": [ "api", "v1", "id", ":ticker" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "ticker", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "cd797ec8-d5a6-4144-a77d-c7d74f034954", "name": "Indicates that the authorization information is missing or invalid.", "originalRequest": { "url": { "path": [ "api", "v1", "id", ":ticker" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "ticker", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1f4ee70d-21c1-48d7-9003-0c8fae99a63f", "name": "Ticker to Identification Triple 2", "request": { "name": "Ticker to Identification Triple 2", "description": { "content": "Get the most likely trading_item_id, security_id, and company_id with a given ticker symbol.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "id", ":ticker", "exchange_code", ":exchange_code" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "exchange_code", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "ticker", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "sessionid" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "ad001a66-f325-4c4c-a1ce-c6e729159015", "name": "Indicates a successful request.", "originalRequest": { "url": { "path": [ "api", "v1", "id", ":ticker", "exchange_code", ":exchange_code" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "exchange_code", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "ticker", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"trading_item_id\": 2590360,\n \"security_id\": 2590359,\n \"company_id\": 24937,\n \"company_name\": \"Apple, Inc.\",\n \"ticker\": \"NasdaqGS:AAPL\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "60754f89-c3d9-476b-8075-e4f1453ca7d3", "name": "Indicates that the query is invalid.", "originalRequest": { "url": { "path": [ "api", "v1", "id", ":ticker", "exchange_code", ":exchange_code" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "exchange_code", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "ticker", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c070d887-2fb7-4591-94f0-d6162284dfe5", "name": "Indicates that the authorization information is missing or invalid.", "originalRequest": { "url": { "path": [ "api", "v1", "id", ":ticker", "exchange_code", ":exchange_code" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "exchange_code", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "ticker", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b4703aad-199a-444e-8f8e-3f7185f635a7", "name": "Unified Identification Triple", "request": { "name": "Unified Identification Triple", "description": { "content": "Get the most likely trading_item_id, security_id, and company_id for various identifier types (ISIN, CUSIP, Company ID, ticker, or company name).", "type": "text/plain" }, "url": { "path": [ "api", "v1", "ids" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "sessionid" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "key": "identifiers", "value": "", "description": "(Required) List of identifiers to resolve (can include ISINs, CUSIPs, company names, company IDs, tickers, or company names)" } ] } }, "response": [ { "id": "36694efd-cbd2-4759-afba-ca2c4734a512", "name": "Indicates a successful request. Returns a mapping of identifiers to their identification triples.", "originalRequest": { "url": { "path": [ "api", "v1", "ids" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "description": { "content": "(Required) List of identifiers to resolve (can include ISINs, CUSIPs, company names, company IDs, tickers, or company names)", "type": "text/plain" }, "key": "identifiers", "value": "" } ] } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"37833100\": {\n \"trading_item_id\": 2590360,\n \"security_id\": 2590359,\n \"company_id\": 24937,\n \"company_name\": \"Apple, Inc.\",\n \"ticker\": \"NasdaqGS:AAPL\"\n },\n \"AAPL\": {\n \"trading_item_id\": 2590360,\n \"security_id\": 2590359,\n \"company_id\": 24937,\n \"company_name\": \"Apple, Inc.\",\n \"ticker\": \"NasdaqGS:AAPL\"\n },\n \"US0378331005\": {\n \"trading_item_id\": 2590360,\n \"security_id\": 2590359,\n \"company_id\": 24937,\n \"company_name\": \"Apple, Inc.\",\n \"ticker\": \"NasdaqGS:AAPL\"\n },\n \"Apple Inc.\": {\n \"trading_item_id\": 2590360,\n \"security_id\": 2590359,\n \"company_id\": 24937,\n \"company_name\": \"Apple, Inc.\",\n \"ticker\": \"NasdaqGS:AAPL\"\n },\n \"C_874695\": {\n \"trading_item_id\": 2590360,\n \"security_id\": 2590359,\n \"company_id\": 24937,\n \"company_name\": \"Apple, Inc.\",\n \"ticker\": \"NasdaqGS:AAPL\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e2673b6b-c1bb-4b92-a55b-d39517ea5355", "name": "Indicates that the request is invalid or missing required parameters.", "originalRequest": { "url": { "path": [ "api", "v1", "ids" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "description": { "content": "(Required) List of identifiers to resolve (can include ISINs, CUSIPs, company names, company IDs, tickers, or company names)", "type": "text/plain" }, "key": "identifiers", "value": "" } ] } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b043eb1d-769d-43a0-8112-bf8372979a47", "name": "Indicates that the authorization information is missing or invalid.", "originalRequest": { "url": { "path": [ "api", "v1", "ids" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "description": { "content": "(Required) List of identifiers to resolve (can include ISINs, CUSIPs, company names, company IDs, tickers, or company names)", "type": "text/plain" }, "key": "identifiers", "value": "" } ] } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "405ea9b6-a9a3-4297-95e1-cdfdd7216ff0", "name": "Get Company Information", "request": { "name": "Get Company Information", "description": { "content": "Get the general information of a given company_id, such as name, status, company type, simple industry, number of employees, founding date, webpage, and address.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "info", ":company_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "company_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "sessionid" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "eda39ccf-353b-494e-accb-64ea2cbf6001", "name": "Indicates a successful request.", "originalRequest": { "url": { "path": [ "api", "v1", "info", ":company_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "company_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"name\": \"Apple Inc.\",\n \"status\": \"Operating\",\n \"type\": \"Public Company\",\n \"simple_industry\": \"Technology Hardware, Storage and Peripherals\",\n \"number_of_employees\": \"161000.0000\",\n \"founding_date\": \"1976-01-01\",\n \"webpage\": \"www.apple.com\",\n \"address\": \"One Apple Park Way\",\n \"city\": \"Cupertino\",\n \"zip_code\": \"95014\",\n \"state\": \"California\",\n \"country\": \"United States\",\n \"iso_country\": \"USA\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ed19e427-a18f-43b5-8c19-f809bf36a676", "name": "Indicates that request parameters are invalid.", "originalRequest": { "url": { "path": [ "api", "v1", "info", ":company_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "company_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "5c044eed-832e-44d2-b2d3-d455c21acb5e", "name": "Indicates that the authorization information is missing or invalid.", "originalRequest": { "url": { "path": [ "api", "v1", "info", ":company_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "company_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "2ee9bd8c-fb21-4cc1-bf60-dbc2dce0bdc7", "name": "Indicates that no company info was found for the given company_id.", "originalRequest": { "url": { "path": [ "api", "v1", "info", ":company_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "company_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "38fb63d0-e7f1-451f-b205-4b3d81068828", "name": "info descriptions retrieve", "request": { "name": "info descriptions retrieve", "description": { "content": "Get the company's summary (short description) and description (long description)", "type": "text/plain" }, "url": { "path": [ "api", "v1", "info", ":company_id", "descriptions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "company_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "sessionid" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "8e154cea-c9b2-4ac2-a576-13081d99c040", "name": "Indicates a successful request.", "originalRequest": { "url": { "path": [ "api", "v1", "info", ":company_id", "descriptions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "company_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"summary\": \"S&P Global Inc., together with its subsidiaries, provides credit ratings, benchmarks, analytics, and workflow solutions in the global capital, commodity, and automotive markets. It operates through five segments: S&P Global Market Intelligence, S&P Global Ratings, S&P Global Commodity Insights, S&P Global Mobility, and S&P Dow Jones Indices...[truncated]. The summary (also called the short description) consists of a single paragraph up to 8,000 characters (including spaces). Short descriptions include: Primary business; Products and services offered and their applications; Business segment details; Client/customer groups served; Geographic markets served; Distribution channels; Strategic alliances/partnerships; Founded/incorporated year; Latest former name; Headquarters and additional offices\",\n \"description\": \"S&P Global Inc. (S&P Global), together with its subsidiaries, provides credit ratings, benchmarks, analytics, and workflow solutions in the global capital, commodity, and automotive markets.\\r\\n\\r\\nThe capital markets include asset managers, investment banks, commercial banks, insurance companies, exchanges, trading firms, and issuers...[truncated]. The description (also called the long description) contains an extensive profile of a company with no character limit and divided into sections that may include: Primary business; Segments (including Products and Services for each); Competition; Significant events; History\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7c7a90bc-bd30-463e-9332-2305b3d57609", "name": "Indicates that the authorization is missing or invalid.", "originalRequest": { "url": { "path": [ "api", "v1", "info", ":company_id", "descriptions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "company_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a6e36d48-6318-4671-a685-abb4b67891f7", "name": "Indicates that no company summary nor description were found for the given company_id.", "originalRequest": { "url": { "path": [ "api", "v1", "info", ":company_id", "descriptions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "company_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2993737e-fe3b-4686-8120-87a6854142ac", "name": "info names retrieve", "request": { "name": "info names retrieve", "description": { "content": "Get the company's other names: alternate_names (names that a company also goes by), historical_names (names that the company used to go by), and native_names (company names in native language)", "type": "text/plain" }, "url": { "path": [ "api", "v1", "info", ":company_id", "names" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "company_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "sessionid" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "0d0bb051-9c6d-4685-bc94-ab7548f38d0b", "name": "Indicates a successful request.", "originalRequest": { "url": { "path": [ "api", "v1", "info", ":company_id", "names" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "company_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"alternate_names\": [\n \"ANOBAKA Co Ltd\"\n ],\n \"historical_names\": [\n \"KVP Co., Ltd.\",\n \"KLab Venture Partners Co., Ltd.\"\n ],\n \"native_names\": [\n {\n \"name\": \"KLab Venture Partners 株式会社\",\n \"language\": \"Japanese\"\n },\n {\n \"name\": \"株式会社KVP\",\n \"language\": \"Japanese\"\n },\n {\n \"name\": \"株式会社ANOBAKA\",\n \"language\": \"Japanese\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "21386192-566b-4601-a656-dac46856e62d", "name": "Indicates that the authorization is missing or invalid.", "originalRequest": { "url": { "path": [ "api", "v1", "info", ":company_id", "names" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "company_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e2922921-0d87-4e37-9c1a-70c4dbbe55ec", "name": "Get ISIN", "request": { "name": "Get ISIN", "description": { "content": "Get the ISIN for a given security_id", "type": "text/plain" }, "url": { "path": [ "api", "v1", "isin", ":security_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "security_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "sessionid" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "c203cd79-24a1-437d-9e9c-22b1fa90cf8c", "name": "Indicates a successful request.", "originalRequest": { "url": { "path": [ "api", "v1", "isin", ":security_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "security_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"isin\": \"US0378331005\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5b592cad-d8c5-417c-9588-ab103a937e2a", "name": "Indicates that the query is invalid.", "originalRequest": { "url": { "path": [ "api", "v1", "isin", ":security_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "security_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a85b25c0-5c0d-4bbe-90aa-6719e188a936", "name": "Indicates that the authorization information is missing or invalid.", "originalRequest": { "url": { "path": [ "api", "v1", "isin", ":security_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "security_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "de2e15e7-69d9-4e6a-8d8a-33b48f5d9b4b", "name": "Indicates that no ISIN was found for the given security_id.", "originalRequest": { "url": { "path": [ "api", "v1", "isin", ":security_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "security_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "983bde0e-d2a9-4b35-9c74-67ba0dd8c94e", "name": "Get Latest Date", "request": { "name": "Get Latest Date", "description": { "content": "Get the latest annual reporting year, latest quarterly reporting quarter and year, and current date in UTC. The output is a dictionary with the following schema::\n\n{\n \"annual\": {\n \"latest_year\": int\n },\n \"quarterly\": {\n \"latest_quarter\": int,\n \"latest_year\": int\n },\n \"now\": {\n \"current_year\": int,\n \"current_quarter\": int,\n \"current_month\": int,\n \"current_date\": str # in format Y-m-d\n }\n}", "type": "text/plain" }, "url": { "path": [ "api", "v1", "latest" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "sessionid" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "d2020757-7689-4f53-b273-89636d19f5fd", "name": "Indicates a successful request.", "originalRequest": { "url": { "path": [ "api", "v1", "latest" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"annual\": {\n \"latest_year\": 2023\n },\n \"quarterly\": {\n \"latest_quarter\": 3,\n \"latest_year\": 2024\n },\n \"now\": {\n \"current_year\": 2024,\n \"current_quarter\": 4,\n \"current_month\": 10,\n \"current_date\": \"2024-10-24\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "29521b92-16c7-4285-a004-f639dd61f2af", "name": "Indicates that the authorization information is missing or invalid.", "originalRequest": { "url": { "path": [ "api", "v1", "latest" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "45f0b481-45db-4489-8e89-2ebcfa87b904", "name": "Get Financial Line Item", "request": { "name": "Get Financial Line Item", "description": { "content": "Get a financial line item for a set of company_ids.\n\nFor a public company, the annual period_type returns annual calendar year values. For a private company, the annual period_type returns annual fiscal year values.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "line_item", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "sessionid" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "key": "company_ids", "value": "", "description": "(Required) " }, { "disabled": false, "key": "line_item", "value": "", "description": "(Required) " }, { "disabled": false, "key": "period_type", "value": "" }, { "disabled": false, "key": "start_year", "value": "" }, { "disabled": false, "key": "end_year", "value": "" }, { "disabled": false, "key": "start_quarter", "value": "" }, { "disabled": false, "key": "end_quarter", "value": "" }, { "disabled": false, "key": "calendar_type", "value": "" }, { "disabled": false, "key": "num_periods", "value": "" }, { "disabled": false, "key": "num_periods_back", "value": "" } ] } }, "response": [ { "id": "95697299-2237-494e-a6cf-9ac5242d8c56", "name": "Indicates a successful request.", "originalRequest": { "url": { "path": [ "api", "v1", "line_item", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "company_ids", "value": "" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "line_item", "value": "" }, { "disabled": false, "key": "period_type", "value": "" }, { "disabled": false, "key": "start_year", "value": "" }, { "disabled": false, "key": "end_year", "value": "" }, { "disabled": false, "key": "start_quarter", "value": "" }, { "disabled": false, "key": "end_quarter", "value": "" }, { "disabled": false, "key": "calendar_type", "value": "" }, { "disabled": false, "key": "num_periods", "value": "" }, { "disabled": false, "key": "num_periods_back", "value": "" } ] } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"results\": {\n \"24937\": {\n \"currency\": \"USD\",\n \"periods\": {\n \"FY2023Q1\": {\n \"period_end_date\": \"2022-12-31\",\n \"num_months\": 3,\n \"line_item\": {\n \"name\": \"Net Property Plant And Equipment\",\n \"value\": \"42951000000.000000\",\n \"sources\": [\n {\n \"type\": \"doc-viewer line item\",\n \"url\": \"https://www.capitaliq.spglobal.com/apisv3/spg-webplatform-core/docviewer?mid=217403557&uctSearch=42951.000000\"\n }\n ]\n }\n },\n \"FY2023Q2\": {\n \"period_end_date\": \"2023-04-01\",\n \"num_months\": 3,\n \"line_item\": {\n \"name\": \"Net Property Plant And Equipment\",\n \"value\": \"43398000000.000000\",\n \"sources\": [\n {\n \"type\": \"doc-viewer line item\",\n \"url\": \"https://www.capitaliq.spglobal.com/apisv3/spg-webplatform-core/docviewer?mid=222795059&uctSearch=43398.000000\"\n }\n ]\n }\n },\n \"FY2023Q3\": {\n \"period_end_date\": \"2023-07-01\",\n \"num_months\": 3,\n \"line_item\": {\n \"name\": \"Net Property Plant And Equipment\",\n \"value\": \"43550000000.000000\",\n \"sources\": [\n {\n \"type\": \"doc-viewer line item\",\n \"url\": \"https://www.capitaliq.spglobal.com/apisv3/spg-webplatform-core/docviewer?mid=228080297&uctSearch=43550.000000\"\n }\n ]\n }\n },\n \"FY2023Q4\": {\n \"period_end_date\": \"2023-09-30\",\n \"num_months\": 3,\n \"line_item\": {\n \"name\": \"Net Property Plant And Equipment\",\n \"value\": \"43715000000.000000\",\n \"sources\": [\n {\n \"type\": \"doc-viewer statement\",\n \"url\": \"https://www.capitaliq.spglobal.com/apisv3/spg-webplatform-core/docviewer?mid=232134583\"\n }\n ]\n }\n }\n }\n }\n },\n \"errors\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5bf08e22-33fb-4b0b-8635-90f151db1b6f", "name": "Indicates that the input parameters are invalid.", "originalRequest": { "url": { "path": [ "api", "v1", "line_item", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "company_ids", "value": "" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "line_item", "value": "" }, { "disabled": false, "key": "period_type", "value": "" }, { "disabled": false, "key": "start_year", "value": "" }, { "disabled": false, "key": "end_year", "value": "" }, { "disabled": false, "key": "start_quarter", "value": "" }, { "disabled": false, "key": "end_quarter", "value": "" }, { "disabled": false, "key": "calendar_type", "value": "" }, { "disabled": false, "key": "num_periods", "value": "" }, { "disabled": false, "key": "num_periods_back", "value": "" } ] } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "15d0b633-1cbe-4505-a209-c95949cc2675", "name": "Indicates that the authorization information is missing or invalid.", "originalRequest": { "url": { "path": [ "api", "v1", "line_item", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "company_ids", "value": "" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "line_item", "value": "" }, { "disabled": false, "key": "period_type", "value": "" }, { "disabled": false, "key": "start_year", "value": "" }, { "disabled": false, "key": "end_year", "value": "" }, { "disabled": false, "key": "start_quarter", "value": "" }, { "disabled": false, "key": "end_quarter", "value": "" }, { "disabled": false, "key": "calendar_type", "value": "" }, { "disabled": false, "key": "num_periods", "value": "" }, { "disabled": false, "key": "num_periods_back", "value": "" } ] } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "bc653cd4-fc80-4a51-a934-498c1ae22a34", "name": "Get Financial Line Item 2", "request": { "name": "Get Financial Line Item 2", "description": { "content": "Get a financial line item for a given company_id.\n\nFor a public company, the annual period_type returns annual calendar year values. For a private company, the annual period_type returns annual fiscal year values.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "line_item", ":company_id", ":line_item", ":period_type", ":start_year", ":end_year", ":start_quarter", ":end_quarter" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "company_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "end_quarter", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "end_year", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "line_item", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "period_type", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "start_quarter", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "start_year", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "sessionid" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "b0d11552-18e8-4795-8162-a3653d342d24", "name": "Indicates a successful request.", "originalRequest": { "url": { "path": [ "api", "v1", "line_item", ":company_id", ":line_item", ":period_type", ":start_year", ":end_year", ":start_quarter", ":end_quarter" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "company_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "end_quarter", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "end_year", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "line_item", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "period_type", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "start_quarter", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "start_year", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"calendar_type\": \"CALENDAR\",\n \"currency\": \"USD\",\n \"line_item\": {\n \"2019\": \"95957000000.000000\",\n \"2020\": \"112096000000.000000\",\n \"2021\": \"119810000000.000000\",\n \"2022\": \"124874000000.000000\",\n \"2023\": \"125260000000.000000\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "64c4b34d-f83a-417b-90d1-0d4f4af8abcf", "name": "Indicates that the input parameters are invalid.", "originalRequest": { "url": { "path": [ "api", "v1", "line_item", ":company_id", ":line_item", ":period_type", ":start_year", ":end_year", ":start_quarter", ":end_quarter" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "company_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "end_quarter", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "end_year", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "line_item", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "period_type", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "start_quarter", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "start_year", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e772a10d-ae2c-4e7c-8691-13c3b4b3bd45", "name": "Indicates that the authorization information is missing or invalid.", "originalRequest": { "url": { "path": [ "api", "v1", "line_item", ":company_id", ":line_item", ":period_type", ":start_year", ":end_year", ":start_quarter", ":end_quarter" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "company_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "end_quarter", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "end_year", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "line_item", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "period_type", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "start_quarter", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "start_year", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "088751a5-3b63-442d-9f93-7098de8ec2c8", "name": "Get Market Caps", "request": { "name": "Get Market Caps", "description": { "content": "Get the market caps between start and end date inclusive.\n\nThe returned data includes market_cap, tev (Total Enterprise Value), shares_outstanding, and its currency.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "market_cap", ":company_id", ":start_date", ":end_date" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "company_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "end_date", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "start_date", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "sessionid" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "7bfd1a1d-cc5c-4185-8696-9437928df15c", "name": "Indicates a successful request.", "originalRequest": { "url": { "path": [ "api", "v1", "market_cap", ":company_id", ":start_date", ":end_date" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "company_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "end_date", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "start_date", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"currency\": \"USD\",\n \"market_caps\": [\n {\n \"date\": \"2025-02-16\",\n \"market_cap\": \"3674399055800.000000\",\n \"tev\": \"3629830055800.000000\",\n \"shares_outstanding\": 15022073000\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6705c0e2-e92a-4dfd-ba4a-ae6d75c75129", "name": "Indicates that the query is invalid.", "originalRequest": { "url": { "path": [ "api", "v1", "market_cap", ":company_id", ":start_date", ":end_date" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "company_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "end_date", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "start_date", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "9c7a88f6-684b-4ceb-822e-ec73bf437e1f", "name": "Indicates that the authorization information is missing or invalid.", "originalRequest": { "url": { "path": [ "api", "v1", "market_cap", ":company_id", ":start_date", ":end_date" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "company_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "end_date", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "start_date", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e50d2266-3e64-4e04-a0ea-e1bfc3227e6a", "name": "merger info retrieve", "request": { "name": "merger info retrieve", "description": { "content": "Get information about the specified merger/acquisition transaction.\n\nParameters:\n transaction_id: The ID of the specified transaction.\n\nReturns:\n dict: A nested dictionary that contains:\n - An ordered array of the status changes of the transaction.\n - A dict with three keys:\n - target: The company that was merged with or acquired.\n - buyers: A list of companies that bought or merged with the target company.\n - sellers: A list of companies that sold or traded the target company.\n - Optionally the primary consideration (which is the one that happened or was most recently proposed), where the consideration contains:\n - The currency of the consideration.\n - The current gross total value of the consideration.\n - The current implied equity value of the consideration.\n - The current implied enterprise value of the consideration.\n - A list of the consideration's details (sub-components of the consideration), where each consideration detail contains:\n - The detail scenario.\n - The detail subtype.\n - The cash or ash equivalent offered per share.\n - The number of shares in the target company.\n - The current gross total of the consideration detail.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "merger", "info", ":transaction_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "transaction_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "sessionid" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "42218460-fe07-4c60-931a-86a884211e04", "name": "Indicates a successful request.", "originalRequest": { "url": { "path": [ "api", "v1", "merger", "info", ":transaction_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "transaction_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"timeline\": [\n {\n \"status\": \"Announced\",\n \"date\": \"2018-03-06\"\n },\n {\n \"status\": \"Closed\",\n \"date\": \"2018-04-08\"\n }\n ],\n \"participants\": {\n \"target\": {\n \"company_id\": 251994106,\n \"company_name\": \"Kensho Technologies, Inc.\"\n },\n \"buyers\": [\n {\n \"company_id\": 21719,\n \"company_name\": \"S&P Global Inc.\"\n }\n ],\n \"sellers\": [\n {\n \"company_id\": 18561,\n \"company_name\": \"Accel Partners\"\n },\n {\n \"company_id\": 22049,\n \"company_name\": \"New Enterprise Associates, Inc.\"\n }\n ]\n },\n \"consideration\": {\n \"currency_name\": \"US Dollar\",\n \"current_calculated_gross_total_transaction_value\": \"550000000.000000\",\n \"current_calculated_implied_equity_value\": null,\n \"current_calculated_implied_enterprise_value\": null,\n \"details\": [\n {\n \"scenario\": \"Stock Lump Sum\",\n \"subtype\": \"Combination Consideration - Equity Component\",\n \"cash_or_cash_equivalent_per_target_share_unit\": null,\n \"number_of_target_shares_sought\": null,\n \"current_calculated_gross_value_of_consideration\": null\n },\n {\n \"scenario\": \"Cash Lump Sum\",\n \"subtype\": \"Combination Consideration - Cash Component\",\n \"cash_or_cash_equivalent_per_target_share_unit\": null,\n \"number_of_target_shares_sought\": null,\n \"current_calculated_gross_value_of_consideration\": null\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2dc428ba-fa47-4405-b1ae-16e88246c540", "name": "Indicates that the query is invalid.", "originalRequest": { "url": { "path": [ "api", "v1", "merger", "info", ":transaction_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "transaction_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "07c72529-3759-4c8c-b8e8-f2667a0b9c36", "name": "Indicates that the authorization information is missing or invalid.", "originalRequest": { "url": { "path": [ "api", "v1", "merger", "info", ":transaction_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "transaction_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "25933afa-357c-442e-b0b6-40251a655b06", "name": "Indicates that no merger info was found for the given transaction_id.", "originalRequest": { "url": { "path": [ "api", "v1", "merger", "info", ":transaction_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "transaction_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "07cabdcd-1de4-4025-af26-e215fb005b10", "name": "merger info advisors retrieve", "request": { "name": "merger info advisors retrieve", "description": { "content": "Get the advisor companies and their roles for the specified company in the specified merger/acquisition transaction.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "merger", "info", ":transaction_id", "advisors", ":advised_company_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "advised_company_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "transaction_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "sessionid" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "56777bf4-2440-413d-83f6-699cc68cf3ee", "name": "Indicates a successful request.", "originalRequest": { "url": { "path": [ "api", "v1", "merger", "info", ":transaction_id", "advisors", ":advised_company_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "advised_company_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "transaction_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"advisors\": [\n {\n \"advisor_company_id\": 1062800,\n \"advisor_company_name\": \"Goodwin Procter LLP\",\n \"advisor_type_name\": \"Legal Advisor\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d5f0e240-d87a-482b-b992-efcdc431d82a", "name": "Indicates that the authorization information is missing or invalid.", "originalRequest": { "url": { "path": [ "api", "v1", "merger", "info", ":transaction_id", "advisors", ":advised_company_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "advised_company_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "transaction_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "63be07c2-ba24-45db-b914-673227f2eebd", "name": "mergers retrieve", "request": { "name": "mergers retrieve", "description": { "content": "Get the merger/acquisition transactions for the specified company.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "mergers", ":company_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "company_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "sessionid" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "893f249d-1f69-4a77-8e2c-8c246aa7491e", "name": "Indicates a successful request.", "originalRequest": { "url": { "path": [ "api", "v1", "mergers", ":company_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "company_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"target\": [\n {\n \"transaction_id\": 8709303,\n \"merger_title\": \"Closed M/A of S&P Global Inc.\",\n \"closed_date\": \"2006-02-28\"\n },\n {\n \"transaction_id\": 25613276,\n \"merger_title\": \"Closed M/A of S&P Global Inc.\",\n \"closed_date\": \"2007-07-31\"\n }\n ],\n \"buyer\": [\n {\n \"transaction_id\": 307783118,\n \"merger_title\": \"Closed M/A of SNL Financial LC\",\n \"closed_date\": \"2015-09-01\"\n },\n {\n \"transaction_id\": 554979212,\n \"merger_title\": \"Closed M/A of Kensho Technologies, Inc.\",\n \"closed_date\": \"2018-04-08\"\n }\n ],\n \"seller\": [\n {\n \"transaction_id\": 2443407,\n \"merger_title\": \"Effective M/A of McGraw-Hill Companies Inc., Lifetime Learning Assets\",\n \"closed_date\": null\n },\n {\n \"transaction_id\": 4210932,\n \"merger_title\": \"Closed M/A of Interactive Data Real Time Services, Inc.\",\n \"closed_date\": \"2003-02-28\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "501ad09f-38b0-4c02-9e50-45e4cb9c6b01", "name": "Indicates that the authorization information is missing or invalid.", "originalRequest": { "url": { "path": [ "api", "v1", "mergers", ":company_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "company_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "324e724b-2317-4790-8749-147b0edb8f50", "name": "Get Price Chart", "request": { "name": "Get Price Chart", "description": { "content": "Get the candlestick price chart as a PNG image for a given trading item between start_date and end_date inclusive.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "price_chart", ":trading_item_id", ":start_date", ":end_date", ":periodicity", ":adjusted" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "adjusted", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "end_date", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "periodicity", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "start_date", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "trading_item_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "image/png" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "sessionid" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "302e61ee-64a2-44ee-9ed0-16ec542739af", "name": "Returns a PNG image.", "originalRequest": { "url": { "path": [ "api", "v1", "price_chart", ":trading_item_id", ":start_date", ":end_date", ":periodicity", ":adjusted" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "adjusted", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "end_date", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "periodicity", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "start_date", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "trading_item_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" }, { "key": "Accept", "value": "image/png" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "image/png" } ], "body": "string", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b5136c99-eb32-452a-a5cd-bbd27e43f0de", "name": "Indicates that the query is invalid.", "originalRequest": { "url": { "path": [ "api", "v1", "price_chart", ":trading_item_id", ":start_date", ":end_date", ":periodicity", ":adjusted" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "adjusted", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "end_date", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "periodicity", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "start_date", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "trading_item_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b4501334-fa33-4377-9581-e1ae0acd4435", "name": "Indicates that the authorization information is missing or invalid.", "originalRequest": { "url": { "path": [ "api", "v1", "price_chart", ":trading_item_id", ":start_date", ":end_date", ":periodicity", ":adjusted" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "adjusted", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "end_date", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "periodicity", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "start_date", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "trading_item_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f5d41d73-42e2-454a-8487-6c516dd41364", "name": "Indicates that the information was not found.", "originalRequest": { "url": { "path": [ "api", "v1", "price_chart", ":trading_item_id", ":start_date", ":end_date", ":periodicity", ":adjusted" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "adjusted", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "end_date", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "periodicity", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "start_date", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "trading_item_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "49ed6036-201d-4123-9aab-4a4dcb586660", "name": "Get Stock Prices", "request": { "name": "Get Stock Prices", "description": { "content": "Get stock prices for a given trading_item_id and its associated currency between start_date and end_date inclusive, with latest available data being from the previous day, and the most recent price will always be the closing price from the day before. The returned prices include the open, close, high, low prices and volume.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "pricing", ":trading_item_id", ":start_date", ":end_date", ":periodicity", ":adjusted" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "adjusted", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "end_date", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "periodicity", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "start_date", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "trading_item_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "sessionid" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "943dbccd-8d1c-4f27-9770-fb8addd7ffbe", "name": "Indicates a successful request.", "originalRequest": { "url": { "path": [ "api", "v1", "pricing", ":trading_item_id", ":start_date", ":end_date", ":periodicity", ":adjusted" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "adjusted", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "end_date", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "periodicity", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "start_date", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "trading_item_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"currency\": \"USD\",\n \"prices\": [\n {\n \"date\": \"2021-01-04T00:00:00.000\",\n \"open\": \"133.520000\",\n \"high\": \"133.611600\",\n \"low\": \"126.760000\",\n \"close\": \"129.410000\",\n \"volume\": \"143301900\"\n },\n {\n \"date\": \"2021-01-05T00:00:00.000\",\n \"open\": \"128.890000\",\n \"high\": \"131.740000\",\n \"low\": \"128.430000\",\n \"close\": \"131.010000\",\n \"volume\": \"97664900\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e9fb79f0-670d-4c8b-ad19-f256d77f8a74", "name": "Indicates that the query is invalid.", "originalRequest": { "url": { "path": [ "api", "v1", "pricing", ":trading_item_id", ":start_date", ":end_date", ":periodicity", ":adjusted" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "adjusted", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "end_date", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "periodicity", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "start_date", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "trading_item_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "4c6f0ff0-be78-4d6d-9932-a3bf19ffbda3", "name": "Indicates that the authorization information is missing or invalid.", "originalRequest": { "url": { "path": [ "api", "v1", "pricing", ":trading_item_id", ":start_date", ":end_date", ":periodicity", ":adjusted" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "adjusted", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "end_date", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "periodicity", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "start_date", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "trading_item_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a3ad95dc-792e-41ef-9452-bb24b9353720", "name": "Get Historical Metadata", "request": { "name": "Get Historical Metadata", "description": { "content": "Get the historical metadata of the trading item id, such as currency, symbol, exchange_name, instrument_type, and first_trade_date.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "pricing", ":trading_item_id", "metadata" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "trading_item_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "sessionid" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "a1d516d1-a33c-4222-bf0e-7aa0401afebd", "name": "Indicates a successful request.", "originalRequest": { "url": { "path": [ "api", "v1", "pricing", ":trading_item_id", "metadata" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "trading_item_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"currency\": \"USD\",\n \"symbol\": \"AAPL\",\n \"exchange_name\": \"NasdaqGS\",\n \"instrument_type\": \"Equity\",\n \"first_trade_date\": \"1980-12-12\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "56160007-e771-402b-8981-e14131a9e95d", "name": "Indicates that the query is invalid.", "originalRequest": { "url": { "path": [ "api", "v1", "pricing", ":trading_item_id", "metadata" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "trading_item_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "912ca64f-9209-4f93-a6ff-3af27e8526e1", "name": "Indicates that the authorization information is missing or invalid.", "originalRequest": { "url": { "path": [ "api", "v1", "pricing", ":trading_item_id", "metadata" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "trading_item_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ff2057e5-2d85-44c2-b958-9c7d17faeaf7", "name": "Indicates that history metadata was not found for the given trading_item_id.", "originalRequest": { "url": { "path": [ "api", "v1", "pricing", ":trading_item_id", "metadata" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "trading_item_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8b0c7666-e768-4c29-b97b-a258be83cdc5", "name": "Get Companies by Business Relationships", "request": { "name": "Get Companies by Business Relationships", "description": { "content": "Get the list of current and previous companies that are relationship_type OF company_id.\n\nReturns a dictionary of shape:\n{\n \"current\": List[{\"company_id\": , \"company_name\": }],\n \"previous\": List[{\"company_id\": , \"company_name\": }]\n}.\n\nExamples: get_companies_by_business_relationship(company_id: 1234, relationship_type: landlord) returns company 1234's landlords,\nand get_companies_by_business_relationship(company_id: 1234, relationship_type: tenant) returns company 1234's tenants.\nget_companies_by_business_relationship(company_id: 1234, relationship_type: supplier) returns company 1234's suppliers,\nand get_companies_by_business_relationship(company_id: 1234, relationship_type: distributor) returns company 1234's distributors.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "relationship", ":company_id", ":relationship_type" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "company_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "relationship_type", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "sessionid" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "b78f5f16-e082-461a-a488-140eb141e479", "name": "Indicates a successful request.", "originalRequest": { "url": { "path": [ "api", "v1", "relationship", ":company_id", ":relationship_type" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "company_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "relationship_type", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"current\": [\n {\n \"company_id\": 286180590,\n \"company_name\": \"Barnes & Noble Education, Inc.\"\n }\n ],\n \"previous\": []\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a14dee31-7b3c-4335-83e1-46d8c6439fe1", "name": "Indicates that the query is invalid.", "originalRequest": { "url": { "path": [ "api", "v1", "relationship", ":company_id", ":relationship_type" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "company_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "relationship_type", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "72d25591-b7d9-4448-a1e5-295043808342", "name": "Indicates that the authorization information is missing or invalid.", "originalRequest": { "url": { "path": [ "api", "v1", "relationship", ":company_id", ":relationship_type" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "company_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "relationship_type", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4473416d-679a-45c4-91c1-92096cb2174c", "name": "Get Tickers by Business Relationships", "request": { "name": "Get Tickers by Business Relationships", "description": { "content": "Get the list of current and previous ticker identification triples that are relationship_type OF company_id.\n\nReturns a dictionary of shape {“current”: List[{“company_id”: , “security_id”: , “trading_item_id”: }], “previous”: List[{“company_id”: , “security_id”: , “trading_item_id”: }]}.\n\nExamples: get_tickers_by_business_relationship(company_id: 1234, relationship_type: landlord) returns company 1234's landlords,\nand get_tickers_by_business_relationship(company_id: 1234, relationship_type: tenant) returns company 1234's tenants.\nget_tickers_by_business_relationship(company_id: 1234, relationship_type: supplier) returns company 1234's suppliers,\nand get_tickers_by_business_relationship(company_id: 1234, relationship_type: distributor) returns company 1234's distributors.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "relationship", ":company_id", ":relationship_type", "ticker" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "company_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "relationship_type", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "sessionid" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "5724110e-00ba-46d1-902d-4c3d10f8d14f", "name": "Indicates a successful request.", "originalRequest": { "url": { "path": [ "api", "v1", "relationship", ":company_id", ":relationship_type", "ticker" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "company_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "relationship_type", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"current\": [\n {\n \"company_id\": 883103,\n \"security_id\": 20027635,\n \"trading_item_id\": 46355579\n }\n ],\n \"previous\": []\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "72f562ee-4906-43ac-9eed-5e39f628ea09", "name": "Indicates that the query is invalid.", "originalRequest": { "url": { "path": [ "api", "v1", "relationship", ":company_id", ":relationship_type", "ticker" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "company_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "relationship_type", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ca8b65cb-300a-48a6-a885-c51a47851fcc", "name": "Indicates that the authorization information is missing or invalid.", "originalRequest": { "url": { "path": [ "api", "v1", "relationship", ":company_id", ":relationship_type", "ticker" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "company_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "relationship_type", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5b78493c-2be9-43c1-ab8b-93f777558a7f", "name": "Get Securities", "request": { "name": "Get Securities", "description": { "content": "Get the list of securities for a given company_id. Returns a dictionary of shape {\"securities\": List[]}", "type": "text/plain" }, "url": { "path": [ "api", "v1", "securities", ":company_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "company_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "sessionid" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "7d19219d-5462-4def-8385-1f2fab317404", "name": "Indicates a successful request.", "originalRequest": { "url": { "path": [ "api", "v1", "securities", ":company_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "company_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"securities\": [\n 309323987,\n 309323988,\n 309328521,\n 309328522,\n 1763982503,\n 1773481318,\n 171381676\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "efe69045-cf0f-4235-bb3f-d5fe4d402839", "name": "Indicates that the query is invalid.", "originalRequest": { "url": { "path": [ "api", "v1", "securities", ":company_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "company_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "192db20d-2666-45e0-91a2-0da219411c04", "name": "Indicates that the authorization information is missing or invalid.", "originalRequest": { "url": { "path": [ "api", "v1", "securities", ":company_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "company_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "028d4726-043a-4956-9342-94b8aa6c2da3", "name": "Indicates that no securities were found for the given company_id.", "originalRequest": { "url": { "path": [ "api", "v1", "securities", ":company_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "company_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "767fbe1f-afcd-4095-8524-7dc3c8aea7c0", "name": "Get Primary Security", "request": { "name": "Get Primary Security", "description": { "content": "Get the primary security for a given company_id. Returns a dictionary of shape {\"primary_security\": }", "type": "text/plain" }, "url": { "path": [ "api", "v1", "securities", ":company_id", "primary" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "company_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "sessionid" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "6766c301-66f2-47a6-a4f6-db37d33cb813", "name": "Indicates a successful request.", "originalRequest": { "url": { "path": [ "api", "v1", "securities", ":company_id", "primary" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "company_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"primary_security\": 2629107\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f775943b-4a7f-4444-9d0c-523fb1cc50d7", "name": "Indicates that the query is invalid.", "originalRequest": { "url": { "path": [ "api", "v1", "securities", ":company_id", "primary" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "company_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "1eec14d3-b192-451d-aa0d-3c4231653353", "name": "Indicates that the authorization information is missing or invalid.", "originalRequest": { "url": { "path": [ "api", "v1", "securities", ":company_id", "primary" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "company_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "4cb61a2f-3080-49dc-a9cd-aadb963f8a3f", "name": "Indicates that no primary security was found for the given company_id.", "originalRequest": { "url": { "path": [ "api", "v1", "securities", ":company_id", "primary" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "company_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "58e70c77-fa9d-4932-90ea-601523407919", "name": "Get Segments", "request": { "name": "Get Segments", "description": { "content": "Get the templated segments of a given company_id for a given start_year, start_quarter, end_year and end_quarter.\n\nSegments can be filtered on the segment_type for 'business' for Line of Business Segments or 'geographic' for Geographic Segments.\n\nParameters:\ncompany_id (int, required): The company_id requested\nsegment_type (SegmentType): The segment type to filter on, either “business” or “geographic”. Defaults to “business”.\nperiod_type (PeriodType): The period_type requested for. Can be “annual”, “quarterly”, \"ytd\". Defaults to “annual” when start_quarter and end_quarter are None.\nstart_year (int): The starting year\nstart_quarter (int): The starting quarter\nend_year (int): The ending year\nend_quarter (int): The ending quarter\ncalendar_type (CalendarType): The type of calendar lookup to use, either \"fiscal\" or \"calendar\". Defaults to \"fiscal\".\nnum_periods (int): Instead of using absolute time lookup, you can look up segments by time relative to now. Defaults to 5 if no other time parameters are present.\nnum_periods_back (int): Instead of using absolute time lookup, you can look up segments by time relative to now. Defaults to 0.\n\nReturns:\n dict: A nested dictionary where the first-level keys are \"results\" and \"errors\".\n Within \"results\", there is one key per company ID, with a metadata value \"currency\" under that, and \"periods\"\n Within the \"periods\" dictionary,\n - The first-level keys are strings representing the time period of either calendar years or quarters (e.g., 'FY2024' for a fiscal year, or 'FY2024Q1', 'FY2024Q2' for fiscal quarters).\n - Each period contains 'period_end_date', 'num_months', and a 'segments' array.\n - Each segment in the array has a 'name' (either line of business segment names specific to a company's organization or geographic segment like 'Asia', 'United States', 'Rest of World') and 'line_items' array.\n - Each line item in the array contains 'name' (e.g., 'Revenue', 'Operating Income') and 'value' fields.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "segments", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "sessionid" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "key": "company_ids", "value": "", "description": "(Required) " }, { "disabled": false, "key": "segment_type", "value": "" }, { "disabled": false, "key": "period_type", "value": "" }, { "disabled": false, "key": "start_year", "value": "" }, { "disabled": false, "key": "end_year", "value": "" }, { "disabled": false, "key": "start_quarter", "value": "" }, { "disabled": false, "key": "end_quarter", "value": "" }, { "disabled": false, "key": "calendar_type", "value": "" }, { "disabled": false, "key": "num_periods", "value": "" }, { "disabled": false, "key": "num_periods_back", "value": "" } ] } }, "response": [ { "id": "55018b44-1399-44cc-bde5-c3f27f6c92d6", "name": "Indicates a successful request.", "originalRequest": { "url": { "path": [ "api", "v1", "segments", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "company_ids", "value": "" }, { "disabled": false, "key": "segment_type", "value": "" }, { "disabled": false, "key": "period_type", "value": "" }, { "disabled": false, "key": "start_year", "value": "" }, { "disabled": false, "key": "end_year", "value": "" }, { "disabled": false, "key": "start_quarter", "value": "" }, { "disabled": false, "key": "end_quarter", "value": "" }, { "disabled": false, "key": "calendar_type", "value": "" }, { "disabled": false, "key": "num_periods", "value": "" }, { "disabled": false, "key": "num_periods_back", "value": "" } ] } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"results\": {\n \"21719\": {\n \"currency\": \"USD\",\n \"periods\": {\n \"CY2024Q1\": {\n \"period_end_date\": \"2024-03-31\",\n \"num_months\": 3,\n \"segments\": [\n {\n \"name\": \"Commodity Insights\",\n \"line_items\": [\n {\n \"name\": \"Operating Income\",\n \"value\": 263000000\n },\n {\n \"name\": \"Revenue\",\n \"value\": 559000000\n }\n ]\n },\n {\n \"name\": \"Corporate\",\n \"line_items\": [\n {\n \"name\": \"Operating Income\",\n \"value\": -35000000\n }\n ]\n },\n {\n \"name\": \"Indices\",\n \"line_items\": [\n {\n \"name\": \"Operating Income\",\n \"value\": 283000000\n },\n {\n \"name\": \"Revenue\",\n \"value\": 387000000\n }\n ]\n },\n {\n \"name\": \"Intersegment Elimination\",\n \"line_items\": [\n {\n \"name\": \"Revenue\",\n \"value\": -45000000\n }\n ]\n },\n {\n \"name\": \"Market Intelligence\",\n \"line_items\": [\n {\n \"name\": \"Operating Income\",\n \"value\": 374000000\n },\n {\n \"name\": \"Revenue\",\n \"value\": 1142000000\n }\n ]\n },\n {\n \"name\": \"Mobility\",\n \"line_items\": [\n {\n \"name\": \"Operating Income\",\n \"value\": 147000000\n },\n {\n \"name\": \"Revenue\",\n \"value\": 386000000\n }\n ]\n },\n {\n \"name\": \"Ratings\",\n \"line_items\": [\n {\n \"name\": \"Operating Income\",\n \"value\": 688000000\n },\n {\n \"name\": \"Revenue\",\n \"value\": 1062000000\n }\n ]\n }\n ]\n },\n \"CY2024Q2\": {\n \"period_end_date\": \"2024-06-30\",\n \"num_months\": 3,\n \"segments\": [\n {\n \"name\": \"Commodity Insights\",\n \"line_items\": [\n {\n \"name\": \"Operating Income\",\n \"value\": 245000000\n },\n {\n \"name\": \"Revenue\",\n \"value\": 516000000\n }\n ]\n },\n {\n \"name\": \"Corporate\",\n \"line_items\": [\n {\n \"name\": \"Operating Income\",\n \"value\": -38000000\n }\n ]\n },\n {\n \"name\": \"Indices\",\n \"line_items\": [\n {\n \"name\": \"Operating Income\",\n \"value\": 275000000\n },\n {\n \"name\": \"Revenue\",\n \"value\": 389000000\n }\n ]\n },\n {\n \"name\": \"Intersegment Elimination\",\n \"line_items\": [\n {\n \"name\": \"Revenue\",\n \"value\": -46000000\n }\n ]\n },\n {\n \"name\": \"Market Intelligence\",\n \"line_items\": [\n {\n \"name\": \"Operating Income\",\n \"value\": 379000000\n },\n {\n \"name\": \"Revenue\",\n \"value\": 1155000000\n }\n ]\n },\n {\n \"name\": \"Mobility\",\n \"line_items\": [\n {\n \"name\": \"Operating Income\",\n \"value\": 164000000\n },\n {\n \"name\": \"Revenue\",\n \"value\": 400000000\n }\n ]\n },\n {\n \"name\": \"Ratings\",\n \"line_items\": [\n {\n \"name\": \"Operating Income\",\n \"value\": 747000000\n },\n {\n \"name\": \"Revenue\",\n \"value\": 1135000000\n }\n ]\n }\n ]\n }\n }\n }\n },\n \"errors\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "502a9e41-2123-45fe-99e2-78627158778f", "name": "Indicates that the input parameters are invalid.", "originalRequest": { "url": { "path": [ "api", "v1", "segments", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "company_ids", "value": "" }, { "disabled": false, "key": "segment_type", "value": "" }, { "disabled": false, "key": "period_type", "value": "" }, { "disabled": false, "key": "start_year", "value": "" }, { "disabled": false, "key": "end_year", "value": "" }, { "disabled": false, "key": "start_quarter", "value": "" }, { "disabled": false, "key": "end_quarter", "value": "" }, { "disabled": false, "key": "calendar_type", "value": "" }, { "disabled": false, "key": "num_periods", "value": "" }, { "disabled": false, "key": "num_periods_back", "value": "" } ] } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "9a0677cb-58df-48a9-b098-022db6c10adb", "name": "Indicates that the authorization information is missing or invalid.", "originalRequest": { "url": { "path": [ "api", "v1", "segments", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "company_ids", "value": "" }, { "disabled": false, "key": "segment_type", "value": "" }, { "disabled": false, "key": "period_type", "value": "" }, { "disabled": false, "key": "start_year", "value": "" }, { "disabled": false, "key": "end_year", "value": "" }, { "disabled": false, "key": "start_quarter", "value": "" }, { "disabled": false, "key": "end_quarter", "value": "" }, { "disabled": false, "key": "calendar_type", "value": "" }, { "disabled": false, "key": "num_periods", "value": "" }, { "disabled": false, "key": "num_periods_back", "value": "" } ] } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "fefbbb06-6f27-4b5a-aeaa-48cb0505448d", "name": "Get Segments 2", "request": { "name": "Get Segments 2", "description": { "content": "Get the templated segments of a given company_id for a given start_year, start_quarter, end_year and end_quarter.\n\nSegments can be filtered on the segment_type for 'business' for Line of Business Segments or 'geographic' for Geographic Segments.\n\nParameters:\ncompany_id (int, required): The company_id requested\nsegment_type (SegmentType): The segment type to filter on, either “business” or “geographic”. Defaults to “business”.\nperiod_type (PeriodType): The period_type requested for. Can be “annual”, “quarterly”, \"ytd\". Defaults to “annual” when start_quarter and end_quarter are None.\nstart_year (int): The starting calendar year\nstart_quarter (int): The starting calendar quarter\nend_year (int): The ending calendar year\nend_quarter (int): The ending calendar quarter\n\nReturns:\n dict: A nested dictionary where the first-level keys are \"calendar_type\" and \"segments\".\n Within the \"segments\" dictionary,\n - The first-level keys are strings representing the time period of either calendar years or quarters (e.g., '2024' for a year, or '2024Q1', '2024Q2' for quarters).\n - The second-level keys are the segment names, either line of business segment names specific to a company's organization or geographic segment (e.g., 'Asia', 'United States', 'Rest of World').\n - Each segment contains the value of the line item (e.g., 'Revenue', 'Operating Income')\n\n An example response:\n {\n \"calendar_type\": \"CALENDAR\",\n \"currency\": \"USD\",\n \"segments\": {\n \"2024Q1\": {\n \"Commodity Insights\": {\n \"Operating Income\": 263000000.0,\n \"Revenue\": 559000000.0\n },\n \"Corporate\": {\n \"Operating Income\": -35000000.0\n },\n },\n \"2024Q2\": {\n \"Commodity Insights\": {\n \"Operating Income\": 245000000.0,\n \"Revenue\": 516000000.0\n },\n \"Corporate\": {\n \"Operating Income\": -38000000.0\n },\n }\n }...", "type": "text/plain" }, "url": { "path": [ "api", "v1", "segments", ":company_id", ":segment_type", ":period_type", ":start_year", ":end_year", ":start_quarter", ":end_quarter" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "company_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "end_quarter", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "end_year", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "period_type", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "segment_type", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "start_quarter", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "start_year", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "sessionid" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "10a39bc9-75fc-448d-a803-f052c7122b50", "name": "Indicates a successful request.", "originalRequest": { "url": { "path": [ "api", "v1", "segments", ":company_id", ":segment_type", ":period_type", ":start_year", ":end_year", ":start_quarter", ":end_quarter" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "company_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "end_quarter", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "end_year", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "period_type", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "segment_type", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "start_quarter", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "start_year", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"calendar_type\": \"CALENDAR\",\n \"currency\": \"USD\",\n \"segments\": {\n \"2024Q1\": {\n \"Commodity Insights\": {\n \"Operating Income\": 263000000,\n \"Revenue\": 559000000\n },\n \"Corporate\": {\n \"Operating Income\": -35000000\n },\n \"Indices\": {\n \"Operating Income\": 283000000,\n \"Revenue\": 387000000\n },\n \"Intersegment Elimination\": {\n \"Revenue\": -45000000\n },\n \"Market Intelligence\": {\n \"Operating Income\": 374000000,\n \"Revenue\": 1142000000\n },\n \"Mobility\": {\n \"Operating Income\": 147000000,\n \"Revenue\": 386000000\n },\n \"Ratings\": {\n \"Operating Income\": 688000000,\n \"Revenue\": 1062000000\n }\n },\n \"2024Q2\": {\n \"Commodity Insights\": {\n \"Operating Income\": 245000000,\n \"Revenue\": 516000000\n },\n \"Corporate\": {\n \"Operating Income\": -38000000\n }\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3977de18-fdac-4480-bb51-33c06523f7ab", "name": "Indicates that the input parameters are invalid.", "originalRequest": { "url": { "path": [ "api", "v1", "segments", ":company_id", ":segment_type", ":period_type", ":start_year", ":end_year", ":start_quarter", ":end_quarter" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "company_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "end_quarter", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "end_year", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "period_type", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "segment_type", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "start_quarter", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "start_year", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "3f520982-5dc7-4a27-9f9a-3dd5f51ecaa6", "name": "Indicates that the authorization information is missing or invalid.", "originalRequest": { "url": { "path": [ "api", "v1", "segments", ":company_id", ":segment_type", ":period_type", ":start_year", ":end_year", ":start_quarter", ":end_quarter" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "company_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "end_quarter", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "end_year", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "period_type", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "segment_type", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "start_quarter", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "start_year", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3759bb04-2e1a-4cac-97d0-c8edfade4775", "name": "Get Financial Statement", "request": { "name": "Get Financial Statement", "description": { "content": "Get a financial statement, such as a balance sheet, income statement, or cashflow statement for a given company_id.\n\nFor a public company, the annual period_type returns annual calendar year values. For a private company, the annual period_type returns annual fiscal year values.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "statements", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "sessionid" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "key": "company_ids", "value": "", "description": "(Required) " }, { "disabled": false, "key": "statement_type", "value": "", "description": "(Required) " }, { "disabled": false, "key": "period_type", "value": "" }, { "disabled": false, "key": "start_year", "value": "" }, { "disabled": false, "key": "end_year", "value": "" }, { "disabled": false, "key": "start_quarter", "value": "" }, { "disabled": false, "key": "end_quarter", "value": "" }, { "disabled": false, "key": "calendar_type", "value": "" }, { "disabled": false, "key": "num_periods", "value": "" }, { "disabled": false, "key": "num_periods_back", "value": "" } ] } }, "response": [ { "id": "e0291032-3465-427b-991c-5c1264ccd24c", "name": "Indicates a successful request.", "originalRequest": { "url": { "path": [ "api", "v1", "statements", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "company_ids", "value": "" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "statement_type", "value": "" }, { "disabled": false, "key": "period_type", "value": "" }, { "disabled": false, "key": "start_year", "value": "" }, { "disabled": false, "key": "end_year", "value": "" }, { "disabled": false, "key": "start_quarter", "value": "" }, { "disabled": false, "key": "end_quarter", "value": "" }, { "disabled": false, "key": "calendar_type", "value": "" }, { "disabled": false, "key": "num_periods", "value": "" }, { "disabled": false, "key": "num_periods_back", "value": "" } ] } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"results\": {\n \"24937\": {\n \"currency\": \"USD\",\n \"periods\": {\n \"FY2023\": {\n \"period_end_date\": \"2023-09-30\",\n \"num_months\": 12,\n \"statements\": [\n {\n \"name\": \"Income Statement\",\n \"line_items\": [\n {\n \"name\": \"Revenues\",\n \"value\": \"383285000000.000000\"\n },\n {\n \"name\": \"Total Revenues\",\n \"value\": \"383285000000.000000\"\n },\n {\n \"name\": \"Cost Of Revenues\",\n \"value\": \"214137000000.000000\"\n },\n {\n \"name\": \"Cost of Goods Sold, Total\",\n \"value\": \"214137000000.000000\"\n },\n {\n \"name\": \"Gross Profit\",\n \"value\": \"169148000000.000000\"\n },\n {\n \"name\": \"Selling General & Admin Expenses (Summary Subtotal)\",\n \"value\": \"24932000000.000000\"\n },\n {\n \"name\": \"Selling General & Admin Expenses, Total\",\n \"value\": \"24932000000.000000\"\n },\n {\n \"name\": \"R&D Expenses\",\n \"value\": \"29915000000.000000\"\n },\n {\n \"name\": \"Other Operating Expenses, Total\",\n \"value\": \"54847000000.000000\"\n },\n {\n \"name\": \"Operating Income\",\n \"value\": \"114301000000.000000\"\n },\n {\n \"name\": \"Other Non Operating Expenses, Total\",\n \"value\": \"-565000000.000000\"\n },\n {\n \"name\": \"Other Non Operating Income (Expenses)\",\n \"value\": \"-565000000.000000\"\n },\n {\n \"name\": \"EBT, Excl. Unusual Items\",\n \"value\": \"113736000000.000000\"\n },\n {\n \"name\": \"EBT, Incl. Unusual Items\",\n \"value\": \"113736000000.000000\"\n },\n {\n \"name\": \"Income Tax Expense\",\n \"value\": \"16741000000.000000\"\n },\n {\n \"name\": \"Earnings From Continuing Operations\",\n \"value\": \"96995000000.000000\"\n },\n {\n \"name\": \"Net Income to Company\",\n \"value\": \"96995000000.000000\"\n },\n {\n \"name\": \"Net Income - (IS)\",\n \"value\": \"96995000000.000000\"\n },\n {\n \"name\": \"Net Income to Common Incl Extra Items\",\n \"value\": \"96995000000.000000\"\n },\n {\n \"name\": \"Net Income to Common Excl. Extra Items\",\n \"value\": \"96995000000.000000\"\n }\n ]\n }\n ]\n }\n }\n },\n \"1861276\": {\n \"currency\": \"SEK\",\n \"periods\": {\n \"PED2023-08-31\": {\n \"period_end_date\": \"2023-08-31\",\n \"num_months\": 12,\n \"statements\": [\n {\n \"name\": \"Income Statement\",\n \"line_items\": [\n {\n \"name\": \"Revenues\",\n \"value\": \"34550436000.000000\"\n },\n {\n \"name\": \"Other Revenues, Total\",\n \"value\": \"118932000.000000\"\n },\n {\n \"name\": \"Total Revenues\",\n \"value\": \"34669368000.000000\"\n },\n {\n \"name\": \"Cost of Goods Sold, Total\",\n \"value\": \"11526445000.000000\"\n },\n {\n \"name\": \"Gross Profit\",\n \"value\": \"23142923000.000000\"\n },\n {\n \"name\": \"Selling General & Admin Expenses, Total\",\n \"value\": \"7228026000.000000\"\n },\n {\n \"name\": \"Depreciation & Amortization - (IS)\",\n \"value\": \"976888000.000000\"\n },\n {\n \"name\": \"Other Operating Expenses\",\n \"value\": \"14427229000.000000\"\n },\n {\n \"name\": \"Other Operating Expenses, Total\",\n \"value\": \"22632143000.000000\"\n },\n {\n \"name\": \"Operating Income\",\n \"value\": \"510780000.000000\"\n },\n {\n \"name\": \"Interest Expense, Total\",\n \"value\": \"-200817000.000000\"\n },\n {\n \"name\": \"Interest And Investment Income\",\n \"value\": \"1475000.000000\"\n },\n {\n \"name\": \"Net Interest Expenses\",\n \"value\": \"-199342000.000000\"\n },\n {\n \"name\": \"Other Non Operating Expenses, Total\",\n \"value\": \"69466000.000000\"\n },\n {\n \"name\": \"Income (Loss) On Equity Invest.\",\n \"value\": \"83747000.000000\"\n },\n {\n \"name\": \"Other Non Operating Income (Expenses)\",\n \"value\": \"-14281000.000000\"\n },\n {\n \"name\": \"EBT, Excl. Unusual Items\",\n \"value\": \"380904000.000000\"\n },\n {\n \"name\": \"EBT, Incl. Unusual Items\",\n \"value\": \"380904000.000000\"\n },\n {\n \"name\": \"Income Tax Expense\",\n \"value\": \"94020000.000000\"\n },\n {\n \"name\": \"Earnings From Continuing Operations\",\n \"value\": \"286884000.000000\"\n },\n {\n \"name\": \"Extraordinary Item & Accounting Change\",\n \"value\": \"-31544000.000000\"\n },\n {\n \"name\": \"Net Income to Company\",\n \"value\": \"255340000.000000\"\n },\n {\n \"name\": \"Net Income - (IS)\",\n \"value\": \"255340000.000000\"\n }\n ]\n }\n ]\n }\n }\n }\n },\n \"errors\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "153f8476-2d4f-467e-8e34-cfeb2a5c584e", "name": "Indicates that the input parameters are invalid.", "originalRequest": { "url": { "path": [ "api", "v1", "statements", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "company_ids", "value": "" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "statement_type", "value": "" }, { "disabled": false, "key": "period_type", "value": "" }, { "disabled": false, "key": "start_year", "value": "" }, { "disabled": false, "key": "end_year", "value": "" }, { "disabled": false, "key": "start_quarter", "value": "" }, { "disabled": false, "key": "end_quarter", "value": "" }, { "disabled": false, "key": "calendar_type", "value": "" }, { "disabled": false, "key": "num_periods", "value": "" }, { "disabled": false, "key": "num_periods_back", "value": "" } ] } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "00ec48af-cd87-461c-a376-ac8d34817d5b", "name": "Indicates that the authorization information is missing or invalid.", "originalRequest": { "url": { "path": [ "api", "v1", "statements", "" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "company_ids", "value": "" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "statement_type", "value": "" }, { "disabled": false, "key": "period_type", "value": "" }, { "disabled": false, "key": "start_year", "value": "" }, { "disabled": false, "key": "end_year", "value": "" }, { "disabled": false, "key": "start_quarter", "value": "" }, { "disabled": false, "key": "end_quarter", "value": "" }, { "disabled": false, "key": "calendar_type", "value": "" }, { "disabled": false, "key": "num_periods", "value": "" }, { "disabled": false, "key": "num_periods_back", "value": "" } ] } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d09ea5c5-9cad-4c6a-83f7-ce763ffd2df7", "name": "Get Financial Statement 2", "request": { "name": "Get Financial Statement 2", "description": { "content": "Get a financial statement, such as a balance sheet, income statement, or cashflow statement for a given company_id.\n\nFor a public company, the annual period_type returns annual calendar year values. For a private company, the annual period_type returns annual fiscal year values.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "statements", ":company_id", ":statement_type", ":period_type", ":start_year", ":end_year", ":start_quarter", ":end_quarter" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "company_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "end_quarter", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "end_year", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "period_type", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "start_quarter", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "start_year", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "statement_type", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "sessionid" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "d41acd26-6cd7-4b3f-87da-da1598884c22", "name": "Indicates a successful request.", "originalRequest": { "url": { "path": [ "api", "v1", "statements", ":company_id", ":statement_type", ":period_type", ":start_year", ":end_year", ":start_quarter", ":end_quarter" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "company_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "end_quarter", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "end_year", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "period_type", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "start_quarter", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "start_year", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "statement_type", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"calendar_type\": \"CALENDAR\",\n \"currency\": \"USD\",\n \"statements\": {\n \"2023\": {\n \"Revenues\": \"383285000000.000000\",\n \"Total Revenues\": \"383285000000.000000\",\n \"Cost Of Revenues\": \"214137000000.000000\",\n \"Cost of Goods Sold, Total\": \"214137000000.000000\",\n \"Gross Profit\": \"169148000000.000000\",\n \"Selling General & Admin Expenses (Summary Subtotal)\": \"24932000000.000000\",\n \"Selling General & Admin Expenses, Total\": \"24932000000.000000\",\n \"R&D Expenses\": \"29915000000.000000\",\n \"Other Operating Expenses, Total\": \"54847000000.000000\",\n \"Operating Income\": \"114301000000.000000\",\n \"Interest Expense, Total\": \"-3933000000.000000\",\n \"Interest And Investment Income\": \"3750000000.000000\",\n \"Net Interest Expenses\": \"-183000000.000000\",\n \"Other Non Operating Expenses, Total\": \"-382000000.000000\",\n \"Other Non Operating Income (Expenses)\": \"-382000000.000000\",\n \"EBT, Excl. Unusual Items\": \"113736000000.000000\",\n \"EBT, Incl. Unusual Items\": \"113736000000.000000\",\n \"Income Tax Expense\": \"16741000000.000000\",\n \"Earnings From Continuing Operations\": \"96995000000.000000\",\n \"Net Income to Company\": \"96995000000.000000\",\n \"Net Income - (IS)\": \"96995000000.000000\",\n \"Net Income to Common Incl Extra Items\": \"96995000000.000000\",\n \"Net Income to Common Excl. Extra Items\": \"96995000000.000000\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8d6999e2-05e8-40ce-a005-c2826d494c96", "name": "Indicates that the input parameters are invalid.", "originalRequest": { "url": { "path": [ "api", "v1", "statements", ":company_id", ":statement_type", ":period_type", ":start_year", ":end_year", ":start_quarter", ":end_quarter" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "company_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "end_quarter", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "end_year", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "period_type", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "start_quarter", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "start_year", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "statement_type", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a5945e0a-7ea5-41d6-9b39-db470a474660", "name": "Indicates that the authorization information is missing or invalid.", "originalRequest": { "url": { "path": [ "api", "v1", "statements", ":company_id", ":statement_type", ":period_type", ":start_year", ":end_year", ":start_quarter", ":end_quarter" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "company_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "end_quarter", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "end_year", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "period_type", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "start_quarter", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "start_year", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "statement_type", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "55a6f7fe-1bb5-4684-a152-d8e4879367da", "name": "Get Tickers By Exchange Code", "request": { "name": "Get Tickers By Exchange Code", "description": { "content": "Get the list of tickers that are traded on exchange_code", "type": "text/plain" }, "url": { "path": [ "api", "v1", "ticker_groups", "exchange", ":exchange_code" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "exchange_code", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "sessionid" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "cdd150bc-d04a-427f-8bc1-64fb13e83506", "name": "Indicates a successful request.", "originalRequest": { "url": { "path": [ "api", "v1", "ticker_groups", "exchange", ":exchange_code" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "exchange_code", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"tickers\": [\n {\n \"trading_item_id\": 132508034,\n \"security_id\": 132508033,\n \"company_id\": 114823784\n },\n {\n \"trading_item_id\": 2662349,\n \"security_id\": 10437084,\n \"company_id\": 177500\n },\n {\n \"trading_item_id\": 1883856126,\n \"security_id\": 1883856125,\n \"company_id\": 1883415892\n },\n {\n \"trading_item_id\": 574416192,\n \"security_id\": 571650016,\n \"company_id\": 280899653\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3882257a-c91d-4b34-8584-ea87caf29f9e", "name": "Indicates that the query is invalid.", "originalRequest": { "url": { "path": [ "api", "v1", "ticker_groups", "exchange", ":exchange_code" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "exchange_code", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "6881b9fd-3dfc-484e-9b2e-cf3e2caaae1b", "name": "Indicates that the authorization information is missing or invalid.", "originalRequest": { "url": { "path": [ "api", "v1", "ticker_groups", "exchange", ":exchange_code" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "exchange_code", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "14c2f8bf-edfa-41da-b147-5db479a7dbc4", "name": "Get Tickers By Combined Filters", "request": { "name": "Get Tickers By Combined Filters", "description": { "content": "Get the list of tickers that are traded on the provided filters: iso_code, state, exchange_code, and simple_industry.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "ticker_groups", "filters", "geo", ":iso_code", ":state", "simple", ":simple_industry", "exchange", ":exchange_code" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "exchange_code", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "iso_code", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "simple_industry", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "state", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "sessionid" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "f80ccb67-b02e-4414-a480-a962cd39ac8a", "name": "Indicates a successful request.", "originalRequest": { "url": { "path": [ "api", "v1", "ticker_groups", "filters", "geo", ":iso_code", ":state", "simple", ":simple_industry", "exchange", ":exchange_code" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "exchange_code", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "iso_code", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "simple_industry", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "state", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"tickers\": [\n {\n \"trading_item_id\": 262048466,\n \"security_id\": 261095527,\n \"company_id\": 23245928\n },\n {\n \"trading_item_id\": 145857123,\n \"security_id\": 145857122,\n \"company_id\": 2829085\n },\n {\n \"trading_item_id\": 713517283,\n \"security_id\": 707518924,\n \"company_id\": 697299161\n },\n {\n \"trading_item_id\": 260217790,\n \"security_id\": 257175623,\n \"company_id\": 24734352\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6c394d2c-7dc7-41be-b7e3-435ed1efaa50", "name": "Indicates that the query is invalid.", "originalRequest": { "url": { "path": [ "api", "v1", "ticker_groups", "filters", "geo", ":iso_code", ":state", "simple", ":simple_industry", "exchange", ":exchange_code" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "exchange_code", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "iso_code", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "simple_industry", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "state", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c6795691-70ee-4873-9c34-fe163949ee22", "name": "Indicates that the authorization information is missing or invalid.", "originalRequest": { "url": { "path": [ "api", "v1", "ticker_groups", "filters", "geo", ":iso_code", ":state", "simple", ":simple_industry", "exchange", ":exchange_code" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "exchange_code", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "iso_code", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "simple_industry", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "state", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "17122a17-f286-4a21-931e-edd6701819c0", "name": "Get Tickers By Location", "request": { "name": "Get Tickers By Location", "description": { "content": "Get the list of tickers based in a location with filters iso_code and state.\n\nParameters:\n iso_code (string, required): The ISO 3166-1 alpha-2 or alpha-3 code representing the country. This should be a two or three letter code conforming to the ISO 3166-1 standard. Example: \"US\" or \"USA\" for the United States, \"FR\" or \"FRA\" for France, \"IN\" or \"IND\" for India.\n state (string, optional): The ISO 3166-2 subdivision code representing a state, province, or region within the specified country. This code identifies the subdivision without repeating the country code. Example: \"CA\" for California, \"MH\" for Maharashtra.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "ticker_groups", "geo", "country", ":iso_code" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "iso_code", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "sessionid" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "e11df7e4-9a09-46d2-ba33-67da5cf958a2", "name": "Indicates a successful request.", "originalRequest": { "url": { "path": [ "api", "v1", "ticker_groups", "geo", "country", ":iso_code" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "iso_code", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"tickers\": [\n {\n \"trading_item_id\": 233327368,\n \"security_id\": 233327367,\n \"company_id\": 228031162\n },\n {\n \"trading_item_id\": 301163212,\n \"security_id\": 293377329,\n \"company_id\": 293377323\n },\n {\n \"trading_item_id\": 58277776,\n \"security_id\": 58277756,\n \"company_id\": 58275287\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dace83e9-91e1-4fab-91ea-b5f7b5865393", "name": "Indicates that the query is invalid.", "originalRequest": { "url": { "path": [ "api", "v1", "ticker_groups", "geo", "country", ":iso_code" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "iso_code", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a89cf1c8-df2b-488e-ab2f-01e14d9c9067", "name": "Indicates that the authorization information is missing or invalid.", "originalRequest": { "url": { "path": [ "api", "v1", "ticker_groups", "geo", "country", ":iso_code" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "iso_code", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b47ec100-02d5-4e84-a401-94d923582e4a", "name": "Get Tickers By Location 2", "request": { "name": "Get Tickers By Location 2", "description": { "content": "Get the list of tickers based in a location with filters iso_code and state.\n\nParameters:\n iso_code (string, required): The ISO 3166-1 alpha-2 or alpha-3 code representing the country. This should be a two or three letter code conforming to the ISO 3166-1 standard. Example: \"US\" or \"USA\" for the United States, \"FR\" or \"FRA\" for France, \"IN\" or \"IND\" for India.\n state (string, optional): The ISO 3166-2 subdivision code representing a state, province, or region within the specified country. This code identifies the subdivision without repeating the country code. Example: \"CA\" for California, \"MH\" for Maharashtra.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "ticker_groups", "geo", "country", ":iso_code", ":state" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "iso_code", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "state", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "sessionid" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "d7c1df3b-4e6e-4263-a99c-7788c6cf9d49", "name": "Indicates a successful request.", "originalRequest": { "url": { "path": [ "api", "v1", "ticker_groups", "geo", "country", ":iso_code", ":state" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "iso_code", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "state", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"tickers\": [\n {\n \"trading_item_id\": 233327368,\n \"security_id\": 233327367,\n \"company_id\": 228031162\n },\n {\n \"trading_item_id\": 301163212,\n \"security_id\": 293377329,\n \"company_id\": 293377323\n },\n {\n \"trading_item_id\": 58277776,\n \"security_id\": 58277756,\n \"company_id\": 58275287\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5427c5f7-2c08-412e-90b5-5e830d779576", "name": "Indicates that the query is invalid.", "originalRequest": { "url": { "path": [ "api", "v1", "ticker_groups", "geo", "country", ":iso_code", ":state" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "iso_code", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "state", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "56e5f2aa-f4fd-49bf-aa21-9ad5ddce4a05", "name": "Indicates that the authorization information is missing or invalid.", "originalRequest": { "url": { "path": [ "api", "v1", "ticker_groups", "geo", "country", ":iso_code", ":state" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "iso_code", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "state", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "33d464fa-75db-43de-87c0-2ac36d5ec117", "name": "Get Tickers By Industry Code", "request": { "name": "Get Tickers By Industry Code", "description": { "content": "Get the list of tickers and their associated identification triple that are in the given industry_classification and industry_code", "type": "text/plain" }, "url": { "path": [ "api", "v1", "ticker_groups", "industry", ":industry_classification", ":industry_code" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "industry_classification", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "industry_code", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "sessionid" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "f5972260-26ff-4462-8fad-af3f8d9d36e2", "name": "Indicates a successful request.", "originalRequest": { "url": { "path": [ "api", "v1", "ticker_groups", "industry", ":industry_classification", ":industry_code" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "industry_classification", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "industry_code", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"tickers\": [\n {\n \"trading_item_id\": 427081189,\n \"security_id\": 409602332,\n \"company_id\": 328417257\n },\n {\n \"trading_item_id\": 52290039,\n \"security_id\": 52290038,\n \"company_id\": 3068670\n },\n {\n \"trading_item_id\": 52481038,\n \"security_id\": 52481034,\n \"company_id\": 50989580\n },\n {\n \"trading_item_id\": 686718151,\n \"security_id\": 685658461,\n \"company_id\": 288600722\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "434dcc88-6379-4e3c-8032-185d14b9ff2c", "name": "Indicates that the query is invalid.", "originalRequest": { "url": { "path": [ "api", "v1", "ticker_groups", "industry", ":industry_classification", ":industry_code" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "industry_classification", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "industry_code", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "acc659e3-2190-4cdf-9121-5a28990ed967", "name": "Indicates that the authorization information is missing or invalid.", "originalRequest": { "url": { "path": [ "api", "v1", "ticker_groups", "industry", ":industry_classification", ":industry_code" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "industry_classification", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "industry_code", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b0c9f4fb-75be-4c01-965e-a8fffdd96402", "name": "Get Tickers By GICS Code", "request": { "name": "Get Tickers By GICS Code", "description": { "content": "Get the list of tickers that are classified in the gics_code.\n\nReturns a dictionary of shape {\"tickers\": List[{“company_id”: , “security_id”: , “trading_item_id”: }]}.\nThe gics_code can be either a 2-digit Sector code, 4-digit Industry Group code, 6-digit Industry code, or 8-digit Sub-industry code.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "ticker_groups", "industry", "gics", ":gics_code" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "gics_code", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "sessionid" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "6c26d9c6-c4e1-4385-8674-c96ba8eee85a", "name": "Indicates a successful request.", "originalRequest": { "url": { "path": [ "api", "v1", "ticker_groups", "industry", "gics", ":gics_code" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "gics_code", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"tickers\": [\n {\n \"trading_item_id\": 61701841,\n \"security_id\": 36269110,\n \"company_id\": 4439094\n },\n {\n \"trading_item_id\": 107583526,\n \"security_id\": 107583525,\n \"company_id\": 107583521\n },\n {\n \"trading_item_id\": 52480461,\n \"security_id\": 52480460,\n \"company_id\": 9306226\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7e1c96e7-d4d1-4d87-9d9e-9795e36f2e36", "name": "Indicates that the query is invalid.", "originalRequest": { "url": { "path": [ "api", "v1", "ticker_groups", "industry", "gics", ":gics_code" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "gics_code", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "00ecdd07-cb74-4d81-8a34-db4b0b770672", "name": "Indicates that the authorization information is missing or invalid.", "originalRequest": { "url": { "path": [ "api", "v1", "ticker_groups", "industry", "gics", ":gics_code" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "gics_code", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7b8f904f-3478-4785-8824-10bf05c0b635", "name": "Get Tickers By Simple Industry", "request": { "name": "Get Tickers By Simple Industry", "description": { "content": "Get the list of tickers and their associated identification triple that are in the given simple_industry", "type": "text/plain" }, "url": { "path": [ "api", "v1", "ticker_groups", "industry", "simple", ":simple_industry" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "simple_industry", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "sessionid" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "34488f28-0f4c-4541-b48a-833edb125919", "name": "Indicates a successful request.", "originalRequest": { "url": { "path": [ "api", "v1", "ticker_groups", "industry", "simple", ":simple_industry" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "simple_industry", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"tickers\": [\n {\n \"trading_item_id\": 423272815,\n \"security_id\": 423272814,\n \"company_id\": 424014311\n },\n {\n \"trading_item_id\": 270596144,\n \"security_id\": 270596143,\n \"company_id\": 170181191\n },\n {\n \"trading_item_id\": 272020044,\n \"security_id\": 262353066,\n \"company_id\": 262353065\n },\n {\n \"trading_item_id\": 1683439370,\n \"security_id\": 288098748,\n \"company_id\": 288098747\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4c186d54-6e0a-4bfb-89a4-50b4b6819824", "name": "Indicates that the query is invalid.", "originalRequest": { "url": { "path": [ "api", "v1", "ticker_groups", "industry", "simple", ":simple_industry" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "simple_industry", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "9cb7a2e6-de82-47be-9722-5d877545f37f", "name": "Indicates that the authorization information is missing or invalid.", "originalRequest": { "url": { "path": [ "api", "v1", "ticker_groups", "industry", "simple", ":simple_industry" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "simple_industry", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "581b22ee-42d1-4f62-b06a-5e32222a63de", "name": "Get Trading Items By Exchange Code", "request": { "name": "Get Trading Items By Exchange Code", "description": { "content": "Get the list of trading items that are traded on an exchange via exchange_code", "type": "text/plain" }, "url": { "path": [ "api", "v1", "trading_item_groups", "exchange", ":exchange_code" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "exchange_code", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "sessionid" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "1b8c2027-2f23-4e87-8f03-f46ba0ccdb5d", "name": "Indicates a successful request.", "originalRequest": { "url": { "path": [ "api", "v1", "trading_item_groups", "exchange", ":exchange_code" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "exchange_code", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"trading_items\": [\n 377792098,\n 717416858,\n 574417220,\n 1676244760,\n 2642515,\n 1758738960,\n 1889641821,\n 116446381,\n 607035788\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a322bec3-2bd2-4206-adab-a23eed0ab8a4", "name": "Indicates that the query is invalid.", "originalRequest": { "url": { "path": [ "api", "v1", "trading_item_groups", "exchange", ":exchange_code" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "exchange_code", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "aa84bea9-340d-4aaa-b771-17efd5a21bf1", "name": "Indicates that the authorization information is missing or invalid.", "originalRequest": { "url": { "path": [ "api", "v1", "trading_item_groups", "exchange", ":exchange_code" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "exchange_code", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "188ef3a8-0157-41fc-aa53-fd41fde961e6", "name": "Get Trading Items", "request": { "name": "Get Trading Items", "description": { "content": "Get the list of trading items for a given security_id. Returns a dictionary of shape {\"trading_items\": List[]}", "type": "text/plain" }, "url": { "path": [ "api", "v1", "trading_items", ":security_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "security_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "sessionid" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "a3a7a68e-7a98-4709-b5f1-b4992f1a12e0", "name": "Indicates a successful request.", "originalRequest": { "url": { "path": [ "api", "v1", "trading_items", ":security_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "security_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"trading_items\": [\n 261650546,\n 20241713,\n 20241714,\n 32517177,\n 6163311,\n 419702702,\n 27568602,\n 267867699\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "42b8f6d4-e274-4535-a57c-f7d1cf7d70bc", "name": "Indicates that the query is invalid.", "originalRequest": { "url": { "path": [ "api", "v1", "trading_items", ":security_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "security_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "eec71cbe-bbc1-45bd-ae50-f7003467d23a", "name": "Indicates that the authorization information is missing or invalid.", "originalRequest": { "url": { "path": [ "api", "v1", "trading_items", ":security_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "security_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "83c3278e-ce63-4361-a106-c1d529c4ac89", "name": "Indicates that no trading items were found for the given security_id.", "originalRequest": { "url": { "path": [ "api", "v1", "trading_items", ":security_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "security_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5449f86e-56dc-4c29-83e9-3c9e810eae9e", "name": "Get Primary Trading Item", "request": { "name": "Get Primary Trading Item", "description": { "content": "Get the primary trading item for a given security_id. Returns a dictionary of shape {\"primary_trading_item\": }", "type": "text/plain" }, "url": { "path": [ "api", "v1", "trading_items", ":security_id", "primary" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "security_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "sessionid" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "d7ae6202-844a-4897-975d-cbe5cb9ff8e2", "name": "Indicates a successful request.", "originalRequest": { "url": { "path": [ "api", "v1", "trading_items", ":security_id", "primary" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "security_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"primary_trading_item\": 2610695\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "337d422f-9ba7-4ca5-9fb4-becca584958f", "name": "Indicates that the query is invalid.", "originalRequest": { "url": { "path": [ "api", "v1", "trading_items", ":security_id", "primary" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "security_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c2647788-9452-48ef-b92d-13b566859b7a", "name": "Indicates that the authorization information is missing or invalid.", "originalRequest": { "url": { "path": [ "api", "v1", "trading_items", ":security_id", "primary" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "security_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ef605df2-cea1-4449-aaca-ccdc849413ad", "name": "Indicates that no primary trading item was found for the given security_id.", "originalRequest": { "url": { "path": [ "api", "v1", "trading_items", ":security_id", "primary" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "security_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a3a11147-0ef7-43c9-bb40-cd4e930e1717", "name": "Get Transcript", "request": { "name": "Get Transcript", "description": { "content": "Get the transcript for a given key_dev_id\n\nThe transcript is a list of components comprising component_type, person_name,\nand text", "type": "text/plain" }, "url": { "path": [ "api", "v1", "transcript", ":key_dev_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "key_dev_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "sessionid" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "94dcadc4-0015-439d-9214-0ac122d0c596", "name": "Indicates a successful request.", "originalRequest": { "url": { "path": [ "api", "v1", "transcript", ":key_dev_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "key_dev_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"transcript\": [\n {\n \"component_type\": \"Presentation Operator Message\",\n \"person_name\": \"Operator\",\n \"text\": \"Good morning, and welcome to S&P Global's Fourth Quarter and Full Year 2024 Earnings Conference Call. I'd like to inform you that this call is being recorded for broadcast. [Operator Instructions] To access the webcast and slides, go to investor.spglobal.com. [Operator Instructions] I would now like to introduce Mr. Mark Grant, Senior Vice President of Investor Relations for S&P Global. Sir, you may begin.\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "952d90c3-c206-45a7-83c1-8e2aa9008a19", "name": "Indicates that request parameters are invalid.", "originalRequest": { "url": { "path": [ "api", "v1", "transcript", ":key_dev_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "key_dev_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "1e7dbab3-dd30-419a-bfb4-0d6eb465a7f9", "name": "Indicates that the authorization information is missing or invalid.", "originalRequest": { "url": { "path": [ "api", "v1", "transcript", ":key_dev_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "key_dev_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "14cd171c-eb09-4171-88de-5b6b7cb3adf4", "name": "Indicates that no transcript was found for the given key_dev_id.", "originalRequest": { "url": { "path": [ "api", "v1", "transcript", ":key_dev_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "key_dev_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "185d18b5-5335-4971-ba79-82a294cb8aec", "name": "Get Raw Transcript", "request": { "name": "Get Raw Transcript", "description": { "content": "Get the raw transcript for a given key_dev_id\n\nThe raw transcript is a single string that indicates speakers by\nprepending `[speaker]:` to the transcript of the speaker's speech", "type": "text/plain" }, "url": { "path": [ "api", "v1", "transcript", ":key_dev_id", "raw" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "key_dev_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "sessionid" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "15039a68-3dbb-4d6c-8641-c800cfa6b049", "name": "Indicates a successful request.", "originalRequest": { "url": { "path": [ "api", "v1", "transcript", ":key_dev_id", "raw" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "key_dev_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"transcript\": \"Operator: Good morning, and welcome to S&P Global's Fourth Quarter and Full Year 2024 Earnings Conference Call. I'd like to inform you that this call is being recorded for broadcast. [Operator Instructions] To access the webcast and slides, go to investor.spglobal.com. [Operator Instructions] I would now like to introduce Mr. Mark Grant, Senior Vice President of Investor Relations for S&P Global. Sir, you may begin.\\n\\nMark Grant: Good morning, and thank you for joining today's S&P Global Fourth Quarter and Full Year 2024 Earnings Call. Presenting on today's call …\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b906ca09-69a1-4528-920d-6f8c7a9323d2", "name": "Indicates that request parameters are invalid.", "originalRequest": { "url": { "path": [ "api", "v1", "transcript", ":key_dev_id", "raw" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "key_dev_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "39deb106-5de8-4a26-9d22-bc527d8fa56e", "name": "Indicates that the authorization information is missing or invalid.", "originalRequest": { "url": { "path": [ "api", "v1", "transcript", ":key_dev_id", "raw" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "key_dev_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "bd846b78-a0db-46bf-a985-8d38fae8d9c6", "name": "Indicates that no transcript was found for the given key_dev_id.", "originalRequest": { "url": { "path": [ "api", "v1", "transcript", ":key_dev_id", "raw" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "key_dev_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b2625544-cb9c-4356-9c14-f2c35f93287e", "name": "users permissions retrieve", "request": { "name": "users permissions retrieve", "description": { "content": "Return a list of all permissions that the request user has.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "users", "permissions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "sessionid" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "23988624-f17b-45ad-9d19-0ebc7ea8c283", "name": "Indicates a successful request.", "originalRequest": { "url": { "path": [ "api", "v1", "users", "permissions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"permissions\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3f0657e0-8cd0-4e07-add9-2ac94436cc3e", "name": "Indicates that the authorization information is missing or invalid.", "originalRequest": { "url": { "path": [ "api", "v1", "users", "permissions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "sessionid", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b4ce4e14-6839-4c2d-a6eb-338895ce6431", "name": "Refresh Access Token", "request": { "name": "Refresh Access Token", "description": { "content": "Refresh a client's access token, given their valid refresh token.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "users", "refresh_access_token" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "e77dd588-4b7e-42a1-971b-6ab50e244c49", "name": "Indicates a successful request.", "originalRequest": { "url": { "path": [ "api", "v1", "users", "refresh_access_token" ], "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 \"access_token\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e101128a-6ff5-4e93-b7ce-f96391b7ca70", "name": "Indicates that the query is invalid.", "originalRequest": { "url": { "path": [ "api", "v1", "users", "refresh_access_token" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "63ce1742-3128-4666-b524-dc6a413e47f9", "name": "Indicates that the authorization information is missing or invalid.", "originalRequest": { "url": { "path": [ "api", "v1", "users", "refresh_access_token" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f182f10e-9c5b-47a7-b23a-3414224b2708", "name": "Refresh Access Token 2", "request": { "name": "Refresh Access Token 2", "description": { "content": "Refresh a client's access token, given their valid refresh token.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "users", "refresh_access_token" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "key": "refresh_token", "value": "", "description": "(Required) " } ] } }, "response": [ { "id": "ecd500b5-a67d-45ab-b25e-6ff084a264ec", "name": "Indicates a successful request.", "originalRequest": { "url": { "path": [ "api", "v1", "users", "refresh_access_token" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "refresh_token", "value": "" } ] } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"access_token\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f9347b44-689b-4f72-bdba-f5605f13d533", "name": "Indicates that the query is invalid.", "originalRequest": { "url": { "path": [ "api", "v1", "users", "refresh_access_token" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "refresh_token", "value": "" } ] } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "86b403c1-33fa-43cb-a7f6-870152b309de", "name": "Indicates that the authorization information is missing or invalid.", "originalRequest": { "url": { "path": [ "api", "v1", "users", "refresh_access_token" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "key": "refresh_token", "value": "" } ] } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [], "variable": [ { "type": "string", "value": "https://kfinance.kensho.com", "key": "baseUrl" } ], "info": { "_postman_id": "7b4cf6d8-bac0-4e8a-9041-7102331e02aa", "name": "LLM-ready API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": { "content": "S&P Global Market Intelligence kFinance dataset via LLM-Ready API", "type": "text/plain" } } }