Grade My Stock
Grade My Stock · GPT アクション
AITickerChat Retrieval Plugin API
A retrieval API for querying and filtering SEC filing documents and transcripts as well as financial data including historical financial statements, analyst estimates, revenue segment breakdown, candlestick data, stock quotes, insider transactions and dividends based on natural language queries and metadata.
POST /queryAccepts search query objects with query and filter. Break down complex questions into sub-questions. Only required filter is filenames which should be first obtained from the filenames_post function.GET /analyzeRequest all the data necessary to do fundamental analysis of a company. This will return a JSON with the key_risks, key_opportunities, forward_guidance (management discussions on top risks, opportunities and forward guidance), financial_ratios (including sector median) and all other data.GET /technicalsRequest all the data necessary to do technical analysis of a company and find ideal entry and exit price points. This will return a JSON with the candle data and all necessary technicals.POST /filenamesGet all the SEC and transcript filenames that can be queried. Use this before calling the query_post function.GET /financial-statementsRequest financial statement data in json format. Specify financial statement type, symbol and frequency and get up to 30 years of historical actuals from income statements, balance sheets or cash flow statements.GET /quoteGet real-time quote data for US stocks. Returns Current Price (c), Change (d), Percent change (dp), High (h), Low (l), Open (o), and Previous Close (pc)GET /company-profileGet general information of a company. Response JSON includes country, currency, exchange, market cap, shares outstanding, logo and industry.GET /metricsGet company current financial ratios such as P/E or P/FCF ratio. Includes most ratios that can be calculated from stock price and financial statements.GET /metrics-time-seriesGet company annual or quarterly historical financial ratios such as P/E or P/FCF ratio. Includes most ratios that can be calculated from stock price and financial statements. JSON response includes annual and quarterly keys and then maps key-value pair of time-series ratiosGET /revenue-breakdownGet revenue segment breakdown by product or geography.GET /candlesGet candlestick data (OHLCV) for stocks. Only 1 month of intraday will be returned at a time. If you need more historical intraday data, use the from_timestamp and to_timestamp params iteratively to request more data.GET /dividendGet dividends data for common stocks going back 30 years.GET /price-metricGet company price performance statistics such as 52-week high/low, YTD return, EMAs, SMAs and RSI.GET /revenue-estimatesGet company's revenue estimates. Return JSON includes high, low, and average estimate as well as the number of analysts.GET /ebit-estimatesGet company's ebit estimates. Return JSON includes high, low, and average estimate as well as the number of analysts.GET /ebitda-estimatesGet company's EBITDA estimates. Return JSON includes high, low, and average estimate as well as the number of analysts.GET /eps-estimatesGet company's EPS estimates. Return JSON includes high, low, and average estimate as well as the number of analysts.GET /price-targetsGet latest price target consensus.GET /recommendation-trendsGet latest analyst recommendation trends for a company.GET /earnings-calendarGet historical and coming earnings release. EPS and Revenue in this endpoint are non-GAAP, which means they are adjusted to exclude some one-time or unusual items. Estimates are sourced from both sell-side and buy-side analysts.GET /insider-transactionsCompany insider transactions data sourced from Form 3,4,5, SEDI and relevant companies' filings.
元の API スキーマ
{
"openapi": "3.1.0",
"info": {
"title": "AITickerChat Retrieval Plugin API",
"description": "A retrieval API for querying and filtering SEC filing documents and transcripts as well as financial data including historical financial statements, analyst estimates, revenue segment breakdown, candlestick data, stock quotes, insider transactions and dividends based on natural language queries and metadata.",
"version": "1.0.0"
},
"servers": [
{
"url": "https://data.aitickerchat.com"
}
],
"paths": {
"/query": {
"post": {
"summary": "Accepts search query objects with query and filter. Break down complex questions into sub-questions. Only required filter is filenames which should be first obtained from the filenames_post function.",
"operationId": "query_post",
"x-openai-isConsequential": false,
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/QueryRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/QueryResponse"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/analyze": {
"get": {
"operationId": "analyze_get",
"summary": "Request all the data necessary to do fundamental analysis of a company. This will return a JSON with the key_risks, key_opportunities, forward_guidance (management discussions on top risks, opportunities and forward guidance), financial_ratios (including sector median) and all other data.",
"parameters": [
{
"name": "symbol",
"in": "query",
"required": true,
"schema": {
"type": "string"
},
"description": "The stock symbol (ticker)."
}
]
}
},
"/technicals": {
"get": {
"operationId": "technicals_get",
"summary": "Request all the data necessary to do technical analysis of a company and find ideal entry and exit price points. This will return a JSON with the candle data and all necessary technicals.",
"parameters": [
{
"name": "symbol",
"in": "query",
"required": true,
"schema": {
"type": "string"
},
"description": "The stock symbol (ticker)."
}
]
}
},
"/filenames": {
"post": {
"operationId": "filenames_post",
"summary": "Get all the SEC and transcript filenames that can be queried. Use this before calling the query_post function.",
"x-openai-isConsequential": false,
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FilenamesRequest"
}
}
},
"required": true
}
}
},
"/financial-statements": {
"get": {
"operationId": "financial_statements_get",
"summary": "Request financial statement data in json format. Specify financial statement type, symbol and frequency and get up to 30 years of historical actuals from income statements, balance sheets or cash flow statements.",
"parameters": [
{
"name": "statement",
"in": "query",
"required": true,
"schema": {
"type": "string",
"enum": [
"ic",
"bs",
"cf"
],
"default": "ic",
"description": "The type of financials statement. ic for income statement. bs for balance sheet. cf for cash flow."
}
},
{
"name": "freq",
"in": "query",
"required": true,
"schema": {
"type": "string",
"enum": [
"quarterly",
"annual",
"ttm",
"ytd"
],
"default": "annual",
"description": "The frequency of data to retrieve."
}
},
{
"name": "symbol",
"in": "query",
"required": true,
"schema": {
"type": "string"
},
"description": "The stock symbol (ticker)."
}
]
}
},
"/quote": {
"get": {
"operationId": "quote_get",
"summary": "Get real-time quote data for US stocks. Returns Current Price (c), Change (d), Percent change (dp), High (h), Low (l), Open (o), and Previous Close (pc)",
"parameters": [
{
"name": "symbol",
"in": "query",
"required": true,
"schema": {
"type": "string"
},
"description": "The stock symbol (ticker)."
}
]
}
},
"/company-profile": {
"get": {
"operationId": "company_profile_get",
"summary": "Get general information of a company. Response JSON includes country, currency, exchange, market cap, shares outstanding, logo and industry.",
"parameters": [
{
"name": "symbol",
"in": "query",
"required": true,
"schema": {
"type": "string"
},
"description": "The stock symbol (ticker)."
}
]
}
},
"/metrics": {
"get": {
"operationId": "metrics_get",
"summary": "Get company current financial ratios such as P/E or P/FCF ratio. Includes most ratios that can be calculated from stock price and financial statements.",
"parameters": [
{
"name": "symbol",
"in": "query",
"required": true,
"schema": {
"type": "string"
},
"description": "The stock symbol (ticker)."
}
]
}
},
"/metrics-time-series": {
"get": {
"operationId": "metrics_time_series_get",
"summary": "Get company annual or quarterly historical financial ratios such as P/E or P/FCF ratio. Includes most ratios that can be calculated from stock price and financial statements. JSON response includes annual and quarterly keys and then maps key-value pair of time-series ratios",
"parameters": [
{
"name": "symbol",
"in": "query",
"required": true,
"schema": {
"type": "string"
},
"description": "The stock symbol (ticker)."
},
{
"name": "freq",
"in": "query",
"required": true,
"schema": {
"type": "string",
"enum": [
"quarterly",
"annual"
],
"default": "annual",
"description": "The frequency of data to retrieve."
}
}
]
}
},
"/revenue-breakdown": {
"get": {
"operationId": "revenue_breakdown_get",
"summary": "Get revenue segment breakdown by product or geography.",
"parameters": [
{
"name": "symbol",
"in": "query",
"required": true,
"schema": {
"type": "string"
},
"description": "The stock symbol (ticker)."
}
]
}
},
"/candles": {
"get": {
"operationId": "candles_get",
"summary": "Get candlestick data (OHLCV) for stocks. Only 1 month of intraday will be returned at a time. If you need more historical intraday data, use the from_timestamp and to_timestamp params iteratively to request more data.",
"parameters": [
{
"name": "symbol",
"in": "query",
"required": true,
"schema": {
"type": "string"
},
"description": "The stock symbol (ticker)."
},
{
"name": "resolution",
"in": "query",
"required": true,
"schema": {
"type": "string",
"enum": [
"1",
"5",
"15",
"30",
"60",
"D",
"W",
"M"
]
},
"default": "D",
"description": "Supported resolution includes 1, 5, 15, 30, 60, D, W, M. Some timeframes might not be available depending on the exchange."
},
{
"name": "from_timestamp",
"in": "query",
"required": true,
"schema": {
"type": "integer"
},
"description": "The UNIX timestamp of the interval initial value."
},
{
"name": "to_timestamp",
"in": "query",
"required": true,
"schema": {
"type": "integer"
},
"description": "The UNIX timestamp of the interval end value."
}
]
}
},
"/dividend": {
"get": {
"operationId": "dividend",
"summary": "Get dividends data for common stocks going back 30 years.",
"parameters": [
{
"name": "symbol",
"in": "query",
"required": true,
"schema": {
"type": "string"
},
"description": "The stock symbol (ticker)."
}
]
}
},
"/price-metric": {
"get": {
"operationId": "price-metric",
"summary": "Get company price performance statistics such as 52-week high/low, YTD return, EMAs, SMAs and RSI.",
"parameters": [
{
"name": "symbol",
"in": "query",
"required": true,
"schema": {
"type": "string"
},
"description": "The stock symbol (ticker)."
}
]
}
},
"/revenue-estimates": {
"get": {
"operationId": "revenue-estimates",
"summary": "Get company's revenue estimates. Return JSON includes high, low, and average estimate as well as the number of analysts.",
"parameters": [
{
"name": "symbol",
"in": "query",
"required": true,
"schema": {
"type": "string"
},
"description": "The stock symbol (ticker)."
},
{
"name": "freq",
"in": "query",
"required": true,
"schema": {
"type": "string",
"enum": [
"quarterly",
"annual"
],
"default": "annual",
"description": "The frequency of data to retrieve."
}
}
]
}
},
"/ebit-estimates": {
"get": {
"operationId": "ebit-estimates",
"summary": "Get company's ebit estimates. Return JSON includes high, low, and average estimate as well as the number of analysts.",
"parameters": [
{
"name": "symbol",
"in": "query",
"required": true,
"schema": {
"type": "string"
},
"description": "The stock symbol (ticker)."
},
{
"name": "freq",
"in": "query",
"required": true,
"schema": {
"type": "string",
"enum": [
"quarterly",
"annual"
],
"default": "annual",
"description": "The frequency of data to retrieve."
}
}
]
}
},
"/ebitda-estimates": {
"get": {
"operationId": "ebitda-estimates",
"summary": "Get company's EBITDA estimates. Return JSON includes high, low, and average estimate as well as the number of analysts.",
"parameters": [
{
"name": "symbol",
"in": "query",
"required": true,
"schema": {
"type": "string"
},
"description": "The stock symbol (ticker)."
},
{
"name": "freq",
"in": "query",
"required": true,
"schema": {
"type": "string",
"enum": [
"quarterly",
"annual"
],
"default": "annual",
"description": "The frequency of data to retrieve."
}
}
]
}
},
"/eps-estimates": {
"get": {
"operationId": "eps-estimates",
"summary": "Get company's EPS estimates. Return JSON includes high, low, and average estimate as well as the number of analysts.",
"parameters": [
{
"name": "symbol",
"in": "query",
"required": true,
"schema": {
"type": "string"
},
"description": "The stock symbol (ticker)."
},
{
"name": "freq",
"in": "query",
"required": true,
"schema": {
"type": "string",
"enum": [
"quarterly",
"annual"
],
"default": "annual",
"description": "The frequency of data to retrieve."
}
}
]
}
},
"/price-targets": {
"get": {
"operationId": "price-targets",
"summary": "Get latest price target consensus.",
"parameters": [
{
"name": "symbol",
"in": "query",
"required": true,
"schema": {
"type": "string"
},
"description": "The stock symbol (ticker)."
}
]
}
},
"/recommendation-trends": {
"get": {
"operationId": "recommendation-trends",
"summary": "Get latest analyst recommendation trends for a company.",
"parameters": [
{
"name": "symbol",
"in": "query",
"required": true,
"schema": {
"type": "string"
},
"description": "The stock symbol (ticker)."
}
]
}
},
"/earnings-calendar": {
"get": {
"operationId": "earnings-calendar",
"summary": "Get historical and coming earnings release. EPS and Revenue in this endpoint are non-GAAP, which means they are adjusted to exclude some one-time or unusual items. Estimates are sourced from both sell-side and buy-side analysts.",
"parameters": [
{
"name": "symbol",
"in": "query",
"required": true,
"schema": {
"type": "string"
},
"description": "The stock symbol (ticker)."
}
]
}
},
"/insider-transactions": {
"get": {
"operationId": "insider-transactions",
"summary": "Company insider transactions data sourced from Form 3,4,5, SEDI and relevant companies' filings.",
"parameters": [
{
"name": "symbol",
"in": "query",
"required": true,
"schema": {
"type": "string"
},
"description": "The stock symbol (ticker)."
}
]
}
}
},
"components": {
"schemas": {
"DocumentChunkMetadata": {
"title": "DocumentChunkMetadata",
"type": "object",
"properties": {
"source": {
"$ref": "#/components/schemas/Source"
},
"filename": {
"title": "Filename",
"type": "string"
},
"url": {
"title": "Url",
"type": "string"
},
"form_type": {
"$ref": "#/components/schemas/FormType"
},
"published_date": {
"title": "Published Date",
"type": "integer"
},
"document_id": {
"title": "Document Id",
"type": "string"
},
"symbol": {
"title": "Stock Symbol",
"type": "string"
},
"cik": {
"title": "Stock CIK",
"type": "string"
},
"fiscal_quarter": {
"title": "Fiscal Quarter",
"type": "integer"
},
"fiscal_year": {
"title": "Fiscal Year",
"type": "integer"
},
"is_xbrl": {
"title": "Is XBRL",
"type": "boolean"
}
}
},
"DocumentChunkWithScore": {
"title": "DocumentChunkWithScore",
"required": [
"text",
"metadata",
"score"
],
"type": "object",
"properties": {
"id": {
"title": "Id",
"type": "string"
},
"text": {
"title": "Text",
"type": "string"
},
"metadata": {
"$ref": "#/components/schemas/DocumentChunkMetadata"
},
"embedding": {
"title": "Embedding",
"type": "array",
"items": {
"type": "number"
}
},
"score": {
"title": "Score",
"type": "number"
}
}
},
"DocumentMetadataFilter": {
"title": "DocumentMetadataFilter",
"type": "object",
"properties": {
"filenames": {
"title": "Filenames",
"type": "array",
"description": "The array of filenames that should be searched. Get the specific filenames from the filenames_get function.",
"items": {
"$ref": "#/components/schemas/Filename"
}
}
}
},
"HTTPValidationError": {
"title": "HTTPValidationError",
"type": "object",
"properties": {
"detail": {
"title": "Detail",
"type": "array",
"items": {
"$ref": "#/components/schemas/ValidationError"
}
}
}
},
"Filename": {
"title": "Filename",
"type": "string"
},
"Query": {
"title": "Query",
"required": [
"query"
],
"type": "object",
"properties": {
"query": {
"title": "Query",
"type": "string"
},
"filter": {
"$ref": "#/components/schemas/DocumentMetadataFilter"
}
}
},
"QueryRequest": {
"title": "QueryRequest",
"required": [
"queries"
],
"type": "object",
"properties": {
"queries": {
"title": "Queries",
"type": "array",
"items": {
"$ref": "#/components/schemas/Query"
}
}
}
},
"FilenamesRequest": {
"title": "FilenamesRequest",
"required": [
"symbols"
],
"type": "object",
"properties": {
"symbols": {
"title": "Symbols",
"type": "array",
"items": {
"symbol": "string"
}
}
}
},
"QueryResponse": {
"title": "QueryResponse",
"required": [
"results"
],
"type": "object",
"properties": {
"results": {
"title": "Results",
"type": "array",
"items": {
"$ref": "#/components/schemas/QueryResult"
}
},
"extra_information_for_assistant": {
"title": "Extra Information",
"type": "string",
"description": "Extra information for you on how to respond to queries."
}
}
},
"QueryResult": {
"title": "QueryResult",
"required": [
"query",
"results"
],
"type": "object",
"properties": {
"query": {
"title": "Query",
"type": "string"
},
"results": {
"title": "Results",
"type": "array",
"items": {
"$ref": "#/components/schemas/DocumentChunkWithScore"
}
}
}
},
"Source": {
"title": "Source",
"enum": [
"SEC",
"EarningsCallTranscripts"
],
"type": "string",
"description": "An enumeration."
},
"FormType": {
"title": "Form Type",
"enum": [
"earnings_transcript",
"10-K",
"10-Q",
"8-K",
"DEFA14A",
"DEF 14A",
"S-1",
"S-3",
"6-K",
"20-F"
],
"type": "string",
"description": "An enumeration describing type of document to retrieve. Always use 'earnings_transcript' for earnings calls. Use '10-K' or '10-Q' to summarize quarterly or annual results. Use '8-K' for news. Use 'DEF 14A' for information on a shareholder vote. Use 'S-1' for IPOs. Use 'S-3' for information on raising capital."
},
"ValidationError": {
"title": "ValidationError",
"required": [
"loc",
"msg",
"type"
],
"type": "object",
"properties": {
"loc": {
"title": "Location",
"type": "array",
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
}
},
"msg": {
"title": "Message",
"type": "string"
},
"type": {
"title": "Error Type",
"type": "string"
}
}
}
}
}
}