API Overview

PQReady is the first API purpose-built for post-quantum cryptographic readiness assessment. Scan your endpoints, TLS certificates, configuration files, and source code repositories to identify quantum-vulnerable cryptographic algorithms (RSA, ECDSA, ECDH, classical Diffie-Hellman) before they become a threat.

NIST has finalized post-quantum cryptography standards (FIPS 203, 204, 205). Organizations that delay migration risk exposing sensitive data to harvest-now, decrypt-later attacks. PQReady gives you instant visibility into your cryptographic posture.

Key Capabilities

Endpoint Scan — Analyze TLS handshake, cipher suites, and key exchange algorithms on any public endpoint.
Certificate Scan — Inspect X.509 certificates for quantum-vulnerable signature and key algorithms.
Config Scan — Parse configuration files (nginx, Apache, OpenSSL, SSH) for weak cryptographic settings.
Repository Scan — Scan source code repositories for hardcoded cryptographic library usage and algorithm references.

Authentication

Authentication is handled automatically by RapidAPI. Include your RapidAPI key in the X-RapidAPI-Key header (this is done automatically when using the RapidAPI interface or generated code snippets). No additional API keys or account creation is required.

Endpoints

Health Check

GET /v1/health

Verify API availability. No authentication required.

curl --request GET \
  --url https://pqready.p.rapidapi.com/v1/health \
  --header 'X-RapidAPI-Host: pqready.p.rapidapi.com' \
  --header 'X-RapidAPI-Key: YOUR_API_KEY'

Response (200):

{
  "status": "healthy",
  "version": "1.0.0",
  "timestamp": "2026-02-07T12:00:00.000Z",
  "service": "PQReady API"
}

List Projects

GET /v1/project

Retrieve all projects for your account.

curl --request GET \
  --url https://pqready.p.rapidapi.com/v1/project \
  --header 'X-RapidAPI-Host: pqready.p.rapidapi.com' \
  --header 'X-RapidAPI-Key: YOUR_API_KEY'

Response (200):

{
  "projects": [
    {
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "user_id": "rapidapi:pqready.p.rapidapi.com",
      "name": "Production API",
      "description": "Main production infrastructure",
      "created_at": "2026-01-15T10:30:00.000Z"
    }
  ]
}

Create Project

POST /v1/project

Create a new project to organize your targets and scan results.

curl --request POST \
  --url https://pqready.p.rapidapi.com/v1/project \
  --header 'Content-Type: application/json' \
  --header 'X-RapidAPI-Host: pqready.p.rapidapi.com' \
  --header 'X-RapidAPI-Key: YOUR_API_KEY' \
  --data '{
    "name": "Production API",
    "description": "Scanning our production endpoints for PQ readiness"
  }'

Response (201):

{
  "project": {
    "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "user_id": "rapidapi:pqready.p.rapidapi.com",
    "name": "Production API",
    "description": "Scanning our production endpoints for PQ readiness",
    "created_at": "2026-02-07T12:00:00.000Z"
  }
}

Get Project Summary

GET /v1/project/{id}/summary

Get aggregated statistics for a project: readiness score, scan count, and findings breakdown by severity.

curl --request GET \
  --url https://pqready.p.rapidapi.com/v1/project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/summary \
  --header 'X-RapidAPI-Host: pqready.p.rapidapi.com' \
  --header 'X-RapidAPI-Key: YOUR_API_KEY'

Response (200):

{
  "project": {
    "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "name": "Production API",
    "description": "Main production infrastructure",
    "created_at": "2026-01-15T10:30:00.000Z"
  },
  "score": {
    "value": 72,
    "confidence": 0.85
  },
  "scansCount": 12,
  "findings": {
    "critical": 1,
    "high": 3,
    "medium": 5,
    "low": 8
  }
}

Get Project Findings

GET /v1/project/{id}/findings

List all findings for a project. Optionally filter by severity: low, medium, high, or critical.

