/rdap/entities

POST /api/rdap/entities

Price: 1 credit

Look up registration data for a registry entity (contact) by its handle via RDAP

How to use it

Look up a registry entity (a contact / organization record) by its handle. Entities are the people and organizations behind domains, IP networks and ASNs — registrars, registrants, abuse / administrative / technical contacts. Returns the entity's roles, status, normalized contact details (name, organization, email, phone, address), its IANA registrar id if it is a registrar, registration / last-changed dates, and any nested entities. The handle is registry-specific (e.g. 'ABUSE5250-ARIN' for ARIN, 'RAR939-FRNIC' for AFNIC); it is usually obtained from a domain, IP or ASN lookup.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• entity string required — Registry entity handle to look up (examples: "ABUSE5250-ARIN", "ZG39-ARIN", "RAR939-FRNIC"; minLength: 1)

Response

• @type string (default: "RdapEntityDetail")
• handle string nullable
• roles array (default: [])
• status array (default: [])
• contact object nullable — Normalized contact extracted from an RDAP entity's jCard (RFC 7095). The upstream `vcardArray` is a POSITIONAL array, NOT a key/value object: ["vcard", [["fn", {}, "text", "Name"], ["email", {}, "text", "a@b.c"], ...]] Each property is a 4-element array [name, params, value_type, value]. Because the format is positional (index 0 = property name, index 3 = value), mg/mgo (which navigate dict keys / treat numeric path segments as list indices) cannot address it cleanly — so the jCard walker below uses direct positional indexing with explicit length guards. This is the only place direct indexing is allowed.
  • @type string (default: "RdapVcard")
  • name string nullable
  • org string nullable
  • email string nullable
  • phone string nullable
  • address string nullable
  • kind string nullable
• registrar_id string nullable
• registered_at string nullable
• updated_at string nullable
• entities array (default: [])
  • @type string (default: "RdapEntity")
  • handle string nullable
  • roles array (default: [])
  • contact object nullable — Normalized contact extracted from an RDAP entity's jCard (RFC 7095). The upstream `vcardArray` is a POSITIONAL array, NOT a key/value object: ["vcard", [["fn", {}, "text", "Name"], ["email", {}, "text", "a@b.c"], ...]] Each property is a 4-element array [name, params, value_type, value]. Because the format is positional (index 0 = property name, index 3 = value), mg/mgo (which navigate dict keys / treat numeric path segments as list indices) cannot address it cleanly — so the jCard walker below uses direct positional indexing with explicit length guards. This is the only place direct indexing is allowed.
    • @type string (default: "RdapVcard")
    • name string nullable
    • org string nullable
    • email string nullable
    • phone string nullable
    • address string nullable
    • kind string nullable
  • registrar_id string nullable

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 — Entity 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.