Search phone numbers

Find numbers you can buy, with their monthly price.

GEThttps://api.tried.com.au/search-phone-numbers

Needs keys Lists numbers available to buy from Telnyx (any country) or Twilio (the countries it sells). Pass a result's phone_number to Create phone number to buy that exact number. Real results need TELNYX_API_KEY or TWILIO_ACCOUNT_SID. Without them, mock mode returns generated numbers in the same shape, with features ["voice", "sms"].

Request#

Query parameter	Type	Required	Description
`country_code`	string	No	ISO 3166 country, two upper-case letters. Default `AU`.
`area_code`	integer	No	Area code to search in. Ignored for toll-free searches.
`toll_free`	boolean	No	Search toll-free numbers. The value is coerced to a boolean, so any non-empty value (including `false`) turns it on. Leave it out for local numbers.
`contains`	string	No	Digits the number must contain, up to 10 characters.
`limit`	integer	No	Results to return, 1 to 20. Default 5.
`number_provider`	string	No	`telnyx` or `twilio`. Default `telnyx`.

Example request#

curl "https://api.tried.com.au/search-phone-numbers?country_code=AU&area_code=3&limit=3" \
  -H "Authorization: Bearer $TRIED_API_KEY"

const params = new URLSearchParams({ country_code: "AU", area_code: "3", limit: "3" });
const res = await fetch(`https://api.tried.com.au/search-phone-numbers?${params}`, {
  headers: { Authorization: `Bearer ${process.env.TRIED_API_KEY}` },
});
const available = await res.json();

import os, requests

res = requests.get(
    "https://api.tried.com.au/search-phone-numbers",
    headers={"Authorization": f"Bearer {os.environ['TRIED_API_KEY']}"},
    params={"country_code": "AU", "area_code": 3, "limit": 3},
)
available = res.json()

Response#

200 OK

[
  { "phone_number": "+61355501842", "country_code": "AU", "toll_free": false, "monthly_price": 8, "features": ["voice", "sms"] },
  { "phone_number": "+61355507316", "country_code": "AU", "toll_free": false, "monthly_price": 8, "features": ["voice", "sms"] },
  { "phone_number": "+61355502059", "country_code": "AU", "toll_free": false, "monthly_price": 8, "features": ["voice", "sms"] }
]

Field	Type	Description
`phone_number`	string	The number in E.164.
`country_code`	string	The country you searched.
`toll_free`	boolean	Whether you searched toll-free numbers.
`monthly_price`	number	Monthly price in AUD. Telnyx results use Telnyx's monthly cost when it is given. Otherwise the Tried price list applies (for example AU 8, NZ 8, US and CA 3, GB 5; unlisted countries 9), plus 5 for toll-free.
`features`	string[]	Capabilities reported by the provider, for example `voice`, `sms`, `mms`.

Errors#

Status	When
`400`	A query parameter failed validation, for example `limit: Number must be less than or equal to 20`.
`401`	Missing or invalid API key.
`403`	The key's IP allowlist or scopes reject the request. This route needs the `numbers` scope.
`422`	The provider rejected the search. The message is the provider's error, for example `Unknown country XX` in mock mode.
`429`	Rate limit exceeded. See Rate limits.

See Errors for the body format.