# Search available numbers

Source: https://joinsimplesms.com/docs/api/numbers/search-available
Index: https://joinsimplesms.com/llms.txt

`GET /v1/numbers/available`

Send your API key as a bearer token: `Authorization: Bearer ssms_sk_...`. Test keys run this endpoint against the [sandbox](/docs/sandbox); see [Authentication](/docs/authentication) for key modes and scopes.

## Query parameters

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `area_code` | string | No | Example: `415`. |

## Responses

| Status | Meaning | Body |
| --- | --- | --- |
| 200 | Available numbers | Page of `AvailableNumber` |
| 401 | Missing, malformed, or revoked API key | `Error` |
| 402 | Billable live calls only: the prepaid credit balance cannot cover the call (insufficient_credits); nothing was done or charged | `Error` |
| 429 | Rate limit or quota exceeded | `Error` |

### 200: each item in `data` (AvailableNumber)

The body is a page: `data` (the array), `has_more`, and `next_cursor` (null on the last page).

| Field | Type | Description |
| --- | --- | --- |
| `object` | `available_number` |  |
| `phone_number` | string |  |
| `locality` | string |  |
| `region` | string |  |

## Errors

| Status | When |
| --- | --- |
| 401 | Missing, malformed, or revoked API key |
| 402 | Billable live calls only: the prepaid credit balance cannot cover the call (insufficient_credits); nothing was done or charged |
| 429 | Rate limit or quota exceeded |

Every error has the same JSON shape, and `request_id` matches the `X-Request-Id` response header. [Errors](/docs/errors) lists every code and what to do about it.

```json
{
  "error": {
    "code": "invalid_request",
    "message": "What went wrong, in plain words.",
    "param": "the_field",
    "request_id": "req_a1B2c3D4e5F6g7H8"
  }
}
```

## Examples

### curl

```bash
curl -X GET "https://api.joinsimplesms.com/v1/numbers/available" \
  -H "Authorization: Bearer $SIMPLESMS_API_KEY"
```

### Node.js

```javascript
import { SimpleSMS } from 'joinsimplesms'; // npm install joinsimplesms

const sms = new SimpleSMS(process.env.SIMPLESMS_API_KEY);

const available = await sms.numbers.available({ areaCode: '415' });

console.log(available.data.map((n) => n.phone_number));
```

### Python

```python
import os
from joinsimplesms import SimpleSMS  # pip install joinsimplesms

client = SimpleSMS(os.environ["SIMPLESMS_API_KEY"])

available = client.numbers.available(area_code="415")

print([n["phone_number"] for n in available["data"]])
```

## Related

- Guide: [Numbers](/docs/numbers)
- [All numbers endpoints](/docs/api#numbers)
- [API reference](/docs/api)