Errors
[Arg] provider -> input: nasdaq -> Input should be 'fmp' or 'yfinance'
There could be a few reasons for this message.
-
The provider supplied is not installed, in which case install it and follow the next step.
-
The provider extension is installed, but the static assets have not been refreshed. Rebuild the static assets from the command line with:
python -c "import openbb;openbb.build()"
An environment variable to auto-build the static assets on import - if there are changes to the installed configuration - can be defined as:
OPENBB_AUTO_BUILD="true"
The expected behaviour is for this to be "true" by default, however can be situations where the flag does not trigger a build. Manually invoke the process from the command line if necessary.
- Not every endpoint is supported by every provider. To see the coverage of commands and data providers within the current installation, use
reference
property in the app. The docstring for each function contains the same information as the code block below.
from openbb import obb
path = "/index/available"
[d for d in obb.reference["paths"][path]["parameters"] if d != "standard"]
['cboe', 'fmp', 'tmx', 'yfinance']
Complete breakdowns of query and return fields by provider and endpoint are available under the Reference
Attribute Error: 'App' object has no attribute 'some attribute'
There could be a few reasons for this message that are similar to the issue above.
- The extension is not installed.
- Install it and rebuild the static files (described in the item above.)
- No installed provider extension services an endpoint within the router.
- Under these conditions, the router is excluded from the app factory.
- The extension is installed, a provider does service the router, but the static assets have not been rebuilt.
- Rebuild the static files (described in the item above.)
Unauthorized Error - HTTP Status Code 502
This error is raised when provider credentials are supplied but is invalid for the particular endpoint.
Verify your credentials, access level, and subscription status directly with the provider.
Unprocessable Entity (OpenBBError) - HTTP Status Code 422
This error is raised for handled exceptions. An abbreviated traceback message will display, and the full message is enabled via debug mode.
A common reason for this error is because a required parameter was not supplied, or was an incorrect choice. It may also be raised during parsing and transformation, post-request.
Empty Data Error - HTTP Status Code 204
Also a 204 status code from the API. It means that the data was returned empty but the operation was a success.
There might not be anything wrong, or it could be the result of parameter choices. In which case, widen the scope of the query to capture output.
Some sources will return bad requests with a 200 status code and no message.
If all parameter permutations are only capable of returning an empty response, please open a bug issue on GitHub with the operating system and version, Python version, and the syntax responsible for the error.
Unexpected Error - HTTP Status Code 500
An unhandled exception. Traceback messages are truncated unless the debug environment variable is set.
import os
os.environ["OPENBB_DEBUG_MODE"] = "true"
from openbb import obb
# run the syntax that created the error and the full traceback will print to the console.
If the issue originates from OpenBB code, please open a bug issue on GitHub
Be sure to include the contents of the traceback, the operating system and version, Python version, and the syntax responsible for the error.
How do I start in debug mode?
Debug mode can be set as an environment variable, in ~/openbb_platform/.env
, as:
OPENBB_DEBUG_MODE=true
It can be invoked for the current session only by adding this code before importing the OpenBB package.
import os
os.environ["OPENBB_DEBUG_MODE"] = "true"
from openbb import obb