Brasilapi.RegistroBr.API (BrasilAPI v1.0.2)

Copy Markdown View Source

Client for BrasilAPI RegistroBR endpoints.

Provides functions to fetch information about Brazilian domain registrations (.br) from the official registro.br system.

Summary

Functions

Fetches information about a Brazilian domain (.br) including its status, hosts, expiration date, and alternative domain suggestions.

Functions

get_domain_info(domain)

@spec get_domain_info(String.t()) ::
  {:ok, Brasilapi.RegistroBr.Domain.t()} | {:error, map()}

Fetches information about a Brazilian domain (.br) including its status, hosts, expiration date, and alternative domain suggestions.

Parameters

  • domain - The domain name to check (string)

Examples

iex> Brasilapi.RegistroBr.API.get_domain_info("brasilapi.com.br")
{:ok, %Brasilapi.RegistroBr.Domain{status_code: 2, status: "REGISTERED", fqdn: "brasilapi.com.br"}}

iex> Brasilapi.RegistroBr.API.get_domain_info("nonexistentdomain.com.br")
{:error, %{status: 400, message: "Bad request"}}

API Reference

https://brasilapi.com.br/docs#tag/REGISTRO-BR/paths/~1registrobr~1v1~1%7Bdomain%7D/get