masterr115 / hyst-api

Open-source project to consultation of Brazilian APIs, formatting in the best visual way, as well as a better search.

HystAPI

🇧🇷 Português

Project

Este projeto é baseado na consulta de API's brasileiras, formatando da melhor forma visual, bem como uma melhor busca.

---

🧪 Tecnologias usadas

• TypeScript & Node.js
• Axios
• Express
• API's governamentais

---

🚀 Começando

Clone o projeto e acesse a pasta

$ git clone https://github.com/Masterr115/hyst-api.git && cd hyst-api

Siga os passos abaixo:

# Instale as dependências
$ yarn install --production

# Gere o projeto
$ yarn build

# Inicie o projeto
$ yarn start

---

💻 Rotas (Get)

BASEURL: https://localhost:8080/v1

• /getStates : Procure todos os estados existentes em nosso território brasileiro
• /getCities?state=UF : Procure todas as cidades de um determinado estado

• Pode ser adicionado uma query na rota acima para uma pesquisa mais completa, /getCities?state=UF&complete=true

• /getStateInfo?state=UF : Procure todas as informações de um determinado estado brasileiro.

• /getCityInfo?city=Nome&state=UF& : Procure informações de uma determinada cidade brasileira.

• /getCEP?cep=CEP : Procure as informações de um determinado CEP.

• /geoIP?ip=IP : Procure informações através de um determinado IP.

• /getCnpjInfo?cpnj=CPNJ : Procure informações sobre determinado CNPJ. (Não válido para MEI).

• /packgeTracking?code=CODE : Procure informações de uma determinada encomenda nas maiores transportadoras do mercado.

🇺🇸 ENGLISH

Project

This project is based on the consultation of Brazilian API's, formatting in the best visual way, as well as a better search.

---

🧪 Tecnologies used

• TypeScript & Node.js
• Axios
• Express
• Government API's

---

🚀 Getting started

Clone the project and access the folder

$ git clone https://github.com/Masterr115/hyst-api.git && cd hyst-api

Follow the steps below

# Install the dependencies
$ yarn install --production

# Build project
$ yarn build

# Start the project
$ yarn start

---

💻 Routes (GET)

• /getStates : Search all the existing states in our Brazilian territory (Get)
• /getCities?state=UF : Search all cities in a given state

• A query can be added to the route above for a more complete search, /getCities?state=UF&complete=true

• /getStateInfo?state=UF : Search for all the information of a certain Brazilian state

• /getCityInfo?city=Name&state=UF& : Search for information about a specific Brazilian city

• /getCEP?cep=CEP : Search informations of determined CEP.

• /geoIP?ip=IP : Search for information through a given IP.

• /getCnpjInfo?cpnj=CPNJ : Look for information about a specific CNPJ. (Not valid for MEI)

• /packgeTracking?code=CODE : Search for information about a specific order on the largest carriers in the market

---

📝 License

This project is licensed under the MIT License. See the LICENSE file for details.

---

Made with 💜 by André Contiero 👋