Quickstart

Be on a plan with API access

The API comes with the Professional and Enterprise plans. Your current plan is on your account page; the plans are compared on the pricing page.

Get your key

Sign in on orelys.io and open orelys.io/account/api. Your key is created on your first visit, and shown masked: Reveal shows it, Copy copies it. It looks like orl_ followed by 32 characters.

Anyone who has your key can search with your quota. Keep it somewhere safe, such as a password manager or your server’s environment. If the page says the key is shown only this once, copy it straight away.

Store it in an environment variable

Keep the key out of your code:

export ORELYS_API_KEY="orl_…"

Check that it works

GET /v1/me returns your plan, quota and credits. It never takes a request or a credit.

curl https://api.orelys.io/v1/me \
  -H "Authorization: Bearer $ORELYS_API_KEY"

{
  "account": { "id": "3f0c9f7e-…", "plan": "Professional", "plan_expires_at": "2026-10-25T09:12:44.000Z" },
  "quota": { "limit": 500, "used": 0, "remaining": 500, "resets_at": "2026-09-26T00:00:00.000Z" },
  "credits": { "balance": 40 },
  "limits": { "requests_per_minute": 60, "concurrent_requests": 3, "ip_calls_per_minute": 120 },
  "modes": ["intelligent", "phonebook", "identity-portal", "uuid", "storage", "stealer-export"],
  "osint": ["username", "email"]
}

Run a search

curl https://api.orelys.io/v1/search/intelligent \
  -H "Authorization: Bearer $ORELYS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "query": "john@example.com", "max_results": 20 }'

import os
import requests

response = requests.post(
    "https://api.orelys.io/v1/search/intelligent",
    headers={"Authorization": f"Bearer {os.environ['ORELYS_API_KEY']}"},
    json={"query": "john@example.com", "max_results": 20},
    timeout=45,
)
response.raise_for_status()
data = response.json()

for record in data["results"]:
    print(record.get("date"), record.get("bucket"), record.get("name"))
print("Requests left today:", data["quota"]["remaining"])

const response = await fetch("https://api.orelys.io/v1/search/intelligent", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.ORELYS_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({ query: "john@example.com", max_results: 20 }),
});

const data = await response.json();
if (!response.ok) throw new Error(`${data.error.code}: ${data.error.message}`);

for (const record of data.results) console.log(record.date, record.bucket, record.name);
console.log("Requests left today:", data.quota.remaining);

Open a result

Each record has a system_id. Send it to UUID Search to read the file:

curl https://api.orelys.io/v1/search/uuid \
  -H "Authorization: Bearer $ORELYS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "system_id": "8b2c4e1a-7d3f-4c9b-a1e5-0f6d2c8b9a47" }' \
  -o file.txt

Search modes

What each mode takes and returns.

Errors

Every error code, and what to do about it.

Get started

Essentials

Searching

Next

Search modes

Errors

​Next

Search modes

Errors

Next