Parameter | Type |
---|---|
_requestBody | OBJECT |
[
{
"description": "Summarize stock info",
"name": "postApiStockSummary",
"parameters": {
"properties": {
"_requestBody": {
"required": [
"prompt",
"region",
"symbol"
],
"type": "object",
"properties": {
"prompt": {
"type": "string",
"description": "The latest chat prompt from the user"
},
"region": {
"type": "string",
"description": "An ISO-3166-1 alpha-2 code of the country",
"example": "JP"
},
"symbol": {
"type": "string",
"description": "The identifier of the stock in the corresponding region",
"example": "AAPL"
}
}
}
},
"type": "object"
}
},
{
"description": "Search factor",
"name": "getApiSearchFactor",
"parameters": {
"properties": {
"query": {
"type": "string"
},
"category": {
"type": "string",
"examples": [
"Scoring",
"Value",
"Efficiency",
"Profitability",
"Growth",
"Stability",
"Price",
"Volume",
"Statistics",
"Shareholder Policy",
"Analyst Outlook"
]
}
},
"required": [
"query"
],
"type": "object"
}
},
{
"description": "Search industry sectors",
"name": "getApiSearchSector",
"parameters": {
"properties": {
"query": {
"type": "string"
}
},
"required": [
"query"
],
"type": "object"
}
},
{
"description": "Screen stocks",
"name": "postApiCustom-indexScreen",
"parameters": {
"properties": {
"_requestBody": {
"required": [
"prompt",
"region",
"limit"
],
"type": "object",
"properties": {
"prompt": {
"type": "string",
"description": "The latest chat prompt from the user"
},
"region": {
"type": "string",
"description": "An ISO-3166-1 alpha-2 code of the country",
"example": "KR"
},
"sectorIds": {
"type": "array",
"items": {
"type": "integer",
"description": "The unique identifier for the group or sector.\n",
"format": "int32"
},
"description": "Sector identifiers that can be found from at `/api/sector/search`"
},
"filterRules": {
"type": "array",
"items": {
"required": [
"factorId",
"operator",
"value",
"searchMode"
],
"type": "object",
"properties": {
"factorId": {
"type": "integer",
"description": "The unique identifier for the factor",
"format": "int32",
"example": 1113
},
"operator": {
"type": "string",
"description": "Operator",
"enum": [
">",
">=",
"<=",
"<"
]
},
"value": {
"type": "number",
"description": "The minimum threshold. If `searchMode` is `RELATIVE`, the scale of value is percent.",
"format": "double"
},
"searchMode": {
"type": "string",
"description": "Whether the type of value is absolute or relative. If `searchMode` is `RELATIVE`, the scale of value is percent.",
"enum": [
"Absolute",
"Relative"
]
}
},
"example": {
"factorId": 1133,
"operator": ">=",
"value": 100,
"searchMode": "Absolute"
}
},
"description": "The search criteria. Multiple conditions mean logical and (&&). The factors should be identified by numeric ID that can be found at GET /api/custom-index/factors"
},
"sortRules": {
"type": "array",
"items": {
"required": [
"factorId",
"direction"
],
"type": "object",
"properties": {
"factorId": {
"type": "integer",
"description": "The unique identifier for the factor",
"format": "int32",
"example": 1113
},
"direction": {
"type": "string",
"description": "The sort direction",
"enum": [
"ASC",
"DESC"
]
}
},
"example": {
"factorId": 1113,
"direction": "DESC"
}
},
"description": "The sorting criteria, which can be used to find top N items that meets the search criteria."
},
"limit": {
"type": "integer",
"description": "The maximum number of stocks in the result",
"format": "int32"
}
}
}
},
"type": "object"
}
}
]