OSINT sources

​

When to use it

• You show your users which platforms a search checks.
• You turn the source of a search result into a label and a site.
• You decide whether the extended sources of a username or email search are worth 3 more credits.
• You read the cost of a search from the API rather than hard-coding it.

​

Request

curl https://api.orelys.io/v1/osint/sources

const response = await fetch("https://api.orelys.io/v1/osint/sources", {
  signal: AbortSignal.timeout(30_000),
});
if (!response.ok) throw new Error(`HTTP ${response.status}`);

const { modules } = await response.json();
for (const [name, module] of Object.entries(modules)) {
  if (module.cost.extended === undefined) {
    console.log(`${name}: ${module.count} sources, cost ${module.cost.standard}`);
    continue;
  }
  const extended = module.sources.filter((source) => source.extended).length;
  console.log(`${name}: ${module.count} sources, ${extended} extended, cost ${module.cost.standard} or ${module.cost.extended}`);
}

import requests

response = requests.get("https://api.orelys.io/v1/osint/sources", timeout=30)
response.raise_for_status()
modules = response.json()["modules"]

for name, module in modules.items():
    extended = [source["label"] for source in module["sources"] if source.get("extended")]
    print(f"{name}: {module['count']} sources, extended: {', '.join(extended) or 'none'}")

​

What you get back

{
  "modules": {
    "username": {
      "cost": { "standard": 1, "extended": 4 },
      "count": 328,
      "sources": [
        { "id": "github", "label": "GitHub", "site": "github.com", "extended": true },
        { "id": "reddit", "label": "Reddit", "site": "reddit.com", "extended": false },
        { "id": "steam", "label": "Steam", "site": "steamcommunity.com", "extended": false }
      ]
    },
    "email": {
      "cost": { "standard": 1, "extended": 4 },
      "count": 52,
      "sources": [
        { "id": "gravatar", "label": "Gravatar", "site": "gravatar.com", "extended": false },
        { "id": "google", "label": "Google", "site": "google.com", "extended": true }
      ]
    },
    "domain": {
      "cost": { "standard": 1 },
      "count": 11,
      "sources": [
        { "id": "whois", "label": "WHOIS", "site": "icann.org" },
        { "id": "dns", "label": "DNS records", "site": "cloudflare.com" }
      ]
    }
  }
}

​

Standard and extended sources

​

Cost and limits

• Free: no key, no credits, nothing taken from your daily quota.
• Per address: it counts in the 120 calls a minute allowed from one address. Over that, 429 ip_rate_limited: wait Retry-After seconds.
• Browsers: call it from your server or a script. Web pages on other sites cannot call the API directly.

​

Errors

​

Tips

• Cache it. It changes only when sources are added or retired. Fetch it once a day rather than before every search.
• Ids belong to a module. github is in the Username and Email modules, whois and dns in the Domain and IP modules, each time with different data: look a result’s source up in the module of its search.
• Listed does not mean up. The catalogue lists every source the API runs. A source that is down for a while stays listed, and shows in a search’s sources.failed.
• Read the cost from here. cost.standard and, for Username and Email, cost.extended are the prices a search charges, the same as cost in a search answer.
• Only sources the API asks are listed. The API has no Telegram lookup, and the catalogue has no Telegram source.

​

Reference