An Australian postcode to suburb API is a tool that allows developers to integrate postcode to suburn funcionality into their applications. Using the API, users can input a valid Australian postcode and receive information about the corresponding suburb.
It will receive a parameter and provide you with a JSON.
Free Plan: 2 API Calls. 1 request per second.
Basic Plan: 9,500 API Calls. 1 request per second.
Pro Plan: 20,000 API Calls. 6 request per second.
Pro Plus Plan: 50,000 API Calls. 10 request per second.
This endpoint will give you the suburbs that match the zip code. It will also return the state of each suburb and, if available, the latitude and longitude of the suburb.
Get list of suburbs - Características del Endpoint
Objeto | Descripción |
---|
[{"suburb":"Barangaroo","state":"NSW","latitude":"-33.86051951","longitude":"151.2015802"},{"suburb":"Dawes Point","state":"NSW","latitude":"-33.85659644","longitude":"151.2069524"},{"suburb":"Haymarket","state":"NSW","latitude":"-33.88096124","longitude":"151.2050073"},{"suburb":"Millers Point","state":"NSW","latitude":"-33.85952935","longitude":"151.2041837"},{"suburb":"Parliament House","state":"NSW","latitude":"-33.867324","longitude":"151.212586"},{"suburb":"Sydney","state":"NSW","latitude":"-33.86885141","longitude":"151.2093319"},{"suburb":"Sydney South","state":"NSW","latitude":"-33.8743125","longitude":"151.205873"},{"suburb":"The Rocks","state":"NSW","latitude":"-33.85946101","longitude":"151.2081519"}]
curl --location --request GET 'https://zylalabs.com/api/914/postcode+to+suburb+mapping+australian+api/728/get+list+of+suburbs' --header 'Authorization: Bearer YOUR_API_KEY'
With this endpoint you will get 3 letter states for the zip code passed.
Get list of states - Características del Endpoint
Objeto | Descripción |
---|
["NSW"]
curl --location --request GET 'https://zylalabs.com/api/914/postcode+to+suburb+mapping+australian+api/730/get+list+of+states' --header 'Authorization: Bearer YOUR_API_KEY'
This endpoint will return the suburbs and postcodes in a given radius.
Get by radius zip codes and suburbs - Características del Endpoint
Objeto | Descripción |
---|
[{"postcode":"1143","suburb":"Sydney","state":"NSW","latitude":"-33.86885141","longitude":"151.2093319","distance":"0.0"},{"postcode":"1163","suburb":"Sydney","state":"NSW","latitude":"-33.86885141","longitude":"151.2093319","distance":"0.0"},{"postcode":"1164","suburb":"Sydney","state":"NSW","latitude":"-33.86885141","longitude":"151.2093319","distance":"0.0"},{"postcode":"1165","suburb":"Sydney","state":"NSW","latitude":"-33.86885141","longitude":"151.2093319","distance":"0.0"},{"postcode":"1166","suburb":"Sydney","state":"NSW","latitude":"-33.86885141","longitude":"151.2093319","distance":"0.0"},{"postcode":"1167","suburb":"Sydney","state":"NSW","latitude":"-33.86885141","longitude":"151.2093319","distance":"0.0"},{"postcode":"1168","suburb":"Sydney","state":"NSW","latitude":"-33.86885141","longitude":"151.2093319","distance":"0.0"},{"postcode":"1169","suburb":"Sydney","state":"NSW","latitude":"-33.86885141","longitude":"151.2093319","distance":"0.0"},{"postcode":"1170","suburb":"Sydney","state":"NSW","latitude":"-33.86885141","longitude":"151.2093319","distance":"0.0"},{"postcode":"1171","suburb":"Sydney","state":"NSW","latitude":"-33.86885141","longitude":"151.2093319","distance":"0.0"},{"postcode":"1172","suburb":"Sydney","state":"NSW","latitude":"-33.86885141","longitude":"151.2093319","distance":"0.0"},{"postcode":"1173","suburb":"Sydney","state":"NSW","latitude":"-33.86885141","longitude":"151.2093319","distance":"0.0"},{"postcode":"1174","suburb":"Sydney","state":"NSW","latitude":"-33.86885141","longitude":"151.2093319","distance":"0.0"},{"postcode":"1175","suburb":"Sydney","state":"NSW","latitude":"-33.86885141","longitude":"151.2093319","distance":"0.0"},{"postcode":"1176","suburb":"Sydney","state":"NSW","latitude":"-33.86885141","longitude":"151.2093319","distance":"0.0"},{"postcode":"1177","suburb":"Sydney","state":"NSW","latitude":"-33.86885141","longitude":"151.2093319","distance":"0.0"},{"postcode":"1178","suburb":"Sydney","state":"NSW","latitude":"-33.86885141","longitude":"151.2093319","distance":"0.0"},{"postcode":"1179","suburb":"Sydney","state":"NSW","latitude":"-33.86885141","longitude":"151.2093319","distance":"0.0"},{"postcode":"1162","suburb":"Sydney","state":"NSW","latitude":"-33.86885141","longitude":"151.2093319","distance":"0.0"},{"postcode":"1161","suburb":"Sydney","state":"NSW","latitude":"-33.86885141","longitude":"151.2093319","distance":"0.0"},{"postcode":"1144","suburb":"Sydney","state":"NSW","latitude":"-33.86885141","longitude":"151.2093319","distance":"0.0"},{"postcode":"1145","suburb":"Sydney","state":"NSW","latitude":"-33.86885141","longitude":"151.2093319","distance":"0.0"},{"postcode":"1146","suburb":"Sydney","state":"NSW","latitude":"-33.86885141","longitude":"151.2093319","distance":"0.0"},{"postcode":"1147","suburb":"Sydney","state":"NSW","latitude":"-33.86885141","longitude":"151.2093319","distance":"0.0"},{"postcode":"1148","suburb":"Sydney","state":"NSW","latitude":"-33.86885141","longitude":"151.2093319","distance":"0.0"},{"postcode":"1149","suburb":"Sydney","state":"NSW","latitude":"-33.86885141","longitude":"151.2093319","distance":"0.0"},{"postcode":"1150","suburb":"Sydney","state":"NSW","latitude":"-33.86885141","longitude":"151.2093319","distance":"0.0"},{"postcode":"1151","suburb":"Sydney","state":"NSW","latitude":"-33.86885141","longitude":"151.2093319","distance":"0.0"},{"postcode":"1152","suburb":"Sydney","state":"NSW","latitude":"-33.86885141","longitude":"151.2093319","distance":"0.0"},{"postcode":"1153","suburb":"Sydney","state":"NSW","latitude":"-33.86885141","longitude":"151.2093319","distance":"0.0"},{"postcode":"1154","suburb":"Sydney","state":"NSW","latitude":"-33.86885141","longitude":"151.2093319","distance":"0.0"},{"postcode":"1155","suburb":"Sydney","state":"NSW","latitude":"-33.86885141","longitude":"151.2093319","distance":"0.0"},{"postcode":"1156","suburb":"Sydney","state":"NSW","latitude":"-33.86885141","longitude":"151.2093319","distance":"0.0"},{"postcode":"1157","suburb":"Sydney","state":"NSW","latitude":"-33.86885141","longitude":"151.2093319","distance":"0.0"},{"postcode":"1158","suburb":"Sydney","state":"NSW","latitude":"-33.86885141","longitude":"151.2093319","distance":"0.0"},{"postcode":"1159","suburb":"Sydney","state":"NSW","latitude":"-33.86885141","longitude":"151.2093319","distance":"0.0"},{"postcode":"1160","suburb":"Sydney","state":"NSW","latitude":"-33.86885141","longitude":"151.2093319","distance":"0.0"},{"postcode":"1180","suburb":"Sydney","state":"NSW","latitude":"-33.86885141","longitude":"151.2093319","distance":"0.0"},{"postcode":"1181","suburb":"Sydney","state":"NSW","latitude":"-33.86885141","longitude":"151.2093319","distance":"0.0"},{"postcode":"1201","suburb":"Sydney","state":"NSW","latitude":"-33.86885141","longitude":"151.2093319","distance":"0.0"},{"postcode":"1202","suburb":"Sydney","state":"NSW","latitude":"-33.86885141","longitude":"151.2093319","distance":"0.0"},{"postcode":"1203","suburb":"Sydney","state":"NSW","latitude":"-33.86885141","longitude":"151.2093319","distance":"0.0"},{"postcode":"1204","suburb":"Sydney","state":"NSW","latitude":"-33.86885141","longitude":"151.2093319","distance":"0.0"},{"postcode":"1205","suburb":"Sydney","state":"NSW","latitude":"-33.86885141","longitude":"151.2093319","distance":"0.0"},{"postcode":"1206","suburb":"Sydney","state":"NSW","latitude":"-33.86885141","longitude":"151.2093319","distance":"0.0"},{"postcode":"1207","suburb":"Sydney","state":"NSW","latitude":"-33.86885141","longitude":"151.2093319","distance":"0.0"},{"postcode":"1291","suburb":"Sydney","state":"NSW","latitude":"-33.86885141","longitude":"151.2093319","distance":"0.0"},{"postcode":"1292","suburb":"Sydney","state":"NSW","latitude":"-33.86885141","longitude":"151.2093319","distance":"0.0"},{"postcode":"1293","suburb":"Sydney","state":"NSW","latitude":"-33.86885141","longitude":"151.2093319","distance":"0.0"},{"postcode":"1294","suburb":"Sydney","state":"NSW","latitude":"-33.86885141","longitude":"151.2093319","distance":"0.0"},{"postcode":"1295","suburb":"Sydney","state":"NSW","latitude":"-33.86885141","longitude":"151.2093319","distance":"0.0"},{"postcode":"1296","suburb":"Sydney","state":"NSW","latitude":"-33.86885141","longitude":"151.2093319","distance":"0.0"},{"postcode":"1297","suburb":"Sydney","state":"NSW","latitude":"-33.86885141","longitude":"151.2093319","distance":"0.0"},{"postcode":"1298","suburb":"Sydney","state":"NSW","latitude":"-33.86885141","longitude":"151.2093319","distance":"0.0"},{"postcode":"1299","suburb":"Sydney","state":"NSW","latitude":"-33.86885141","longitude":"151.2093319","distance":"0.0"},{"postcode":"2001","suburb":"Sydney","state":"NSW","latitude":"-33.86885141","longitude":"151.2093319","distance":"0.0"},{"postcode":"1200","suburb":"Sydney","state":"NSW","latitude":"-33.86885141","longitude":"151.2093319","distance":"0.0"},{"postcode":"1199","suburb":"Sydney","state":"NSW","latitude":"-33.86885141","longitude":"151.2093319","distance":"0.0"},{"postcode":"1182","suburb":"Sydney","state":"NSW","latitude":"-33.86885141","longitude":"151.2093319","distance":"0.0"},{"postcode":"1183","suburb":"Sydney","state":"NSW","latitude":"-33.86885141","longitude":"151.2093319","distance":"0.0"},{"postcode":"1184","suburb":"Sydney","state":"NSW","latitude":"-33.86885141","longitude":"151.2093319","distance":"0.0"},{"postcode":"1185","suburb":"Sydney","state":"NSW","latitude":"-33.86885141","longitude":"151.2093319","distance":"0.0"},{"postcode":"1186","suburb":"Sydney","state":"NSW","latitude":"-33.86885141","longitude":"151.2093319","distance":"0.0"},{"postcode":"1187","suburb":"Sydney","state":"NSW","latitude":"-33.86885141","longitude":"151.2093319","distance":"0.0"},{"postcode":"1188","suburb":"Sydney","state":"NSW","latitude":"-33.86885141","longitude":"151.2093319","distance":"0.0"},{"postcode":"1189","suburb":"Sydney","state":"NSW","latitude":"-33.86885141","longitude":"151.2093319","distance":"0.0"},{"postcode":"1190","suburb":"Sydney","state":"NSW","latitude":"-33.86885141","longitude":"151.2093319","distance":"0.0"},{"postcode":"1191","suburb":"Sydney","state":"NSW","latitude":"-33.86885141","longitude":"151.2093319","distance":"0.0"},{"postcode":"1192","suburb":"Sydney","state":"NSW","latitude":"-33.86885141","longitude":"151.2093319","distance":"0.0"},{"postcode":"1193","suburb":"Sydney","state":"NSW","latitude":"-33.86885141","longitude":"151.2093319","distance":"0.0"},{"postcode":"1194","suburb":"Sydney","state":"NSW","latitude":"-33.86885141","longitude":"151.2093319","distance":"0.0"},{"postcode":"1195","suburb":"Sydney","state":"NSW","latitude":"-33.86885141","longitude":"151.2093319","distance":"0.0"},{"postcode":"1196","suburb":"Sydney","state":"NSW","latitude":"-33.86885141","longitude":"151.2093319","distance":"0.0"},{"postcode":"1197","suburb":"Sydney","state":"NSW","latitude":"-33.86885141","longitude":"151.2093319","distance":"0.0"},{"postcode":"1198","suburb":"Sydney","state":"NSW","latitude":"-33.86885141","longitude":"151.2093319","distance":"0.0"},{"postcode":"2000","suburb":"Sydney","state":"NSW","latitude":"-33.86885141","longitude":"151.2093319","distance":"0.0"},{"postcode":"1003","suburb":"Sydney","state":"NSW","latitude":"-33.86885141","longitude":"151.2093319","distance":"0.0"},{"postcode":"1030","suburb":"Sydney","state":"NSW","latitude":"-33.86885141","longitude":"151.2093319","distance":"0.0"},{"postcode":"1031","suburb":"Sydney","state":"NSW","latitude":"-33.86885141","longitude":"151.2093319","distance":"0.0"},{"postcode":"1032","suburb":"Sydney","state":"NSW","latitude":"-33.86885141","longitude":"151.2093319","distance":"0.0"},{"postcode":"1033","suburb":"Sydney","state":"NSW","latitude":"-33.86885141","longitude":"151.2093319","distance":"0.0"},{"postcode":"1034","suburb":"Sydney","state":"NSW","latitude":"-33.86885141","longitude":"151.2093319","distance":"0.0"},{"postcode":"1035","suburb":"Sydney","state":"NSW","latitude":"-33.86885141",...
curl --location --request GET 'https://zylalabs.com/api/914/postcode+to+suburb+mapping+australian+api/732/get+by+radius+zip+codes+and+suburbs' --header 'Authorization: Bearer YOUR_API_KEY'
Encabezado | Descripción |
---|---|
Autorización
|
[Requerido] Debería ser Bearer access_key . Consulta "Tu Clave de Acceso a la API" arriba cuando estés suscrito. |
Sin compromiso a largo plazo. Mejora, reduce o cancela en cualquier momento. La Prueba Gratuita incluye hasta 50 solicitudes.
Each endpoint returns suburb-related data based on the input postcode. The "Get list of suburbs" endpoint provides suburb names, states, and geographical coordinates. The "Get list of states" endpoint returns the three-letter state codes, while the "Get by radius zip codes and suburbs" endpoint returns suburbs, postcodes, states, and distances from a specified location.
Key fields in the response data include "suburb," "state," "postcode," "latitude," "longitude," and "distance." For example, the suburb response includes the suburb name and its corresponding state, while the radius endpoint also includes distance information.
The response data is organized in JSON format, structured as an array of objects. Each object contains key-value pairs representing the suburb's details, such as suburb name, state, and geographical coordinates, making it easy to parse and utilize in applications.
The "Get list of suburbs" endpoint provides suburb names and their states, while the "Get list of states" endpoint returns state codes. The "Get by radius zip codes and suburbs" endpoint offers suburbs, postcodes, states, and distances, allowing users to gather comprehensive location data.
The primary parameter used across endpoints is the postcode. For the "Get by radius zip codes and suburbs" endpoint, users can specify a radius to filter results. This allows for targeted queries based on specific geographic needs.
The data is sourced from official Australian postal and geographic databases, ensuring accuracy and reliability. Regular updates and quality checks are implemented to maintain data integrity and reflect any changes in suburb or postcode information.
Users can utilize the returned data for various applications, such as address validation, regional marketing, and logistics optimization. For instance, businesses can analyze suburb data to tailor marketing strategies or optimize delivery routes based on suburb locations.
Typical use cases include verifying addresses for e-commerce, optimizing delivery routes for logistics companies, and assisting emergency services in locating incidents quickly. The suburb data can enhance customer experience by ensuring accurate service delivery.
Zyla API Hub es como una gran tienda de APIs, donde puedes encontrar miles de ellas en un solo lugar. También ofrecemos soporte dedicado y monitoreo en tiempo real de todas las APIs. Una vez que te registres, puedes elegir qué APIs quieres usar. Solo recuerda que cada API necesita su propia suscripción. Pero si te suscribes a varias, usarás la misma clave para todas, lo que hace todo más fácil para ti.
Los precios se muestran en USD (dólar estadounidense), EUR (euro), CAD (dólar canadiense), AUD (dólar australiano) y GBP (libra esterlina). Aceptamos todas las principales tarjetas de débito y crédito. Nuestro sistema de pago utiliza la última tecnología de seguridad y está respaldado por Stripe, una de las compañías de pago más confiables del mundo. Si tienes algún problema para pagar con tarjeta, contáctanos en [email protected]
Además, si ya tienes una suscripción activa en cualquiera de estas monedas (USD, EUR, CAD, AUD, GBP), esa moneda se mantendrá para suscripciones posteriores. Puedes cambiar la moneda en cualquier momento siempre que no tengas suscripciones activas.
La moneda local que aparece en la página de precios se basa en el país de tu dirección IP y se proporciona solo como referencia. Los precios reales están en USD (dólar estadounidense). Cuando realices un pago, el cargo aparecerá en tu estado de cuenta en USD, incluso si ves el monto equivalente en tu moneda local en nuestro sitio web. Esto significa que no puedes pagar directamente en tu moneda local.
Ocasionalmente, un banco puede rechazar el cargo debido a sus configuraciones de protección contra fraude. Te sugerimos comunicarte con tu banco primero para verificar si están bloqueando nuestros cargos. También puedes acceder al Portal de Facturación y cambiar la tarjeta asociada para realizar el pago. Si esto no funciona y necesitas más ayuda, por favor contacta a nuestro equipo en [email protected]
Los precios se determinan mediante una suscripción recurrente mensual o anual, dependiendo del plan elegido.
Las llamadas a la API se descuentan de tu plan en base a solicitudes exitosas. Cada plan incluye una cantidad específica de llamadas que puedes realizar por mes. Solo las llamadas exitosas, indicadas por una respuesta con estado 200, se contarán en tu total. Esto asegura que las solicitudes fallidas o incompletas no afecten tu cuota mensual.
Zyla API Hub funciona con un sistema de suscripción mensual recurrente. Tu ciclo de facturación comenzará el día en que compres uno de los planes de pago, y se renovará el mismo día del mes siguiente. Así que recuerda cancelar tu suscripción antes si quieres evitar futuros cargos.
Para actualizar tu plan de suscripción actual, simplemente ve a la página de precios de la API y selecciona el plan al que deseas actualizarte. La actualización será instantánea, permitiéndote disfrutar inmediatamente de las funciones del nuevo plan. Ten en cuenta que las llamadas restantes de tu plan anterior no se transferirán al nuevo plan, por lo que debes considerar esto al actualizar. Se te cobrará el monto total del nuevo plan.
Para verificar cuántas llamadas a la API te quedan en el mes actual, revisa el campo 'X-Zyla-API-Calls-Monthly-Remaining' en el encabezado de la respuesta. Por ejemplo, si tu plan permite 1,000 solicitudes por mes y has usado 100, este campo mostrará 900 llamadas restantes.
Para ver el número máximo de solicitudes a la API que permite tu plan, revisa el encabezado de la respuesta 'X-Zyla-RateLimit-Limit'. Por ejemplo, si tu plan incluye 1,000 solicitudes por mes, este encabezado mostrará 1,000.
El encabezado 'X-Zyla-RateLimit-Reset' muestra el número de segundos hasta que tu límite se restablezca. Esto te indica cuándo tu conteo de solicitudes se reiniciará. Por ejemplo, si muestra 3,600, significa que faltan 3,600 segundos para que el límite se restablezca.
Sí, puedes cancelar tu plan en cualquier momento desde tu cuenta, seleccionando la opción de cancelación en la página de Facturación. Ten en cuenta que las actualizaciones, degradaciones y cancelaciones tienen efecto inmediato. Además, al cancelar ya no tendrás acceso al servicio, incluso si te quedaban llamadas en tu cuota.
Puedes contactarnos a través de nuestro canal de chat para recibir asistencia inmediata. Siempre estamos en línea de 8 a. m. a 5 p. m. (EST). Si nos contactas fuera de ese horario, te responderemos lo antes posible. Además, puedes escribirnos por correo electrónico a [email protected]
Para darte la oportunidad de probar nuestras APIs sin compromiso, ofrecemos una prueba gratuita de 7 días que te permite realizar hasta 50 llamadas a la API sin costo. Esta prueba solo se puede usar una vez, por lo que recomendamos aplicarla a la API que más te interese. Aunque la mayoría de nuestras APIs ofrecen prueba gratuita, algunas pueden no hacerlo. La prueba finaliza después de 7 días o cuando realices 50 solicitudes, lo que ocurra primero. Si alcanzas el límite de 50 solicitudes durante la prueba, deberás "Iniciar tu Plan de Pago" para continuar haciendo solicitudes. Puedes encontrar el botón "Iniciar tu Plan de Pago" en tu perfil bajo Suscripción -> Elige la API a la que estás suscrito -> Pestaña de Precios. Alternativamente, si no cancelas tu suscripción antes del día 7, tu prueba gratuita finalizará y tu plan se cobrará automáticamente, otorgándote acceso a todas las llamadas a la API especificadas en tu plan. Ten esto en cuenta para evitar cargos no deseados.
Después de 7 días, se te cobrará el monto total del plan al que estabas suscrito durante la prueba. Por lo tanto, es importante cancelar antes de que finalice el periodo de prueba. No se aceptan solicitudes de reembolso por olvidar cancelar a tiempo.
Cuando te suscribes a una prueba gratuita de una API, puedes realizar hasta 50 llamadas. Si deseas realizar más llamadas después de este límite, la API te pedirá que "Inicies tu Plan de Pago". Puedes encontrar el botón "Iniciar tu Plan de Pago" en tu perfil bajo Suscripción -> Elige la API a la que estás suscrito -> Pestaña de Precios.
Las Órdenes de Pago se procesan entre el día 20 y el 30 de cada mes. Si envías tu solicitud antes del día 20, tu pago será procesado dentro de ese período.
Nivel de Servicio:
100%
Tiempo de Respuesta:
1.054ms
Nivel de Servicio:
100%
Tiempo de Respuesta:
1.266ms
Nivel de Servicio:
100%
Tiempo de Respuesta:
1.215ms
Nivel de Servicio:
100%
Tiempo de Respuesta:
137ms
Nivel de Servicio:
100%
Tiempo de Respuesta:
1.775ms
Nivel de Servicio:
100%
Tiempo de Respuesta:
239ms
Nivel de Servicio:
100%
Tiempo de Respuesta:
2.709ms
Nivel de Servicio:
100%
Tiempo de Respuesta:
2.018ms
Nivel de Servicio:
100%
Tiempo de Respuesta:
489ms
Nivel de Servicio:
100%
Tiempo de Respuesta:
204ms
Nivel de Servicio:
100%
Tiempo de Respuesta:
0ms
Nivel de Servicio:
100%
Tiempo de Respuesta:
2.454ms
Nivel de Servicio:
100%
Tiempo de Respuesta:
4.099ms
Nivel de Servicio:
100%
Tiempo de Respuesta:
0ms
Nivel de Servicio:
100%
Tiempo de Respuesta:
1.681ms
Nivel de Servicio:
100%
Tiempo de Respuesta:
0ms
Nivel de Servicio:
100%
Tiempo de Respuesta:
0ms
Nivel de Servicio:
100%
Tiempo de Respuesta:
0ms
Nivel de Servicio:
100%
Tiempo de Respuesta:
0ms
Nivel de Servicio:
100%
Tiempo de Respuesta:
0ms