用户偏好设置

用户设置存储在本地 ~/.openbb_platform/ 目录下的 JSON 文件 user_settings.json 中。它在初始化 Python 客户端或 Fast API 授权时被读取。如果文件不存在，将在首次运行时创建。

此文件存储：

以下是设置后可能的样子示例：

{
    "credentials": {
        "fmp_api_key": "REPLACE",
        "polygon_api_key": "REPLACE",
    },
    "preferences": {
        "data_directory": "~/OpenBBUserData",
        "export_directory": "~/OpenBBUserData/exports",
        "metadata": true,
        "output_type": "OBBject"
    },
    "defaults": {
        "commands": {
            "/equity/price/historical": {
                "provider": "fmp"
            },
            "/equity/fundamental/balance": {
                "provider": [
                    "intrinio",
                    "fmp",
                    "polygon"
                ]
            },
        }
    }
}

偏好设置

偏好设置	默认值	选项	描述
data_directory	/home/OpenBBUserData	任何路径	首次启动应用程序时将创建此目录。它作为应用程序存储使用工件（如日志和导出）的默认位置。
export_directory	/home/OpenBBUserData/exports	任何路径	OpenBB 图表扩展提供以各种格式导出图像的功能。这是它尝试保存此类导出的目录。
cache_directory	/home/OpenBBUserData/cache	任何路径	存储 http 请求和数据库缓存的目录，用于具有缓存功能的函数。
user_styles_directory	/home/OpenBBUserData/styles/user	任何路径	OpenBB 图表扩展支持自定义样式。此目录是它查找用户定义样式的位置。如果在此目录中找不到用户样式，应用程序将使用默认样式。
charting_extension	openbb_charting	["openbb_charting"]	与应用程序一起使用的图表扩展名称。
chart_style	dark	["dark", "light"]	与 OpenBB 图表扩展图表一起使用的默认颜色样式。选项包括 "dark" 和 "light"。
table_style	dark	["dark", "light"]	与 OpenBB 图表扩展表格一起使用的默认颜色样式。选项包括 "dark" 和 "light"。
metadata	true	[true, false]	启用或禁用元数据收集，元数据提供有关操作的信息，包括参数持续时间路由和时间戳。在不需要上下文信息或额外计算时间和存储空间是关注点的情况下，禁用此功能可能会提高性能。
output_type	OBBject	["OBBject", "dataframe", "numpy", "dict", "chart", "polars", "llm"]	指定访问命令或端点时应用程序将输出的数据类型。请注意，选择仅在 Python 中可用的数据格式（如 `dataframe`、`numpy` 或 `polars`）将使应用程序的 API 无法正常工作。
show_warnings	false	[true, false]	启用或禁用警告显示。

备注

如果主目录中没有 OpenBBUserData 文件夹，应用程序将在首次运行时创建一个。带有路径的用户偏好设置都默认指向此文件夹 - 导出、样式或数据 - 可以随时更改以适应需要。
即使偏好设置没有指向 OpenBBUserData，它仍然会被创建，因为应用程序需要一个地方来存储日志和其他工件。
从 OpenBB 平台导出文件或图像的一种方法是利用 OpenBB 图表扩展的功能。export_directory 偏好设置是扩展将尝试保存 CSV 和图像文件的位置。

偏好设置​

偏好设置