{"info":{"_postman_id":"c7834746-a31b-4c87-b916-245fe34896c9","name":"ViaCep","description":"

Introduction

What does your API do?

Consulta Códigos de Endereçamento Postal (CEP) do Brasil

Overview

Things that the developers should know about

Para acessar o webservice, um CEP no formato de {8} dígitos deve ser fornecido, por exemplo: \"01001000\". \nApós o CEP, deve ser fornecido o tipo de retorno desejado, que deve ser \"json\", \"xml\", \"piped\" ou \"querty\".

Exemplo de pesquisa por CEP: \nviacep.com.br/ws/01001000/json/

Authentication

What is the preferred way of using the API?

Não

Error Codes

What errors and status codes can a user expect?

Quando consultado um CEP de formato inválido, por exemplo: \"950100100\" (9 dígitos), \"95010A10\" (alfanumérico), \"95010 10\" (espaço), o código de retorno da consulta será um 400 (Bad Request). Antes de acessar o webservice, valide o formato do CEP e certifique-se que o mesmo possua {8} dígitos. Exemplo de como validar o formato do CEP em javascript está disponível nos exemplos abaixo.

Quando consultado um CEP de formato válido, porém inexistente, por exemplo: \"99999999\", o retorno conterá um valor de \"erro\" igual a \"true\". Isso significa que o CEP consultado não foi encontrado na base de dados.

Rate limit

Is there a limit to the number of requests an user can send?

Não

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Introduction","slug":"introduction"},{"content":"Overview","slug":"overview"},{"content":"Authentication","slug":"authentication"},{"content":"Error Codes","slug":"error-codes"},{"content":"Rate limit","slug":"rate-limit"}],"owner":"8961871","collectionId":"c7834746-a31b-4c87-b916-245fe34896c9","publishedId":"SVn3svAh","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2019-09-29T15:28:42.000Z"},"item":[{"name":"viacep.com.br/ws/:cep/json/","id":"d3fb21be-b384-47fb-bd6c-ac479ab41627","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"viacep.com.br/ws/:cep/json/","description":"

Consulta Códigos de Endereçamento Postal (CEP) do Brasil, path variables com retorno JSON

\n","urlObject":{"path":["ws",":cep","json",""],"host":["viacep","com","br"],"query":[],"variable":[{"type":"string","value":"01001000","key":"cep"}]}},"response":[{"id":"c6171393-9a35-4885-a5ff-0bf3a459bf62","name":"viacep.com.br/ws/:cep/json/","originalRequest":{"method":"GET","header":[],"url":{"raw":"viacep.com.br/ws/:cep/json/","host":["viacep","com","br"],"path":["ws",":cep","json",""],"variable":[{"key":"cep","value":"01001000"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.16.0"},{"key":"Date","value":"Fri, 27 Sep 2019 14:04:01 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"GET, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"Content-Type, X-Request-With, X-Requested-By"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Max-Age","value":"86400"},{"key":"Expires","value":"Fri, 27 Sep 2019 15:04:01 GMT"},{"key":"Cache-Control","value":"max-age=3600"},{"key":"Cache-Control","value":"public"}],"cookie":[],"responseTime":null,"body":"{\n \"cep\": \"01001-000\",\n \"logradouro\": \"Praça da Sé\",\n \"complemento\": \"lado ímpar\",\n \"bairro\": \"Sé\",\n \"localidade\": \"São Paulo\",\n \"uf\": \"SP\",\n \"unidade\": \"\",\n \"ibge\": \"3550308\",\n \"gia\": \"1004\"\n}"}],"_postman_id":"d3fb21be-b384-47fb-bd6c-ac479ab41627"},{"name":"viacep.com.br/ws/01001000/json/","id":"fda69bb1-0208-4f30-9d26-86e2b1552807","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":""},"url":"viacep.com.br/ws/01001000/json/","description":"

Consulta Códigos de Endereçamento Postal (CEP) do Brasil com retorno JSON

