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

# Visão geral

> Como funciona a API do Portal da Transparência StartGov.

A API do Portal da Transparência expõe dados públicos de processos licitatórios, contratos, ARPs e ordens de fornecimento de órgãos que utilizam a plataforma StartGov.

Todos os endpoints são **públicos** — não é necessário autenticação ou token de acesso.

## Paginação

Os endpoints de listagem retornam respostas paginadas:

```json theme={null}
{
  "success": true,
  "message": "Dados recuperados com sucesso",
  "data": {
    "data": [...],
    "current_page": 1,
    "per_page": 20,
    "total": 150,
    "last_page": 8,
    "from": 1,
    "to": 20
  }
}
```

Use o parâmetro `per_page` para controlar o tamanho da página (padrão: `20`).

## Relações opcionais

Vários endpoints aceitam o parâmetro `with_relations` para incluir dados relacionados sem chamadas adicionais. Passe os nomes separados por vírgula:

```
GET /transparency/arps?organization_uuid=...&with_relations=documents,terms,orders
```

Cada endpoint documenta quais relações estão disponíveis.

## Enumerações

Use os endpoints auxiliares para obter os IDs válidos de modalidades e status antes de aplicar filtros:

<CardGroup cols={3}>
  <Card title="Modalidades de licitação" icon="list" href="/api-reference/transparency/bidding-modalities" />

  <Card title="Status de licitação" icon="circle-check" href="/api-reference/transparency/bidding-statuses" />

  <Card title="Status de gestão" icon="circle-check" href="/api-reference/transparency/management-statuses" />
</CardGroup>

## Exportação

Todos os tipos de dados podem ser exportados para Excel via `/transparency/export`, aplicando os mesmos filtros dos endpoints de listagem.

<Card title="Exportar para Excel" icon="file-excel" href="/api-reference/transparency/export">
  Baixe relatórios em formato `.xlsx`
</Card>