# Demographics

Este servicio retorna las variables con información socio económica y demográfica desde una dirección (domicilio) solicitada. Dicha ubicación puede provenir de direcciones en línea o de información almacenada en sus repositorios de datos.

Parámetros obligatorios en una solicitud de Demographics con dirección:

address: Especifique las direcciones de acuerdo con el formato utilizado por el servicio postal nacional del país en cuestión. Deben evitarse elementos de dirección adicionales, como nombres comerciales y números de unidad, suite o piso. Los elementos de la dirección postal deben estar delimitados por espacios (que se muestran aquí como URL de escape a% 20).
key: la clave API de su aplicación. Esta clave identifica su aplicación a los efectos de la gestión de cuotas. Aprenda a obtener la clave API.

# Ejemplo de Demographics con dirección

La siguiente petición base del servicio tendría la siguiente estructura:

https://apis.geodir.co/demographics/v1/json?address=jr pedro ruiz gallo nro 668&key=YOUR_KEY

Nota: Asegúrese de ingresar una dirección válida para el parámetro address.

{
    "status": "OK",
    "groups": [
        {
            "name": "grid_code",
            "description": "Codigo de Identificación Unica",
            "fields": [
                {
                    "name": "grid_code",
                    "value": 660136,
                    "typeField": "integer",
                    "description": "Codigo de Identificación Única"
                }
            ]
        },
        {
            "name": "socioeconomic_level",
            "description": "Nivel Socioeconomico",
            "fields": [
                {
                    "name": "socioeconomic_level",
                    "value": B,
                    "typeField": "text",
                    "description": "Nivel Socioeconomico"
                },
                {
                    "name": "income",
                    "value": 5531.0,
                    "typeField": "double",
                    "description": "Ingreso Promedio Familiar"
                }
            ]
        },
        {
            "name": "population",
            "description": "Población",
            "fields": [
                {
                    "name": "total_population",
                    "value": 387,
                    "typeField": "integer",
                    "description": "Población Total"
                },
                {
                    "name": "male_population",
                    "value": 185,
                    "typeField": "integer",
                    "description": "Según sexo Hombre"
                },
                {
                    "name": "female_population",
                    "value": 202,
                    "typeField": "integer",
                    "description": "Según sexo Mujer"
                }
            ]
        },
        
    ]
}

# Respuestas de Demographics con dirección

A continuación se muestran los códigos de estado posibles en una respuesta de Demographics.

# Códigos de Estado de Demographics con dirección

El campo "status" dentro del objeto de respuesta de demographics contiene el estado de la solicitud y puede contener información de depuración para ayudarlo a averiguar por qué la codificación geográfica no funciona. El campo "status" puede contener los siguientes valores:

"OK" indica que el servicio demographics no produjo errores; el servicio realizo la acción correctamente.
"ZERO_RESULTS" indica que el servicio demographics se realizó correctamente pero no arrojó resultados. Esto puede ocurrir si al geocodificador se le pasó un latlon inexistente o fuera de zona.
"OVER_QUERY_LIMIT" indica que ha superado su cuota.
"REQUEST_DENIED" indica que su solicitud fue denegada.
"INVALID_REQUEST" generalmente indica uno de los siguientes:
- Falta la consulta (address, groups o latlon).
- Se proporcionó **groups ** o demographics_type no válido.
"UNKNOWN_ERROR" indica que la solicitud no se pudo procesar debido a un error del servidor. La solicitud puede tener éxito si vuelve a intentarlo.

# Parámetros opcionales

Parámetros opcionales:

Groups: Es un filtro con elementos separados por una tubería (|). El filtro de grupos también se acepta como parámetro opcional. Cada elemento consta de un par grupo lo cual es un valor y restringe completamente los resultados de demographics. Consulte más información sobre el filtrado de grupos.
info: es una serie de valores útiles al cliente para almacenar información complementaria o metadatos, estos elementos deben estar separados por una tubería (|).

# Filtrado de grupos

En una respuesta de Demographics, la API de Demographics puede devolver resultados restringidos a un área específica. Puede especificar la restricción utilizando el filtro de grupos. Un filtro consta de una lista de pares group:value separados por una barra vertical (|). Los valores de filtro admiten los mismos métodos de corrección ortográfica y coincidencia parcial que otras solicitudes de Demographics.

Los siguientes groups pueden usarse para influir en los resultados, pero no se aplicarán:

locality coincide con tipos locality y sublocality.

Notas sobre el filtrado de grupos:

Los resultados son consistentes con Geodir Maps, que ocasionalmente produce respuestas ZERO_RESULTS.
Para cada segmento de dirección, especifíquelo en el parámetro de group.

Un código geográfico para "jr pedro ruiz gallo nro 668" con groups=locality_id:150105

https://apis.geodir.co/demographics/v1/json?address=jr pedro ruiz gallo nro 668&groups=locality_id:150105&info=cod_peticion:1020|canal:abc|origen_sistema:cde