/bgptools/asns/whois

POST /api/bgptools/asns/whois

Price: 20 credits

Get the raw RIR whois record and AS-SET memberships for an Autonomous System

How to use it

Get the raw registry (RIR) whois record for an Autonomous System, its last-updated timestamp, and the AS-SETs it is a member of (with the IRR source each membership comes from). Use this when the structured AS profile is not enough and you need the verbatim whois text or the network's AS-SET memberships. Contact emails and phone numbers are not included. Accepts a bare AS number or an 'AS'-prefixed value.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• asn union required — Autonomous System Number whose whois record to fetch (bare number or 'AS'-prefixed) (examples: "3856", "AS3856", 13335)

Response

• @type string (default: "BgptoolsAsnWhois")
• asn integer required
• raw_whois string nullable
• updated_at string nullable
• as_sets array (default: [])
  • @type string (default: "BgptoolsAsSet")
  • source string nullable
  • name string required

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — Autonomous System Number not found Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.