README.md

API server based on cep-scraper.

API Reference

• Search postal code or address
• Get postal code
• Get address

Search

GET /api/v1/search

Input

• term: string search term

Response

Response

Object containing user data

Status codes:

• 200 Ok
• 400 Bad request

Response body:

• data [cep]

back to index

---