How-To Guides

Each guide covers one task inside a provider or router extension. They assume a working extension; Extension types shows how to build one.

HTTP requests
Make sync and async requests with the helpers that apply the user's HTTP settings.
Country input
Accept country names or codes and normalize them to ISO 3166 with the Country type.
Exchange input
Accept exchange names, acronyms, or MICs and normalize them to ISO 10383 with the Exchange type.
Annotated results
Return source metadata alongside the results of a fetcher.
Function examples
Add APIEx and PythonEx examples to commands for docstrings and the OpenAPI schema.
Validators
Parse, normalize, and default values in QueryParams and Data models.
Disabling output validation
Return output that does not match the declared model with no_validate.
Deprecating endpoints
Warn users about a command that will be removed, in Python and in the OpenAPI schema.
Dynamic command execution
Run commands by route with CommandRunner, without the generated package.
Tests
Test fetchers, record HTTP cassettes, and generate integration tests.