# InfoSC

> O dado de informações do setor censitário retorna, a partir de uma coordenada geográfica, as informações básicas acerca da proximidade do ponto.

**Base**: `https://api.prismadata.io/v1`

**Autenticação**: header `X-Apikey` (ou query `api_key`). Detalhes em [Autenticação](autenticacao.md).

**Formato de resposta**: JSON plano com campos `prismadata__<serviço>__<campo>`; em lote, dicionário indexado pelas chaves enviadas. Detalhes em [Formato de Resposta](guias/formato-de-resposta.md).

## Endpoints

### `GET /location/infosc`

Busca as informações da região que o ponto se encontra

**Exemplo curl**:

```bash
curl -X GET "https://api.prismadata.io/v1/location/infosc?lat=-19.9323&lng=-43.9351" \
  -H "X-Apikey: SEU_TOKEN"
```

**Parâmetros**:

| Nome | Local | Tipo | Obrigatório | Descrição |
|------|-------|------|-------------|-----------|
| `lat` | query | number | sim | Latitude do ponto de consulta |
| `lng` | query | number | sim | Longitude do ponto de consulta |

**Response 200** (`application/json`):

> Successful Response

| Campo | Tipo | Obrigatório | Descrição |
|-------|------|-------------|-----------|
| `prismadata__infosc__area_km2` | number \| null | não | Área em km² da região associada ao ponto. |
| `prismadata__infosc__municipio` | string \| null | não | Nome do município. |
| `prismadata__infosc__regiao` | string \| null | não | Região do país onde o ponto se encontra. |
| `prismadata__infosc__situacao` | string \| null | não | Situação urbana ou rural do ponto. |
| `prismadata__infosc__tipo_sc` | string \| null | não | Tipo do setor censitário. |
| `prismadata__infosc__tipo_situacao` | string \| null | não | Tipo da situação urbana. |
| `prismadata__infosc__uf` | string \| null | não | Sigla da unidade federativa. |
| `prismadata__infosc__cd_setor` | integer \| null | não | Codigo IBGE do setor censitario. Disponivel apenas para roles 'admin' ou 'location:infosc:cd_setor'. |

**Outros códigos**: 401, 403, 422, 429

---

### `POST /location/batch/infosc`

Busca as informações dos setores censitários em lote. A cobrança desta api é feita em função do número de coordenadas contidas no lote.

**Exemplo curl**:

```bash
curl -X POST "https://api.prismadata.io/v1/location/batch/infosc" \
  -H "X-Apikey: SEU_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
         "point1": [
           -23.5505,
           -46.6333
         ],
         "point2": [
           40.7128,
           -74.006
         ]
       }'
```

**Request body** (`application/json`):

Dicionário `{string: array[number]}`.
Modelo da entrada em batch

**Response 200** (`application/json`):

> Successful Response

Dicionário `{string: object}`.
Dicionário onde as chaves são identificadores únicos para cada ponto consultado

**Outros códigos**: 401, 403, 422, 429

---

## Recursos relacionados

- Documentação Redoc interativa: https://prismadata.io/redoc.html#tag/InfoSC
- OpenAPI só deste produto (JSON): https://prismadata.io/llm/openapi/infosc.json
- OpenAPI completo: https://prismadata.io/openapi.yaml
- Índice geral: https://prismadata.io/llms.txt