API Reference BrasilAPI v#0.1.5

View Source

Modules

A simple Elixir client for BrasilAPI.

Banks domain module for BrasilAPI.

Client for BrasilAPI Banks endpoints.

Represents a Brazilian bank with its identifying information.

Brokers (Brokerage Firms) module for BrasilAPI.

Client for BrasilAPI Brokers (Brokerage Firms) endpoints.

Represents a CVM-registered brokerage firm with complete registration information.

Cep domain module for BrasilAPI.

Client for BrasilAPI CEP endpoints.

Struct representing address data from BrasilAPI CEP v2.

HTTP client for BrasilAPI endpoints.

CNPJ domain module for BrasilAPI.

Client for BrasilAPI CNPJ endpoints.

Represents a company data structure from the CNPJ API.

Configuration module for BrasilAPI client.

DDD domain module for BrasilAPI.

Client for BrasilAPI DDD endpoints.

Struct representing DDD information from BrasilAPI DDD v1.

Exchange Rate module for BrasilAPI.

Client for BrasilAPI Exchange Rate endpoints.

Represents a currency available for exchange rate queries.

Represents daily exchange rate information for a specific currency and date.

Represents a single exchange rate quotation with buy/sell rates and metadata.

Feriados domain module for BrasilAPI.

Client for BrasilAPI Feriados endpoints.

Struct representing a national holiday.

ISBN (International Standard Book Number) module for BrasilAPI.

Client for BrasilAPI ISBN endpoints.

Represents a book with complete information from ISBN lookup.

Represents book dimensions with width, height, and measurement unit.

PIX domain module for BrasilAPI.

Client for BrasilAPI PIX endpoints.

Represents a PIX participant with their information from the Brazilian instant payment system.

Rates domain module for BrasilAPI.

Client for BrasilAPI Rates endpoints.

Represents a Brazilian tax rate or official index with its value.

RegistroBR domain module for BrasilAPI.

Client for BrasilAPI RegistroBR endpoints.

Represents a Brazilian domain (.br) with its registration information.

Utilities for CNPJ (Cadastro Nacional da Pessoa Jurídica) handling.

Utilities for ISBN (International Standard Book Number) handling.