> ## Documentation Index
> Fetch the complete documentation index at: https://docs.tukanmx.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Tipos de entidad

> Los nueve niveles geográficos de Atlas y sus identificadores.

Los **nueve niveles geográficos** que maneja Atlas, con su nombre y su definición.

Los `entity_type_id` de este catálogo (`STATE`, `MUNICIPALITY`, `ZIPCODE`…) son los valores que usas para filtrar en casi todos los demás endpoints.

<RequestExample>
  ```bash cURL theme={null}
  curl "https://client.tukanmx.com/tukan-atlas/entity-types/" \
    -H "Authorization: Token $API_TUKAN"
  ```

  ```python Python theme={null}
  import os
  import requests

  headers = {"Authorization": f"Token {os.environ['API_TUKAN']}"}

  resp = requests.get(
      "https://client.tukanmx.com/tukan-atlas/entity-types/",
      headers=headers,
  )
  resp.raise_for_status()
  for t in resp.json()["results"]:
      print(t["entity_type_id"], "-", t["name"])
  ```
</RequestExample>

<ResponseExample>
  ```json 200 theme={null}
  {
    "count": 9,
    "page": 1,
    "page_size": 100,
    "results": [
      {
        "entity_type_id": "AGEB",
        "name": "AGEB",
        "name_en": "AGEB",
        "description": "Área Geoestadística Básica definida por el INEGI, compuesta por un conjunto de manzanas delimitadas por calles, avenidas, vías de ferrocarril u otros rasgos geográficos.",
        "description_en": "Basic Geostatistical Area defined by INEGI, composed of a group of blocks delimited by streets, avenues, railways or other geographic features."
      },
      {
        "entity_type_id": "COUNTRY",
        "name": "País",
        "name_en": "Country",
        "description": "División geográfica de nivel superior que representa una nación soberana.",
        "description_en": "Top-level geographic division representing a sovereign nation."
      }
    ]
  }
  ```
</ResponseExample>


## OpenAPI

````yaml es/atlas/openapi-atlas.json GET /entity-types/
openapi: 3.0.3
info:
  title: Atlas API
  description: >-
    API para consultar indicadores geoespaciales, catálogos geográficos y
    densidad de lugares en México.
  version: 1.0.0
  contact:
    name: Soporte Tukan
    email: contacto@tukanmx.com
servers:
  - url: https://client.tukanmx.com/tukan-atlas
    description: Servidor de producción
security:
  - tokenAuth: []
paths:
  /entity-types/:
    get:
      summary: Catálogo de tipos de entidad
      description: >-
        Lista los niveles geográficos disponibles en Atlas (país, estado,
        municipio, código postal, localidad, AGEB, manzana, colonia). Usa los
        entity_type_id de este catálogo en los filtros de los demás endpoints.
      operationId: listEntityTypes
      parameters:
        - name: page
          in: query
          description: Número de página
          required: false
          schema:
            type: integer
            default: 1
        - name: page_size
          in: query
          description: Resultados por página
          required: false
          schema:
            type: integer
            default: 100
        - name: search
          in: query
          description: Búsqueda global en entity_type_id, name y name_en
          required: false
          schema:
            type: string
            example: estado
        - name: entity_type_id
          in: query
          description: ID exacto del tipo de entidad
          required: false
          schema:
            type: string
            example: STATE
        - name: name
          in: query
          description: Filtro por nombre en español (coincidencia parcial)
          required: false
          schema:
            type: string
            example: municipio
        - name: name_en
          in: query
          description: Filtro por nombre en inglés (coincidencia parcial)
          required: false
          schema:
            type: string
            example: state
      responses:
        '200':
          description: Catálogo obtenido exitosamente
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityTypeListResponse'
        '400':
          description: Solicitud inválida
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Token de autenticación inválido o ausente
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Error interno del servidor
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    EntityTypeListResponse:
      type: object
      properties:
        count:
          type: integer
          example: 9
        page:
          type: integer
          example: 1
        page_size:
          type: integer
          example: 100
        results:
          type: array
          items:
            $ref: '#/components/schemas/EntityTypeItem'
    ErrorResponse:
      type: object
      properties:
        error:
          type: string
    EntityTypeItem:
      type: object
      properties:
        entity_type_id:
          type: string
          example: STATE
        name:
          type: string
          example: Estado
        name_en:
          type: string
          example: State
        description:
          type: string
          nullable: true
          example: División administrativa de primer nivel dentro de un país.
        description_en:
          type: string
          nullable: true
          example: First-level administrative división within a country.
  securitySchemes:
    tokenAuth:
      type: apiKey
      in: header
      name: Authorization
      description: >-
        Token de autenticación. Formato requerido: Token tu-token (la palabra
        Token, un espacio y tu token). Solicita tu token escribiendo a
        contacto@tukanmx.com.

````