Bitcall logoBitcall API
HLR
Add your Key ID and Secret to send test requests.

List past jobs

GET
/v1/hlr/lookups/history

Returns your lookup jobs, newest first, filterable by category, status and date range.

Authorization

KeyId ApiSecret
x-key-id<token>

Your API key id.

In: header

x-api-secret<token>

Your API key secret.

In: header

Query Parameters

page?integer
pageSize?integer
category?string
status?string
from?string
to?string

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/hlr/lookups/history?page=1&pageSize=50&category=hlr&status=queued"
{
  "data": [
    {
      "jobId": "string",
      "status": "queued",
      "counts": {
        "input": 0,
        "processed": 0,
        "accepted": 0,
        "rejected": 0,
        "failed": 0
      },
      "actions": {
        "canCancel": true,
        "canExport": true
      },
      "lookupType": "string",
      "category": "string",
      "productCode": "string",
      "name": "string",
      "price": {
        "amount": 0,
        "currency": "string"
      },
      "startedAt": "string",
      "completedAt": "string",
      "createdAt": "string",
      "updatedAt": "string"
    }
  ],
  "meta": {
    "page": -9007199254740991,
    "pageSize": -9007199254740991,
    "total": -9007199254740991,
    "totalPages": -9007199254740991,
    "hasNext": true
  }
}
{
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "The request is not valid. See `fields` for what to correct.",
    "requestId": "9f1c7b2e-…"
  }
}
{
  "error": {
    "code": "AUTHENTICATION_REQUIRED",
    "message": "This endpoint requires an API key.",
    "requestId": "9f1c7b2e-…"
  }
}
{
  "error": {
    "code": "RATE_LIMITED",
    "message": "Too many requests. Retry after the interval in `Retry-After`.",
    "requestId": "9f1c7b2e-…"
  }
}
{
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "Something went wrong on our side.",
    "requestId": "9f1c7b2e-…"
  }
}
{
  "error": {
    "code": "SERVICE_RESPONSE_INVALID",
    "message": "The upstream service returned an unexpected response.",
    "requestId": "9f1c7b2e-…"
  }
}
{
  "error": {
    "code": "SERVICE_UNAVAILABLE",
    "message": "The service is temporarily unavailable. Try again shortly.",
    "requestId": "9f1c7b2e-…"
  }
}

List a job's results GET

Returns the per-number results of a job, paginated. Use exports for large completed jobs.

Cancel a job POST

Stops a queued or running job. Numbers not yet processed are not charged. Repeating this is safe. This operation is safe to repeat: repeating it returns the existing state and performs no further action.