API Reference

Interact with the Hacken Extractor REST API to manage projects, contracts, detectors, triggers, and alerts programmatically from your own services.

Base URL

https://extractor.hacken.dev

Authentication

All requests require a Bearer token in the Authorization header.

Authorization: Bearer <your-api-key>

Generate your API key from the Hacken Extractor dashboard under Settings → API Keys.

Response format

All endpoints return JSON. Successful responses use HTTP 200; errors return a non-2xx status with a descriptive body.

Success

{
  "id": 1,
  "name": "My Project",
  "networkStatus": "MAINNET"
}

Error

{
  "statusCode": 400,
  "message": "Validation failed",
  "errors": ["name must not be empty"]
}

Pagination

Search and aggregation endpoints accept from and size for cursor-style pagination.

Parameter	Type	Default	Description
from	integer	0	Starting document offset
size	integer	10	Number of results to return

Endpoints

Create Project

POST /api/v1/project

Get Project

GET /api/v1/project/{id}

Create Contract

POST /api/v1/contract

Get Contract

GET /api/v1/contract/{id}

Search Alerts

POST /api/v1/detector/alert/search

Aggregate Alerts

POST /api/v1/detector/alert/aggregation