Developer documentation
Build with the PORTIQA API.
Start with one authenticated request, then use the field reference and runnable examples to integrate portfolio evaluation into your product.
Endpoint and fields
API reference
Authentication, the POST /evaluate request contract, response fields, diagnostics, rate limits, and error codes.
Integration examples
Copyable cURL, Python, JavaScript, and PHP examples with safe environment-variable handling.
OpenAPI 3.1Machine-readable specification
Import the API contract into documentation generators, client tools, or your own test pipeline.
Postman collectionTest a request
Download a collection with base URL and API-key variables. It contains no credentials.
Recommended path
- Create an account and generate an API key from the dashboard.
- Run the minimal request in the examples.
- Read
engine_version, component scores, coverage, and diagnostics before presenting a verdict to users. - Handle authentication, validation, rate-limit, and server errors explicitly.
Questions about an integration can be sent to support@portiqa.com. Security reports belong at security@portiqa.com.