curl --request GET \
  --url 'https://pqready.p.rapidapi.com/v1/project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/findings?severity=critical' \
  --header 'X-RapidAPI-Host: pqready.p.rapidapi.com' \
  --header 'X-RapidAPI-Key: YOUR_API_KEY'

Response (200):

{
  "findings": [
    {
      "id": "f1a2b3c4-d5e6-7890-abcd-ef1234567890",
      "scan_id": "s1a2b3c4-d5e6-7890-abcd-ef1234567890",
      "title": "RSA-2048 Key Exchange Detected",
      "description": "Server uses RSA-2048 for key exchange, which is vulnerable to Shor's algorithm on a cryptographically relevant quantum computer.",
      "severity": "critical",
      "category": "key_exchange",
      "recommendation": "Migrate to ML-KEM (FIPS 203) or hybrid X25519+ML-KEM-768 key exchange.",
      "created_at": "2026-02-01T08:15:00.000Z"
    }
  ]
}

Get Project Roadmap

GET /v1/project/{id}/roadmap

Retrieve the auto-generated post-quantum migration roadmap for a project, prioritized by risk.

curl --request GET \
  --url https://pqready.p.rapidapi.com/v1/project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/roadmap \
  --header 'X-RapidAPI-Host: pqready.p.rapidapi.com' \
  --header 'X-RapidAPI-Key: YOUR_API_KEY'

Response (200):

{
  "roadmap": [
    {
      "priority": "P0",
      "title": "Replace RSA key exchange with ML-KEM",
      "description": "Critical: RSA key exchange is directly vulnerable to quantum attack. Migrate to FIPS 203 ML-KEM-768.",
      "effort": "M",
      "owner": "Infrastructure Team"
    },
    {
      "priority": "P1",
      "title": "Upgrade TLS certificates to hybrid signatures",
      "description": "Replace ECDSA certificates with ML-DSA (FIPS 204) or hybrid certificates.",
      "effort": "S",
      "owner": "Security Team"
    }
  ]
}

Get Scan Details

GET /v1/scan/{id}

Retrieve detailed results from a specific scan, including all findings.

curl --request GET \
  --url https://pqready.p.rapidapi.com/v1/scan/s1a2b3c4-d5e6-7890-abcd-ef1234567890 \
  --header 'X-RapidAPI-Host: pqready.p.rapidapi.com' \
  --header 'X-RapidAPI-Key: YOUR_API_KEY'

Response (200):

{
  "scan": {
    "id": "s1a2b3c4-d5e6-7890-abcd-ef1234567890",
    "project_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "target_id": "t1a2b3c4-d5e6-7890-abcd-ef1234567890",
    "scan_type": "endpoint",
    "status": "completed",
    "created_at": "2026-02-01T08:00:00.000Z"
  },
  "findings": [
    {
      "id": "f1a2b3c4-d5e6-7890-abcd-ef1234567890",
      "scan_id": "s1a2b3c4-d5e6-7890-abcd-ef1234567890",
      "title": "RSA-2048 Key Exchange Detected",
      "severity": "critical",
      "category": "key_exchange",
      "recommendation": "Migrate to ML-KEM (FIPS 203)."
    }
  ]
}

Create Target

POST /v1/target

Add a scan target to a project. Supported types: endpoint, cert, config, repo.

curl --request POST \
  --url https://pqready.p.rapidapi.com/v1/target \
  --header 'Content-Type: application/json' \
  --header 'X-RapidAPI-Host: pqready.p.rapidapi.com' \
  --header 'X-RapidAPI-Key: YOUR_API_KEY' \
  --data '{
    "projectId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "type": "endpoint",
    "label": "Production API",
    "value": "api.example.com"
  }'

Response (201):

{
  "target": {
    "id": "t1a2b3c4-d5e6-7890-abcd-ef1234567890",
    "project_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "type": "endpoint",
    "label": "Production API",
    "value": "api.example.com",
    "created_at": "2026-02-07T12:00:00.000Z"
  }
}

Delete Target

DELETE /v1/target/{id}

Remove a target from a project.