\n","urlObject":{"path":["ws","01001000","json",""],"host":["viacep","com","br"],"query":[],"variable":[]}},"response":[{"id":"1b52a2c3-6015-40cc-a58e-ca345a39dcab","name":"viacep.com.br/ws/01001000/json/","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":""},"url":"viacep.com.br/ws/01001000/json/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.16.0"},{"key":"Date","value":"Fri, 27 Sep 2019 14:03:43 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"GET, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"Content-Type, X-Request-With, X-Requested-By"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Max-Age","value":"86400"},{"key":"Expires","value":"Fri, 27 Sep 2019 15:03:43 GMT"},{"key":"Cache-Control","value":"max-age=3600"},{"key":"Cache-Control","value":"public"}],"cookie":[],"responseTime":null,"body":"{\n \"cep\": \"01001-000\",\n \"logradouro\": \"Praça da Sé\",\n \"complemento\": \"lado ímpar\",\n \"bairro\": \"Sé\",\n \"localidade\": \"São Paulo\",\n \"uf\": \"SP\",\n \"unidade\": \"\",\n \"ibge\": \"3550308\",\n \"gia\": \"1004\"\n}"},{"id":"c3260226-80db-4f94-b62d-fe16032a01f3","name":"Default","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":""},"url":"viacep.com.br/ws/01001000/json/"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"fda69bb1-0208-4f30-9d26-86e2b1552807"},{"name":"viacep.com.br/ws/:cep/xml/","id":"f03164e4-d329-449f-a5ad-39055a941d3e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://viacep.com.br/ws/:cep/xml/","description":"

Consulta Códigos de Endereçamento Postal (CEP) do Brasil, path variables com retorno XML

\n","urlObject":{"protocol":"http","path":["ws",":cep","xml",""],"host":["viacep","com","br"],"query":[],"variable":[{"type":"string","value":"01001000","key":"cep"}]}},"response":[{"id":"77e5007b-b8d8-43b1-8e64-ef1e5d76aefa","name":"viacep.com.br/ws/:cep/xml/","originalRequest":{"method":"GET","header":[],"url":{"raw":"http://viacep.com.br/ws/:cep/xml/","protocol":"http","host":["viacep","com","br"],"path":["ws",":cep","xml",""],"variable":[{"key":"cep","value":"01001000"}]}},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Server","value":"nginx/1.16.0"},{"key":"Date","value":"Fri, 27 Sep 2019 14:08:21 GMT"},{"key":"Content-Type","value":"application/xhtml+xml"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"GET, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"Content-Type, X-Request-With, X-Requested-By"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Max-Age","value":"86400"},{"key":"Expires","value":"Fri, 27 Sep 2019 15:08:21 GMT"},{"key":"Cache-Control","value":"max-age=3600"},{"key":"Cache-Control","value":"public"}],"cookie":[],"responseTime":null,"body":"\n\n 01001-000\n Praça da Sé\n lado ímpar\n Sé\n São Paulo\n SP\n \n 3550308\n 1004\n"}],"_postman_id":"f03164e4-d329-449f-a5ad-39055a941d3e"},{"name":"viacep.com.br/ws/01001000/xml/","id":"3eb0d455-75f4-414f-812e-a34f14c4d204","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://viacep.com.br/ws/01001000/xml/","description":"

Consulta Códigos de Endereçamento Postal (CEP) do Brasil com retorno XML

\n","urlObject":{"protocol":"https","path":["ws","01001000","xml",""],"host":["viacep","com","br"],"query":[],"variable":[]}},"response":[{"id":"52c5be0b-7bc1-4af5-9e5c-53d5c88fa147","name":"https://viacep.com.br/ws/01001000/xml/","originalRequest":{"method":"GET","header":[],"url":"https://viacep.com.br/ws/01001000/xml/"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Server","value":"nginx/1.16.0"},{"key":"Date","value":"Fri, 27 Sep 2019 14:01:17 GMT"},{"key":"Content-Type","value":"application/xhtml+xml"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"GET, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"Content-Type, X-Request-With, X-Requested-By"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Max-Age","value":"86400"},{"key":"Expires","value":"Fri, 27 Sep 2019 15:01:17 GMT"},{"key":"Cache-Control","value":"max-age=3600"},{"key":"Cache-Control","value":"public"}],"cookie":[],"responseTime":null,"body":"\n\n 01001-000\n Praça da Sé\n lado ímpar\n Sé\n São Paulo\n SP\n \n 3550308\n 1004\n"}],"_postman_id":"3eb0d455-75f4-414f-812e-a34f14c4d204"},{"name":"BadRequestSample","id":"f5677d7a-2d7f-4f01-a89d-0c426fac8c9b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://viacep.com.br/ws/0100100/json/","description":"

\n","urlObject":{"protocol":"https","path":["ws","0100100","json",""],"host":["viacep","com","br"],"query":[],"variable":[]}},"response":[{"id":"cfe8aff1-067e-474d-ac79-d22b2a67e1ac","name":"BadRequestSample","originalRequest":{"method":"GET","header":[],"url":"https://viacep.com.br/ws/0100100/json/"},"status":"Bad Request","code":400,"_postman_previewlanguage":"html","header":[{"key":"Server","value":"nginx/1.16.0"},{"key":"Date","value":"Fri, 27 Sep 2019 14:28:06 GMT"},{"key":"Content-Type","value":"text/html; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"

ViaCEP Bad Request (400)

"}],"_postman_id":"f5677d7a-2d7f-4f01-a89d-0c426fac8c9b"},{"name":"NotFindSample","id":"f29ecf48-9ad7-4cf8-8d53-ba12c8322590","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://viacep.com.br/ws/99999999/json/","description":"

\n","urlObject":{"protocol":"https","path":["ws","99999999","json",""],"host":["viacep","com","br"],"query":[],"variable":[]}},"response":[{"id":"99a3b7d2-147c-492a-8a45-b5e070b83e90","name":"NotFindSample","originalRequest":{"method":"GET","header":[],"url":"https://viacep.com.br/ws/99999999/json/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.16.0"},{"key":"Date","value":"Fri, 27 Sep 2019 14:33:17 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"GET, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"Content-Type, X-Request-With, X-Requested-By"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Max-Age","value":"86400"},{"key":"Expires","value":"Fri, 27 Sep 2019 15:33:17 GMT"},{"key":"Cache-Control","value":"max-age=3600"},{"key":"Cache-Control","value":"public"}],"cookie":[],"responseTime":null,"body":"{\n \"erro\": true\n}"}],"_postman_id":"f29ecf48-9ad7-4cf8-8d53-ba12c8322590"}]}