Buckets

​

When to use it

• You build a bucket picker for Storage ID Search.
• You show a readable name for the bucket of an Intelligence Search or Identity Portal record.
• You group or filter records by where they come from.

​

Request

curl https://api.orelys.io/v1/buckets

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

const { buckets } = await response.json();
const labels = new Map(buckets.map((bucket) => [bucket.value, bucket.label]));
console.log(labels.get("leaks.logs"));

import requests

response = requests.get("https://api.orelys.io/v1/buckets", timeout=30)
response.raise_for_status()
labels = {bucket["value"]: bucket["label"] for bucket in response.json()["buckets"]}

print(labels.get("leaks.logs"))

​

What you get back

{
  "buckets": [
    { "value": "leaks.private.general", "label": "Leaks » Private » General" },
    { "value": "leaks.logs", "label": "Leaks » Logs" },
    { "value": "pastes", "label": "Pastes" }
  ]
}

​

More precise buckets

​

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. The list rarely changes. Fetch it once and keep it, rather than before every search.
• Send the value, show the label. leaks.logs goes in the request; Leaks » Logs is for people.
• Do not check a record’s bucket against the twelve. A precise bucket such as leaks.private.comb is valid. Show a value you do not know as it is.
• The bucket is where, not what. It tells where a record is stored. The kind of file is a separate matter: Intelligence Search filters on it with media_type.

​

Reference