# `Brasilapi.Ddd.API`
[🔗](https://github.com/stlucasgarcia/brasilapi-ex/blob/main/lib/brasilapi/ddd/api.ex#L1)

Client for BrasilAPI DDD endpoints.

Provides functions to fetch information about Brazilian area codes (DDD)
including the state and cities that use the specified area code.

# `get_by_ddd`

```elixir
@spec get_by_ddd(String.t() | integer()) ::
  {:ok, Brasilapi.Ddd.Info.t()} | {:error, map()}
```

Fetches information about a DDD (area code).

DDD means "Discagem Direta à Distância" (Direct Distance Dialing). It's an
automatic telephone connection system between different national urban areas.
The DDD is a 2-digit code that identifies the main cities in the country.

## Parameters

  * `ddd` - The DDD (area code) as string or integer. Must be 2 digits.

## Examples

    iex> Brasilapi.Ddd.API.get_by_ddd(11)
    {:ok, %Brasilapi.Ddd.Info{
      state: "SP",
      cities: ["EMBU", "VÁRZEA PAULISTA", "SÃO PAULO"]
    }}

    iex> Brasilapi.Ddd.API.get_by_ddd(99)
    {:error, %{status: 404, message: "DDD não encontrado"}}

## API Reference
  https://brasilapi.com.br/docs#tag/DDD/paths/~1ddd~1v1~1%7Bddd%7D/get

---

*Consult [api-reference.md](api-reference.md) for complete listing*