Outscraper API Docs

/phones-enricher

Returns phone carrier data (name/type), validates phones and ensures messages deliverability.

Phone Related
↗ Open in API Explorer
GET

Phone Numbers Enricher

Phone Related

Returns phone carrier data (name/type), validates phones and ensures messages deliverability.

Request

Endpoint: GET https://api.outscraper.cloud/phones-enricher

Parameters

NameInTypeRequiredDescriptionExampleConstraints
query query array<string> Yes Phone number (e.g., +1 281 236 8208). It supports batching by sending arrays with up to 1000 queries (e.g., query=text1&query=text2&query=text3). It allows multiple queries to be sent in one request and to save on network latency time. - -

Responses

200

application/json

The response contains the status of the request and data. Data is an array where each element represents a response for a single query from the request.

{
  "id": "your-request-id",
  "status": "Success",
  "data": [
    {
      "query": "12812368208",
      "carrier_name": "AERIAL COMMUNICATIONS",
      "carrier_type": "mobile"
    }
  ]
}

202

application/json

The response contains a request ID that can be used to fetch results by using Request Results endpoint. Each response is available for 4 hours after a request has been completed.

{
  "id": "your-request-id",
  "status": "Pending",
  "results_location": "https://api.outscraper.cloud/requests/your-request-id"
}

401

application/json

Wrong or missing API Key (token).

{
  "error": true,
  "errorMessage": "401 Unauthorized: The server could not verify that you are authorized to access the URL requested. You either supplied the wrong credentials (e.g. a bad password), or your browser doesn't understand how to supply the credentials required."
}

402

application/json

Past due invoices or a payment method not connected.

{
  "error": true,
  "errorMessage": "Please close past due invoices or verify your card information is correct."
}

422

application/json

Wrong query url parameters.

{
  "error": true,
  "errorMessage": "422 Unprocessable Entity: The request was well-formed but was unable to be followed due to semantic errors."
}

Code Samples

cURL

curl -X GET "https://api.outscraper.cloud/phones-enricher?query=12812368208" -H  "X-API-KEY: YOUR-API-KEY"

Python

from outscraper import OutscraperClient

api_client = OutscraperClient(api_key='YOUR-API-KEY')
results = api_client.phones_enricher(['12812368208'])

Node.js

const Outscraper = require('outscraper');

let client = new Outscraper('YOUR-API-KEY');
client.phonesEnricher(['12812368208']).then(response => {
   console.log(response);
});

Related Endpoints