# Phone Number Lookup

GET https://YOUR_SPACE.signalwire.com/api/relay/rest/lookup/phone_number/{e164_number}

This endpoint allows you to look up validity and formatting
information about a number. You can optionally lookup additional
information about the number such as carrier and caller ID data.

#### Permissions

No API token scope is required to make a successful request to this endpoint.

[Learn more about API scopes](/docs/platform/your-signalwire-api-space).

Reference: https://signalwire.com/docs/apis/relay-rest/phone-number-lookup/lookup-phone-number

## OpenAPI Specification

```yaml
openapi: 3.1.0
info:
  title: relay-rest
  version: 1.0.0
paths:
  /lookup/phone_number/{e164_number}:
    get:
      operationId: lookup-phone-number
      summary: Phone Number Lookup
      description: >-
        This endpoint allows you to look up validity and formatting

        information about a number. You can optionally lookup additional

        information about the number such as carrier and caller ID data.


        #### Permissions


        No API token scope is required to make a successful request to this
        endpoint.


        [Learn more about API scopes](/docs/platform/your-signalwire-api-space).
      tags:
        - subpackage_phoneNumberLookup
      parameters:
        - name: e164_number
          in: path
          description: The phone number in E.164 format.
          required: true
          schema:
            type: string
        - name: include
          in: query
          description: >-
            Further number information to include in the response, some of which
            are billable. You can specify: carrier (Lookup full carrier
            information for the number), cnam (Lookup Caller ID information for
            the number). Separate multiple values with a comma:
            include=carrier,cnam.
          required: false
          schema:
            type: string
        - name: Authorization
          in: header
          description: >-
            SignalWire Basic Authentication using Project ID and API Token.


            The client sends HTTP requests with the Authorization header
            containing

            the word Basic followed by a space and a base64-encoded string of
            project_id:token.

            The project ID will be used as the username and the API token as the
            password.


            Example:

            ```

            Authorization: Basic base64(project_id:token)

            ```
          required: true
          schema:
            type: string
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PhoneNumberLookupResponse'
        '401':
          description: Access is unauthorized.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Types.StatusCodes.StatusCode401'
        '404':
          description: The server cannot find the requested resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Types.StatusCodes.StatusCode404'
        '500':
          description: An internal server error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Types.StatusCodes.StatusCode500'
servers:
  - url: https://YOUR_SPACE.signalwire.com/api/relay/rest
components:
  schemas:
    CarrierLookupInfo:
      type: object
      properties:
        lrn:
          type: string
          description: The LRN associated with the number.
        spid:
          type: string
          description: The Service Profile Identifier associated with the number.
        ocn:
          type: string
          description: The Operating Company Number associated with the number.
        lata:
          type: string
          description: >-
            The Local Access and Transport Area number associated with the
            number.
        city:
          type: string
          description: The City associated with the number.
        state:
          type: string
          description: The State/Province/Region associated with the number.
        jurisdiction:
          type: string
          description: The Jurisdiction associated with the number.
        lec:
          type: string
          description: The LEC or Carrier of the number.
        linetype:
          type: string
          description: >-
            The type of line the number is. Generally either wireless or
            landline.
      description: Carrier lookup information.
      title: CarrierLookupInfo
    CnamInfo:
      type: object
      properties:
        caller_id:
          type: string
          description: The caller ID associated with the number.
      description: Caller ID (CNAM) information.
      title: CnamInfo
    PhoneNumberLookupResponse:
      type: object
      properties:
        country_code_number:
          type: integer
          description: The Country code associated with the number.
        national_number:
          type: string
          description: Number in the countries national format.
        possible_number:
          type: boolean
          description: Whether the number supplied is a possible number.
        valid_number:
          type: boolean
          description: Whether the number supplied is a valid number.
        national_number_formatted:
          type: string
          description: The E164 number formatted in national format.
        international_number_formatted:
          type: string
          description: The E164 number formatted in international format.
        e164:
          type: string
          description: The number in E164 format.
        location:
          type: string
          description: The location of the number based on its area code and NPA.
        country_code:
          type: string
          description: The ISO3166 alpha 2 country code associated with the number.
        timezones:
          type: array
          items:
            type: string
          description: The time zones associated with the number.
        number_type:
          type: string
          description: The type of number based on its area code and NPA.
        carrier:
          $ref: '#/components/schemas/CarrierLookupInfo'
          description: >-
            Carrier information. Adding include=carrier to your request will do
            a live lookup to determine the current carrier information about
            this number.
        cnam:
          $ref: '#/components/schemas/CnamInfo'
          description: >-
            Caller ID information. Adding include=cnam to your request will do a
            live lookup to determine the current caller ID information about
            this number.
      description: Response containing phone number lookup result.
      title: PhoneNumberLookupResponse
    TypesStatusCodesStatusCode401Error:
      type: string
      enum:
        - Unauthorized
      title: TypesStatusCodesStatusCode401Error
    Types.StatusCodes.StatusCode401:
      type: object
      properties:
        error:
          $ref: '#/components/schemas/TypesStatusCodesStatusCode401Error'
      required:
        - error
      description: Access is unauthorized.
      title: Types.StatusCodes.StatusCode401
    TypesStatusCodesStatusCode404Error:
      type: string
      enum:
        - Not Found
      title: TypesStatusCodesStatusCode404Error
    Types.StatusCodes.StatusCode404:
      type: object
      properties:
        error:
          $ref: '#/components/schemas/TypesStatusCodesStatusCode404Error'
      required:
        - error
      description: The server cannot find the requested resource.
      title: Types.StatusCodes.StatusCode404
    TypesStatusCodesStatusCode500Error:
      type: string
      enum:
        - Internal Server Error
      title: TypesStatusCodesStatusCode500Error
    Types.StatusCodes.StatusCode500:
      type: object
      properties:
        error:
          $ref: '#/components/schemas/TypesStatusCodesStatusCode500Error'
      required:
        - error
      description: An internal server error occurred.
      title: Types.StatusCodes.StatusCode500
  securitySchemes:
    SignalWireBasicAuth:
      type: http
      scheme: basic
      description: >-
        SignalWire Basic Authentication using Project ID and API Token.


        The client sends HTTP requests with the Authorization header containing

        the word Basic followed by a space and a base64-encoded string of
        project_id:token.

        The project ID will be used as the username and the API token as the
        password.


        Example:

        ```

        Authorization: Basic base64(project_id:token)

        ```

```

## SDK Code Examples

```python
import requests

url = "https://your_space.signalwire.com/api/relay/rest/lookup/phone_number/e164_number"

headers = {"Authorization": "Basic <project_id>:<api_token>"}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript
const url = 'https://your_space.signalwire.com/api/relay/rest/lookup/phone_number/e164_number';
const options = {method: 'GET', headers: {Authorization: 'Basic <project_id>:<api_token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://your_space.signalwire.com/api/relay/rest/lookup/phone_number/e164_number"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Basic <project_id>:<api_token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://your_space.signalwire.com/api/relay/rest/lookup/phone_number/e164_number")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <project_id>:<api_token>'

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://your_space.signalwire.com/api/relay/rest/lookup/phone_number/e164_number")
  .header("Authorization", "Basic <project_id>:<api_token>")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://your_space.signalwire.com/api/relay/rest/lookup/phone_number/e164_number', [
  'headers' => [
    'Authorization' => 'Basic <project_id>:<api_token>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://your_space.signalwire.com/api/relay/rest/lookup/phone_number/e164_number");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Basic <project_id>:<api_token>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["Authorization": "Basic <project_id>:<api_token>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://your_space.signalwire.com/api/relay/rest/lookup/phone_number/e164_number")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```