Repository navigation
Introduce fully typed Python API client #481
Description
Currently, the apify-client-python relies mostly on untyped dict and poor typing in general.
Let's introduce full type coverage across the client by defining Pydantic models for API responses and adding proper type annotations for all functions, methods, and their arguments.
Where possible, these models and types should be generated directly from the OpenAPI specification to ensure consistency with the API.
OpenAPI specs - https://docs.apify.com/api/openapi.json
Some existing solutions to explore & test:
- https://github.com/openapi-generators/openapi-python-client
- https://github.com/OpenAPITools/openapi-generator
- https://github.com/koxudaxi/datamodel-code-generator
- https://github.com/MarcoMuellner/openapi-python-generator
For additional context, see parent (epic) issue - https://github.com/apify/apify-core/issues/25186.
Activity
shubhamos-ai commentedon Aug 29, 2025
This looks like a valuable enhancement! The proposed approach seems solid. I'm available to help with coding or testing if needed.
[-]Introduce fully typed client[/-][+]Introduce fully typed Py client[/+][-]Introduce fully typed Py client[/-][+]Introduce fully typed Python API client[/+]docs: move fully typed clients into Features as the v3 headliner
docs: clean up unreleased changelog section for v3.0.0 (#742)