Skip to main content
Quick guide for using HyperX REST APIs.

​
REST API documentation endpoints

  • ReDoc: GET /reference
  • Swagger UI: GET /swagger

​
Step 1: Validate your project code

Use /v1/project/{projectCode} first to validate your project code. 
import requests

BASE_URL = "https://core.hyperx.dev"
PROJECT_CODE = "your-project-code"

resp = requests.get(f"{BASE_URL}/v1/project/{PROJECT_CODE}", timeout=10)
resp.raise_for_status()

print("projectCode:", resp.text)

​
Step 2: Move to feature guide

Use the guide below for public storage read APIs.

Public Storage

See lookup, hash, and download-url endpoints with Python examples.