Lookup

Carrier Lookup

<a class="try-sandbox-link" href="https://sandbox.textmagic.com/#/Lookup/doCarrierLookup" target="_blank">Try in sandbox</a><br>This API call allows you to retrieve additional information about a phone number: region-specific phone number formatting, carrier, phone type (landline/mobile) and country information.

Numbers must be checked one by one. You cannot check multiple numbers in one request.

get/api/v2/lookups/{phone}

Request

Base URL
https://rest.textmagic.com
Auth
HTTP basic
TypeScript
https://skmtc.dev/textmagic/apis/textmagic-api/docs/api/v2/lookups/:phone/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

phonestring required

Phone number in E.164 format or in National format.

Query parameters

countrystring

This option must be specified only if the phone number is in a National format.

Response

Returned when successful.

costnumber required

The cost to check that one number is constant – 0.04 in your account currency.

localstring required

Phone number in National format.

type'mobile' | 'landline' | 'voip' required

Phone number type.

carrierstring required

Carrier name.

number164string required

Phone number in E.164 format.

validboolean required

This field shows whether the entered phone number is valid or not.

Example response

{
  "cost": 0.04,
  "country": {
    "id": "US",
    "name": "India"
  },
  "local": "07860",
  "type": "mobile",
  "carrier": "Telefonica UK",
  "number164": "447860021130",
  "valid": true
}

Changes

No recorded changes to this operation across all 4 revisions of this API.