curl --request DELETE \
  --url https://pqready.p.rapidapi.com/v1/target/t1a2b3c4-d5e6-7890-abcd-ef1234567890 \
  --header 'X-RapidAPI-Host: pqready.p.rapidapi.com' \
  --header 'X-RapidAPI-Key: YOUR_API_KEY'

Response (200):

{
  "deleted": true
}

Get Usage

GET /v1/usage

Check your current API usage and rate limit status.

curl --request GET \
  --url https://pqready.p.rapidapi.com/v1/usage \
  --header 'X-RapidAPI-Host: pqready.p.rapidapi.com' \
  --header 'X-RapidAPI-Key: YOUR_API_KEY'

Response (200):

{
  "tier": "free",
  "usage": {
    "daily": 3,
    "monthly": 47
  },
  "limits": {
    "daily": 10,
    "monthly": 100
  },
  "allowedScans": ["endpoint"]
}

Subscription Tiers

Feature	Free	Pro ($49/mo)	Business ($199/mo)	Enterprise ($499/mo)
Daily Scan Limit	10	50	200	1,000
Monthly Scan Limit	100	200	2,000	100,000
Endpoint Scan	Yes	Yes	Yes	Yes
Certificate Scan	No	Yes	Yes	Yes
Config Scan	No	Yes	Yes	Yes
Repository Scan	No	No	Yes	Yes
Projects	1	5	25	Unlimited
Data Retention	7 days	30 days	90 days	Custom
Support	Community	Email	Priority	Dedicated
SSO	No	No	No	Yes
Audit Logs	No	No	No	Yes

Rate Limiting

Rate limits are enforced per account on a daily and monthly basis. When you exceed your limit, the API returns a 429 status code:

{
  "error": "Rate limit exceeded"
}

Use the GET /v1/usage endpoint to monitor your current consumption. Rate limits reset daily at midnight UTC and monthly on the 1st.

Error Codes

Status Code	Meaning	Example Response
`400`	Bad Request — Missing or invalid parameters	`{"error": "Name is required"}`
`401`	Unauthorized — Invalid or missing API key	`{"error": "Unauthorized"}`
`404`	Not Found — Resource does not exist or you lack access	`{"error": "Project not found"}`
`429`	Rate Limited — Daily or monthly limit exceeded	`{"error": "Rate limit exceeded"}`
`500`	Internal Server Error — Something went wrong on our end	`{"error": "Internal server error"}`

Scan Types Explained

Type	Target Value	What It Checks
`endpoint`	Hostname or URL (e.g., `api.example.com`)	TLS handshake, cipher suites, key exchange algorithms, protocol versions
`cert`	Hostname (e.g., `example.com`)	X.509 certificate chain: signature algorithms, public key types, key sizes
`config`	Configuration content (pasted or uploaded)	Server configs (nginx, Apache, OpenSSL, SSH) for weak cipher/algorithm settings
`repo`	Repository URL (e.g., `https://github.com/org/repo`)	Source code for hardcoded cryptographic libraries, algorithm references, and key generation patterns

Typical Workflow

Create a Project — POST /v1/project
Add Targets — POST /v1/target with your endpoints, certs, configs, or repos
Run Scans — Scans execute automatically when targets are added (or triggered via the dashboard)
Review Findings — GET /v1/project/{id}/findings to see vulnerabilities
Check Score — GET /v1/project/{id}/summary for your PQ readiness score (0-100)
Follow Roadmap — GET /v1/project/{id}/roadmap for prioritized migration steps
Monitor Usage — GET /v1/usage to track your API consumption

Finding Severities

Critical — Immediately exploitable by a quantum computer (e.g., RSA/ECDSA key exchange in production).
High — Significant quantum vulnerability requiring near-term remediation.
Medium — Quantum-vulnerable algorithm in use but with mitigating factors.
Low — Minor configuration improvement or informational finding.

Support

For API support, contact us at pqready@fastmail.com or visit pqready.dev/contact.

For billing and subscription questions, please use RapidAPI's built-in support system.