Search Numbers

The Search API allows you to find available phone numbers based on your criteria such as location, number pattern, and features.

Search Available Numbers

Search for available phone numbers by location code or pattern.

Endpoint

GET https://api.audian.com:8443/v2/numbers/search

Parameters

Parameter	Type	Required	Description
location	string	No	Location code (e.g., "US-CA-415") for area-based search
pattern	string	No	Pattern to match (e.g., "415*") for pattern-based search
features	array	No	Required features (e.g., ["sms", "mms"])
limit	integer	No	Maximum number of results (default: 10, max: 100)
offset	integer	No	Pagination offset (default: 0)

Request Example

curl -X GET 'https://api.audian.com:8443/v2/numbers/search?location=US-CA-415&limit=10' \
  -H 'X-Auth-Token: YOUR_API_KEY'

Response

{
  "success": true,
  "data": {
    "numbers": [
      {
        "number": "+14155551234",
        "location": "San Francisco, CA",
        "available": true,
        "price": {
          "monthly": 0.99,
          "setup": 0
        },
        "features": ["voice", "sms", "mms"]
      },
      {
        "number": "+14155551235",
        "location": "San Francisco, CA",
        "available": true,
        "price": {
          "monthly": 0.99,
          "setup": 0
        },
        "features": ["voice", "sms", "mms"]
      }
    ],
    "total": 50,
    "limit": 10,
    "offset": 0
  }
}

Response Fields

Field	Type	Description
number	string	Phone number in E.164 format
location	string	City and state/country of the number
available	boolean	Whether the number is available for purchase
price.monthly	number	Monthly rental cost
price.setup	number	One-time setup fee
features	array	Available features (voice, sms, mms, etc.)

Error Handling

If the search fails, you'll receive an error response:

{
  "success": false,
  "error": {
    "code": "INVALID_LOCATION",
    "message": "The specified location code is invalid"
  }
}

Best Practices

• Use pagination with limit and offset for large result sets
• Filter by features to find numbers with required capabilities
• Cache search results when possible to reduce API calls
• Use location codes for faster and more accurate results

Supported Locations

Audian supports phone numbers in:

• United States (US)
• Canada (CA)
• Select international regions

Contact support for availability in specific regions.