PORTIQA
Log in Get API key
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.

 Runnable requests

Integration examples

Copyable cURL, Python, JavaScript, and PHP examples with safe environment-variable handling.

 OpenAPI 3.1

Machine-readable specification

Import the API contract into documentation generators, client tools, or your own test pipeline.

 Postman collection

Test a request

Download a collection with base URL and API-key variables. It contains no credentials.

 Python SDK · PyPI

pip install portiqa

Dependency-free, typed Python client for Python 3.9 and newer. Source on GitHub.

 JavaScript / TypeScript SDK · npm

npm install @portiqa/sdk

Typed server-side client for Node.js 18 and newer. Keep the API key on your server.

 Open source

PORTIQA on GitHub

SDK source code, runnable examples, the OpenAPI file and the Postman collection, with changelogs and issue tracking.

Install an SDK

pip install portiqa
npm install @portiqa/sdk

Both SDKs call POST https://portiqa.ai/evaluate and contain no scoring logic. Source: portiqa-python and portiqa-js. More examples: portiqa-api-examples.

Recommended path

  1. Create an account and generate an API key from the dashboard.
  2. Install the Python or JavaScript SDK, or run the minimal request in the examples.
  3. Read engine_version, component scores, coverage, and diagnostics before presenting a verdict to users.
  4. 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.