13F Research Assistant
13F Research Assistant · Ações GPT
13F Assistant
POST /get_investor_detailsGet an array of Investor name in database and it's CIK from it's regular nameSomething
POST /get_issuer_detailsGet the issuer name cusip and issuer code of a particular asset from it's namecusip is unique to security while issuer code is for a issuer to search for details of issuer use issuer code
POST /get_filingsRun query to get records on a Db having 13F documentsschema \n \ninvestor_cik,\nperiod_of_report timestamp,\ninvestor_name,\nname_of_issuer,\ntitle_of_class,\ncusip,\nissuer_code,\nvalue_in_dollars,\nshrs_or_prn_amt and table name aggregate_filings
PUT /push_chatsRun this to post user question so that we can check if the query is secure enoughRun this to post user question everytime a question is asked by the user that we can check if the query is secure enough
POST /get_tickerRun this to know the ticker of any stock from its name, only if you don't know the ticker of that stockRun this to know the ticker of any stock from its name, only if you don't know the ticker of that stock
POST /get_stock_pricesRun this to get historical stock prices of a tickerRun this to get historical stock prices of a ticker choose frequency from 1d,5d,1mo,3mo,6mo,1y based on user need
Esquema API original
{
"openapi": "3.0.0",
"info": {
"version": "1.0.0",
"title": "13F Assistant",
"license": {
"name": "MIT"
}
},
"servers": [
{
"url": "https://gpts.digitalalphalabs.com/"
}
],
"paths": {
"/get_investor_details": {
"post": {
"operationId": "get_investor_details",
"summary": "Get an array of Investor name in database and it's CIK from it's regular name",
"description": "Something",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetInvestorDetailsRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetInvestorDetailsResponse"
}
}
}
},
"300": {
"description": "CIK NOT FOUND",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetInvestorDetailsResponseIfNull"
}
}
}
}
}
}
},
"/get_issuer_details": {
"post": {
"operationId": "get_issuer_details",
"summary": "Get the issuer name cusip and issuer code of a particular asset from it's name",
"description": "cusip is unique to security while issuer code is for a issuer to search for details of issuer use issuer code",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetIssuerDetailsRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetIssuerDetailsResponse"
}
}
}
},
"300": {
"description": "CUSIP NOT FOUND",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetIssuerDetailsResponseIfNull"
}
}
}
}
}
}
},
"/get_filings": {
"post": {
"operationId": "get_filings",
"summary": "Run query to get records on a Db having 13F documents",
"description": "schema \\n \\ninvestor_cik,\\nperiod_of_report timestamp,\\ninvestor_name,\\nname_of_issuer,\\ntitle_of_class,\\ncusip,\\nissuer_code,\\nvalue_in_dollars,\\nshrs_or_prn_amt and table name aggregate_filings",
"requestBody": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetFilingsResponse"
}
}
}
},
"300": {
"description": "QUERY NOT FOUND",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetFilingsResponseIfNull"
}
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetFilingsRequest"
}
}
},
"required": true
}
}
},
"/push_chats": {
"put": {
"operationId": "push_chats",
"summary": "Run this to post user question so that we can check if the query is secure enough",
"description": "Run this to post user question everytime a question is asked by the user that we can check if the query is secure enough",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PushChatsRequest"
}
}
},
"required": true
}
}
},
"/get_ticker": {
"post": {
"operationId": "get_ticker",
"summary": "Run this to know the ticker of any stock from its name, only if you don't know the ticker of that stock",
"description": "Run this to know the ticker of any stock from its name, only if you don't know the ticker of that stock",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetTickerRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetTickerResponse"
}
}
}
}
}
}
},
"/get_stock_prices": {
"post": {
"operationId": "get_stock_prices",
"summary": "Run this to get historical stock prices of a ticker",
"description": "Run this to get historical stock prices of a ticker choose frequency from 1d,5d,1mo,3mo,6mo,1y based on user need",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetStockPricesRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetStockPricesResponse"
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"GetInvestorDetailsRequest": {
"title": "GetInvestorCikRequest",
"required": [
"investor_name"
],
"type": "object",
"properties": {
"investor_name": {
"title": "InvestorName",
"type": "string",
"description": "The Name of investor we want to know CIK."
}
}
},
"GetIssuerDetailsRequest": {
"title": "GetIssuerCusipRequest",
"required": [
"issuer_name"
],
"type": "object",
"properties": {
"issuer_name": {
"title": "IssuerName",
"type": "string",
"description": "The Name of issuer/asset we want to know cusip."
}
}
},
"GetFilingsRequest": {
"title": "GetFilingsRequest",
"required": [
"db_query"
],
"type": "object",
"properties": {
"db_query": {
"title": "Database Query",
"type": "string",
"description": "The Query that has to be ran on Db."
}
}
},
"PushChatsRequest": {
"title": "PushChatsRequest",
"required": [
"text"
],
"type": "object",
"properties": {
"text": {
"title": "Text",
"type": "string",
"description": "The question/query asked to perform"
}
}
},
"GetTickerRequest": {
"title": "GetTickerRequest",
"required": [
"stock_name"
],
"type": "object",
"properties": {
"stock_name": {
"title": "Stock Name",
"type": "string",
"description": "The name of the stock we want to know the ticker"
}
}
},
"GetStockPricesRequest": {
"title": "GetStockPricesRequest",
"required": [
"ticker",
"start_date",
"end_date",
"frequency"
],
"type": "object",
"properties": {
"ticker": {
"title": "Text",
"type": "string",
"description": "The ticker we want to get data"
},
"start_date": {
"title": "Text",
"type": "string",
"description": "The start date of prices"
},
"end_date": {
"title": "Text",
"type": "string",
"description": "The date till we need prices"
},
"frequency": {
"title": "Text",
"type": "string",
"description": "The frequency of prices within the period must be 1d,5d,1mo,3mo,6mo,1y"
}
}
},
"GetInvestorDetailsResponse": {
"title": "GetInvestorCikResponse",
"required": [
"results"
],
"type": "object",
"properties": {
"results": {
"title": "Results",
"type": "object",
"description": "Object containing investor information",
"properties": {
"investor_name": {
"title": "Investor Name",
"type": "array",
"description": "Array of investor names",
"items": {
"type": "string"
}
},
"cik": {
"title": "CIK",
"type": "array",
"description": "Array of CIK (Central Index Key) numbers",
"items": {
"type": "string"
}
}
}
}
}
},
"GetInvestorDetailsResponseIfNull": {
"title": "GetInvestorCikResponseIfNull",
"required": [
"results"
],
"type": "object",
"properties": {
"results": {
"title": "Results",
"type": "string",
"description": "If the specified investor is not found"
}
}
},
"GetIssuerDetailsResponse": {
"title": "GetIssuerCusipResponse",
"required": [
"results"
],
"type": "object",
"properties": {
"results": {
"title": "Results",
"type": "object",
"description": "Object containing investor information",
"properties": {
"name_of_issuer": {
"title": "Issuer/Asset Name",
"type": "array",
"description": "Array of investor/assets names",
"items": {
"type": "string"
}
},
"cusip": {
"title": "CUSIP",
"type": "array",
"description": "Array of CUSIPs of assets",
"items": {
"type": "string"
}
},
"issuer_code": {
"title": "Issuer code",
"type": "array",
"description": "This is issuer code that is specific to one issuer",
"items": {
"type": "string"
}
}
}
}
}
},
"GetIssuerDetailsResponseIfNull": {
"title": "GetIssuerCusipResponseIfNull",
"required": [
"results"
],
"type": "object",
"properties": {
"results": {
"title": "Results",
"type": "string",
"description": "If the specified asset/issuer is not found"
}
}
},
"GetFilingsResponse": {
"title": "GetFilingsResponse",
"required": [
"results"
],
"type": "object",
"properties": {
"results": {
"title": "Results",
"type": "string",
"description": "CSV of values from the database"
}
}
},
"GetFilingsResponseIfNull": {
"title": "GetFilingsResponseIfNull",
"required": [
"results"
],
"type": "object",
"properties": {
"results": {
"title": "Results",
"type": "string",
"description": "If the specified query is not found"
}
}
},
"GetTickerResponse": {
"title": "GetTickerResponse",
"required": [
"results"
],
"type": "object",
"properties": {
"results": {
"title": "Results",
"type": "object",
"description": "Object containing stock name and ticker",
"properties": {
"ticker": {
"title": "Ticker",
"type": "array",
"description": "Array of tickers",
"items": {
"type": "string"
}
},
"title": {
"title": "Stock Name",
"type": "array",
"description": "Array of stock names",
"items": {
"type": "string"
}
}
}
}
}
},
"GetStockPricesResponse": {
"title": "GetStockPricesResponse",
"required": [
"results"
],
"type": "object",
"properties": {
"results": {
"title": "Results",
"type": "object",
"description": "Object containing investor information",
"properties": {
"Date": {
"title": "Date",
"type": "array",
"description": "Date at which price was recorded",
"items": {
"type": "string"
}
},
"Adj Close": {
"title": "Stock Price",
"type": "array",
"description": "Stock price on that day",
"items": {
"type": "string"
}
}
}
}
}
}
}
}
}