# Schema OpenAPI
URL: /docs/openapi.mdx

Especificação completa da API brapi em formato OpenAPI 3.0

***

title: 'Schema OpenAPI'
description: 'Especificação completa da API brapi em formato OpenAPI 3.0'
-------------------------------------------------------------------------

import { Button } from '~/components/ui/button'
import { DownloadIcon, EyeIcon } from 'lucide-react'
import { DynamicCodeBlock } from 'fumadocs-ui/components/dynamic-codeblock';
import schema from '~/public/swagger/latest.json';

A especificação completa da API brapi está disponível no formato OpenAPI 3.0
(anteriormente conhecido como Swagger). Esta documentação técnica contém todos
os endpoints, parâmetros, schemas de resposta e exemplos de uso.

## Download e Visualização

Você pode baixar o arquivo JSON da especificação ou visualizar o arquivo JSON
online.

<div className="flex gap-4 my-6">
  <Button asChild variant="outline">
    <a href="/swagger/latest.json" download="brapi-openapi.json" className="no-underline plausible-event-name--download-swagger-json">
      <div className="flex items-center gap-2">
        <DownloadIcon className="w-4 h-4" />

        Download JSON
      </div>
    </a>
  </Button>

  <Button asChild variant="outline">
    <a href="/swagger/latest.json" target="_blank" className="no-underline plausible-event-name--view-swagger-json">
      <div className="flex items-center gap-2">
        <EyeIcon className="w-4 h-4" />

        Visualizar JSON
      </div>
    </a>
  </Button>
</div>

## Schema Completa

Especificação completa da API brapi em formato OpenAPI 3.0 para dados de ações, moedas, criptomoedas, inflação, etc.

<DynamicCodeBlock lang="json" code={JSON.stringify(schema, null, 2)} />

## Como usar esta especificação

### 1. **Ferramentas de Desenvolvimento**

* **Swagger UI**: Visualize e teste a API interativamente
* **Postman**: Importe a especificação para criar coleções automaticamente
* **Insomnia**: Gere requisições baseadas na especificação
* **OpenAPI Generator**: Gere SDKs em diversas linguagens

### 2. **Integração em Projetos**

* **Frontend**: Use para gerar tipos TypeScript automaticamente
* **Backend**: Valide requisições e respostas contra o schema
* **Documentação**: Gere documentação automática para sua aplicação

### 3. **Validação e Testes**

* Valide suas requisições contra o schema oficial
* Use para testes automatizados de integração
* Garanta compatibilidade com futuras versões da API

## Informações Técnicas

* **Versão OpenAPI**: 3.0.0
* **Versão da API**: 3.0.0
* **Formato**: JSON
* **Atualização**: Automática a cada deploy
* **Compatibilidade**: Todas as ferramentas que suportam OpenAPI 3.0+

## Próximos Passos

1. **[Comece com a documentação geral](/docs)** para entender os conceitos
   básicos
2. **[Explore os endpoints de ações](/docs/acoes)** para ver exemplos práticos
3. **[Veja exemplos de código](/docs/examples)** em diferentes linguagens
4. **[Configure sua conta](/dashboard)** para obter seu token de API

***

*Esta especificação é gerada automaticamente e sempre reflete o estado atual da
API brapi.*