GET/api/v4/countries

Enumerar los países y estados compatibles

Países que admite Listings API, sus estados/provincias, códigos ISO para crear o actualizar ubicaciones y campos de dirección exigidos o validados.

Requiere una clave de API. Consulta Autenticación para conocer el formato del encabezado y la rotación de claves.

Parámetros

Este endpoint no recibe parámetros.

Respuestas

200List of supported countries, each with its states and ISO codes. The live response is trimmed here to the United States, with three of its states.
Response
{  "data": {    "supportedCountries": [      {        "databaseId": 233,        "hasCity": true,        "id": "Q291bnRyeToyMzM=",        "iso": "US",        "name": "United States",        "hasPostalCode": true,        "stateRequired": true,        "states": [          { "countryId": 233, "id": "3542", "iso": "CA", "name": "California" },          { "countryId": 233, "id": "3537", "iso": "NY", "name": "New York" },          { "countryId": 233, "id": "3524", "iso": "TX", "name": "Texas" }        ]      }    ]  }}
401Unauthenticated, missing or invalid API key.
500Internal server error.

Devuelve el catálogo completo de países y sus subdivisiones (estados, provincias, territorios) que Listings API admite para los datos de ubicación. Cada entrada de país contiene su código ISO (iso), un id de Relay, un databaseId numérico, un array states y tres indicadores que especifican cómo se valida la dirección de una ubicación en ese país. Cada estado contiene su propio iso y un id numérico. Los países que Listings API no subdivide devuelven un array states vacío.

Reglas de dirección por país

Indicadortruefalse
hasCitycity es obligatorio al crear (SY10126).El país no utiliza direcciones a nivel de ciudad. Si envías un valor de city, se descarta.
stateRequiredstateIso es obligatorio y debe ser uno de los valores de states del país (SY10010).Omite stateIso. Algunos de estos países sí incluyen states; si envías un valor, se almacena sin validarlo.
hasPostalCodeEl país utiliza códigos postales. Envía postalCode con la dirección.El país no tiene un sistema de códigos postales. Omite postalCode.

postalCode es opcional en todos los países, pero envíalo siempre que hasPostalCode sea true: algunas plataformas de publicación lo necesitan para situar el marcador en el mapa. Si envías un valor, se valida según el formato del país (SY10014). Con hideAddress: true en la ubicación, se omiten las validaciones de ciudad y estado.

Caso de uso: rellenar los desplegables de dirección. Obtén estos datos una vez al iniciar la aplicación y guárdalos en caché. Genera el selector de país a partir de name/iso y, cuando se elija un país, rellena el selector de estado con los datos de states de ese país. Los valores de iso se utilizan directamente en los campos countryIso y stateIso de los endpoints create-location y update-location.

Caso de uso: validar una dirección antes de enviarla. Antes de llamar a create-location, comprueba que el valor de countryIso que vas a usar exista en esta lista, que stateIso aparezca bajo ese país cuando stateRequired sea true y que city tenga un valor cuando hasCity sea true. Detectar aquí un código no admitido permite mostrar un mensaje claro en el cliente en lugar de recibir un 400 de la llamada de creación. La respuesta completa es grande (incluye todos los países admitidos); el ejemplo anterior se ha reducido a una sola entrada. No hay parámetros de consulta; el endpoint siempre devuelve el conjunto completo.

Request
curl -X GET 'https://listingsapi.com/api/v4/countries' \  -H "Authorization: API $LISTINGSAPI_KEY"