Sign inGet Started

Create a batch of email address lookups

POST
/v1/lookup/email/batch
const answer = await bird.lookup.emailBatch({
  emails: ["aisha.khan@example.com", "not-an-email"],
});
for (const item of answer.data) console.log(item.email, item.result);
响应200
{
  "data": [
    {
      "email": "aisha.khan@example.com",
      "valid": true,
      "result": "risky",
      "delivery_confidence": 42,
      "flags": [
        "role",
        "free_provider"
      ]
    }
  ]
}

Assesses up to 1,000 email addresses synchronously and returns one result per input in submission order. Malformed addresses receive individual assessments. Duplicate addresses remain separate entries and each answered entry is billed at the email lookup rate. Use Create an email address lookup for a single address. A batch consumes one request allowance under the shared lookup rate limit, regardless of its number of addresses.

Requests must fit within 128 KiB. Split larger lists into separate requests. Reuse an Idempotency-Key for retries of the same batch. Successful responses up to 256 KiB can be retained for replay; larger responses are returned but are not retained, so retrying can perform and charge for another batch. An unavailable lookup returns 503 without charging for the batch.

请求载荷

emails
array of string
必填

Addresses to assess in submission order. Surrounding whitespace is trimmed and case is preserved. Malformed addresses receive individual assessments. Duplicates are assessed and billed at each position. The request must also fit within the 128 KiB request-body limit.

响应载荷

data
array of object
必填

One assessment per submitted address, in submission order, including duplicates.

显示子属性