Finance Educator · GPT-Aktionen

{
  "openapi": "3.0.0",
  "info": {
    "title": "VectaBass GPT Finance API",
    "version": "1.0.0"
  },
  "servers": [
    {
      "url": "https://app.vectabass.com"
    }
  ],
  "paths": {
    "/finance/historic_returns/": {
      "get": {
        "summary": "Get historic returns of specified tickers",
        "operationId": "historicReturns",
        "parameters": [
          {
            "name": "tickers",
            "in": "query",
            "required": false,
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "style": "form",
            "explode": false,
            "description": "List of tickers"
          }
        ],
        "responses": {
          "200": {
            "description": "Historic returns of tickers",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "ticker": {
                        "type": "string"
                      },
                      "return": {
                        "type": "number"
                      },
                      "description": {
                        "type": "string"
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/finance/risk_matrix_visual/": {
      "get": {
        "summary": "Visualize the risk matrix",
        "operationId": "riskMatrixVisual",
        "parameters": [
          {
            "name": "tickers",
            "in": "query",
            "required": false,
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "style": "form",
            "explode": false,
            "description": "List of tickers"
          }
        ],
        "responses": {
          "200": {
            "description": "URL to the visualized risk matrix and risk data",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "image_url": {
                      "type": "string"
                    },
                    "risk_data": {
                      "type": "object"
                    },
                    "description": {
                      "type": "string"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/finance/VaR/": {
      "get": {
        "summary": "Get Value at Risk (VaR) of specified tickers",
        "operationId": "getVaR",
        "parameters": [
          {
            "name": "tickers",
            "in": "query",
            "required": false,
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "style": "form",
            "explode": false,
            "description": "List of tickers"
          }
        ],
        "responses": {
          "200": {
            "description": "Value at Risk (VaR) of tickers",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "ticker": {
                        "type": "string"
                      },
                      "return": {
                        "type": "number"
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/finance/history-summaries/": {
      "get": {
        "summary": "Plot history summaries of specified tickers",
        "operationId": "plotHistorySummary",
        "parameters": [
          {
            "name": "tickers",
            "in": "query",
            "required": false,
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "style": "form",
            "explode": false,
            "description": "List of tickers"
          }
        ],
        "responses": {
          "200": {
            "description": "URL to the history summary plots",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "image_url": {
                      "type": "string"
                    },
                    "description": {
                      "type": "string"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/finance/generate-portfolios/": {
      "get": {
        "summary": "Generate stochastic portfolios and visualize them",
        "operationId": "generatePortfoliosStochastic",
        "parameters": [
          {
            "name": "tickers",
            "in": "query",
            "required": false,
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "style": "form",
            "explode": false,
            "description": "List of tickers"
          },
          {
            "name": "prediction_period",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string",
              "enum": [
                "annual",
                "monthly"
              ]
            },
            "description": "Prediction period to generate portfolios for, can be 'annual' or 'monthly'"
          }
        ],
        "responses": {
          "200": {
            "description": "URL to the portfolio visualization and portfolio data to be displayed as ascii tables in markdown",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "image_url": {
                      "type": "string"
                    },
                    "max_return_portfolio": {
                      "type": "object"
                    },
                    "max_sharpe_portfolio": {
                      "type": "object"
                    },
                    "average_sharpe_portfolio": {
                      "type": "object"
                    },
                    "average_return_portfolio": {
                      "type": "object"
                    },
                    "description": {
                      "type": "string"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/finance/plot-pe-ratios/": {
      "get": {
        "summary": "Plot PE Ratios for a specified ticker",
        "operationId": "plotPeRatios",
        "parameters": [
          {
            "name": "ticker",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "The ticker for which PE Ratios are to be plotted"
          }
        ],
        "responses": {
          "200": {
            "description": "URL to the plotted PE Ratios and PE Ratios data",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "image_url": {
                      "type": "string"
                    },
                    "pe-ratios": {
                      "type": "object"
                    },
                    "description": {
                      "type": "string"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/finance/plot-price-targets/": {
      "get": {
        "summary": "Plot price targets for a specified ticker",
        "operationId": "plotPriceTargets",
        "parameters": [
          {
            "name": "ticker",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "The ticker for which price targets are to be plotted"
          }
        ],
        "responses": {
          "200": {
            "description": "URL to the plotted price targets and price targets data",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "image_url": {
                      "type": "string"
                    },
                    "price_targets": {
                      "type": "object"
                    },
                    "description": {
                      "type": "string"
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}