# Pubrio Documentation: Portuguese Primeiros Passos Documentação da API

> Pubrio API documentation — market expansion intelligence: detect when companies enter new markets via typed, dated signals across 200+ markets, with company & people enrichment, search, lookup, and real-time monitors. REST API reference, guides, and concept docs.

## Documentação da API

### Documentação da API

- [Visão geral da API Pubrio](https://docs.pubrio.com/pt/api-reference/introduction.md): Referência completa da API REST da Pubrio — endpoints para enriquecimento de empresas e pessoas, busca, consulta, resgate, monitores em tempo real e muito mais.
- [Autenticação](https://docs.pubrio.com/pt/api-reference/authentication.md): Autentique as requisições da API Pubrio usando o cabeçalho `pubrio-api-key` — configuração, gerenciamento de chaves e boas práticas de segurança.
- [Limite de taxa](https://docs.pubrio.com/pt/api-reference/rate-limits.md): Limite de taxa para garantir a estabilidade e a confiabilidade.
- [Códigos de status / Erros](https://docs.pubrio.com/pt/api-reference/status-codes.md): A Pubrio usa códigos de status/erro HTTP para indicar o resultado das suas requisições.
- [Enums e constantes](https://docs.pubrio.com/pt/api-reference/enums.md): Todos os valores fixos que a API Pubrio aceita ou retorna — níveis de senioridade, funções de cargo, fontes e formatos de anúncios, faixas de alcance, tipos de sinal, níveis de gestão — em uma única página.
- [Logo API](https://docs.pubrio.com/pt/api-reference/logo-api.md): Consulta pública e gratuita de logotipos de empresas por domínio. Incorpore logotipos de empresas no seu CRM, dashboards, páginas de marketing ou sequências com uma URL simples — sem necessidade de chave de API.

### Endpoints

#### Equipe (Workspace)

- [Detalhes da Equipe](https://docs.pubrio.com/pt/api-reference/endpoint/profile/profile.md): Recupera os detalhes do perfil atual do workspace, incluindo informações do plano e configurações.
- [Uso da Equipe](https://docs.pubrio.com/pt/api-reference/endpoint/profile/profile-usage.md): Recupera as estatísticas de uso de créditos e cota do perfil atual do workspace.
- [Detalhes do Usuário](https://docs.pubrio.com/pt/api-reference/endpoint/user/user.md): Recupera os detalhes do usuário atualmente autenticado.

#### Chaves de API

- [Listar Logs de Requisições da API](https://docs.pubrio.com/pt/api-reference/endpoint/api-keys/logs.md): Recupera uma lista paginada de logs de requisições da API para o workspace. Cada entrada resume uma única requisição feita com uma `pubrio-api-key`, incluindo o caminho, o método, o código de status, a duração, o tamanho da resposta e o custo em créditos. Use o endpoint [Look up log details](/api-re…
- [Consultar Log de Requisição da API](https://docs.pubrio.com/pt/api-reference/endpoint/api-keys/logs_lookup.md): Recupera o corpo da requisição, os cabeçalhos da requisição, o corpo da resposta e o tamanho da resposta completos de uma entrada específica de log de requisição da API. Use isso para inspecionar o que foi enviado ou retornado para um determinado `query_log_id` descoberto pelo endpoint de listagem.
- [Uso Diário da API](https://docs.pubrio.com/pt/api-reference/endpoint/api-keys/usage_daily.md): Recupera um detalhamento diário das requisições da API e dos créditos consumidos pelo workspace dentro de um intervalo de datas. A resposta inclui uma série temporal por dia e uma série empilhada por endpoint, adequada para a construção de gráficos de uso.
- [Detalhamento de Uso da API](https://docs.pubrio.com/pt/api-reference/endpoint/api-keys/usage_breakdown.md): Recupera um detalhamento das requisições da API e dos créditos consumidos dentro de um intervalo de datas, agrupado tanto por chave de API individual (`by_key`) quanto por endpoint (`by_endpoint`). Útil para identificar as chaves com maior tráfego e os endpoints que mais consomem créditos em todo o…

#### Enriquecimento

- [Consulta e Enriquecimento de Empresas](https://docs.pubrio.com/pt/api-reference/endpoint/companies/enrichment.md): Enriquecimento de empresa em tempo real. Retorna o registro da empresa junto com seus sinais recentes de contratação, mídia, publicidade e empresas semelhantes em uma única chamada.

#### Lookalike

- [Busca de Empresas Lookalike](https://docs.pubrio.com/pt/api-reference/endpoint/companies/similar.md): **Descontinuado.** Use `POST /companies/search/similar` em vez deste. O corpo da requisição é o mesmo; os resultados são retornados em `data.lookalikes` com um objeto `data.pagination`.
- [Buscar Empresas Semelhantes](https://docs.pubrio.com/pt/api-reference/endpoint/companies/search_similar.md): Encontra empresas semelhantes a uma empresa de referência. Informe exatamente um identificador singular (`domain_search_id`, `domain`, `linkedin_url` ou outro `*_url`). Cada linha traz um `similarity_score` entre 0 e 1.
- [Buscar Pessoas Similares](https://docs.pubrio.com/pt/api-reference/endpoint/people/search_similar.md): Encontra pessoas semelhantes a uma pessoa ou cargo de referência. Informe uma referência (`people_search_id`, `linkedin_url`, `linkedin_urls`, `peoples` ou `people_titles`). Cada pessoa traz um `similarity_score` entre 0 e 1. A referência apenas define o que significa semelhante; qualquer outro filt…

#### Consulta

- [Consulta de Empresa](https://docs.pubrio.com/pt/api-reference/endpoint/companies/lookup.md): Recupera informações detalhadas sobre uma empresa específica usando o ID de busca da Pubrio, o domínio ou a URL do LinkedIn.
- [Consulta de Empresa Lookalike (Alias)](https://docs.pubrio.com/pt/api-reference/endpoint/companies/similar_lookup.md): Alias legado de Company Lookup: retorna o registro único da empresa para um ID de busca da Pubrio, um domínio ou uma URL do LinkedIn. Para encontrar empresas semelhantes, use Similar Company Search.
- [Consulta de Vagas de Empresas](https://docs.pubrio.com/pt/api-reference/endpoint/companies/job_lookup.md): Recupera os detalhes de uma vaga de emprego para uma empresa específica usando um ID de busca de vaga.
- [Consulta de Notícias de Empresas](https://docs.pubrio.com/pt/api-reference/endpoint/companies/news_lookup.md): Recupera os detalhes de um artigo de notícia para uma empresa específica usando um ID de busca de notícia.
- [Consulta de Anúncios de Empresas](https://docs.pubrio.com/pt/api-reference/endpoint/companies/advertisements_lookup.md): Recupera os detalhes de um anúncio para uma empresa específica usando um ID de busca de anúncio. A resposta inclui a `destination_url` resolvida, a `raw_link_url` original e, para anúncios da Meta, `publisher_platforms`.
- [Consulta de Pegada Cloud de Empresas](https://docs.pubrio.com/pt/api-reference/endpoint/companies/cloud_footprints_lookup.md): Devolve uma única linha de pegada cloud pelo seu identificador, com as regiões cloud, cidades e uma amostra recente da infraestrutura. Consulte o [guia de pesquisa de pegada cloud](/pt/developer-guides/search/cloud-footprint-search).
- [Consulta de Tecnologias de Empresas](https://docs.pubrio.com/pt/api-reference/endpoint/companies/technology_lookup.md): Recupera informações detalhadas sobre uma tecnologia específica usada por empresas.
- [Consulta de Pessoas](https://docs.pubrio.com/pt/api-reference/endpoint/people/lookup.md): Recupera informações detalhadas sobre uma pessoa específica usando o ID de busca da Pubrio ou a URL do LinkedIn.

#### Busca

- [Busca de Empresas](https://docs.pubrio.com/pt/api-reference/endpoint/companies/search.md): Busca no banco de dados da Pubrio por empresas que correspondam a critérios especificados, como setor, tamanho, localização e tecnologias.
- [Busca de Vagas de Empresas](https://docs.pubrio.com/pt/api-reference/endpoint/companies/job_search.md): Busca vagas de emprego. Consulte o [guia de Job Search](/pt/developer-guides/search/job-search).
- [Busca de Notícias de Empresas](https://docs.pubrio.com/pt/api-reference/endpoint/companies/news_search.md): Busca notícias sobre empresas. Consulte o [guia de News Search](/pt/developer-guides/search/news-search).
- [Busca de Anúncios de Empresas](https://docs.pubrio.com/pt/api-reference/endpoint/companies/advertisements_search.md): Busca anúncios veiculados por empresas. Consulte o [guia de Advertisement Search](/pt/developer-guides/search/advertisement-search).
- [Busca de Pegada Cloud de Empresas](https://docs.pubrio.com/pt/api-reference/endpoint/companies/cloud_footprints_search.md): Pesquise a pegada pública de cloud e alojamento das empresas: que fornecedores usam e em que países e regiões implementam. Cada linha é uma empresa num fornecedor e num país. Consulte o [guia de pesquisa de pegada cloud](/pt/developer-guides/search/cloud-footprint-search).
- [Busca de Pessoas](https://docs.pubrio.com/pt/api-reference/endpoint/people/search.md): Busca no banco de dados da Pubrio por pessoas que correspondam a critérios especificados, como cargo, localização, empresa e senioridade.

#### Insights

- [Insights de Vagas de Empresas](https://docs.pubrio.com/pt/api-reference/endpoint/companies/job_insights.md): Insights agregados de sinais de contratação de uma empresa ao longo de uma janela de datas: volume de vagas publicadas, distribuição por senioridade, principais funções/departamentos/localizações e uma série temporal semanal.
- [Insights de Notícias de Empresas](https://docs.pubrio.com/pt/api-reference/endpoint/companies/news_insights.md): Insights agregados de sinais de notícias de uma empresa ao longo de uma janela de datas: volume de menções, principais tópicos e fontes, detalhamentos por categoria e mercado, e uma série temporal semanal.
- [Insights de Anúncios de Empresas](https://docs.pubrio.com/pt/api-reference/endpoint/companies/advertisements_insights.md): Insights agregados de sinais publicitários de uma empresa ao longo de uma janela de datas: contagens de anúncios ativos e lançados, mix de canais e posicionamentos, exemplos de criativos, alcance de audiência como distribuição por faixas, e uma série temporal semanal. O alcance é reportado como uma…
- [Insights de Pegada Cloud de Empresas](https://docs.pubrio.com/pt/api-reference/endpoint/companies/cloud_footprints_insights.md): A pegada cloud de uma empresa numa única chamada: totais, principais fornecedores, países e regiões, novos hosts por semana, os hosts mais recentes e alertas para as alterações que justificam agir. Consulte o [guia de Análise de pegada cloud](/pt/developer-guides/search/cloud-footprint-insights).

#### Expansão

- [Visão Geral de Expansão](https://docs.pubrio.com/pt/api-reference/endpoint/expansions/dashboard.md): KPIs de expansão em nível de mercado — contagens de estágio por mercado e os principais fluxos transfronteiriços. Agregado, não paginado. Responde `408` quando a requisição não pode ser concluída a tempo.
- [Busca de Expansão](https://docs.pubrio.com/pt/api-reference/endpoint/expansions/market_lookup.md): Encontra empresas em expansão para um ou mais mercados usando filtros firmográficos e de sinal ou uma consulta em linguagem natural, com explicações opcionais de correspondência geradas por IA, fundamentadas nos sinais reais de cada empresa. Envie pelo menos um entre `tos`, `froms`, `companies` ou `…
- [Detalhes de Expansão da Empresa](https://docs.pubrio.com/pt/api-reference/endpoint/expansions/company_lookup.md): Perfil de expansão detalhado de uma única empresa — estágio atual, sinais, presença de mercado e histórico de transição de estágio — para um mercado ou agregado em todos os mercados.
- [Comparar Expansões de Empresas](https://docs.pubrio.com/pt/api-reference/endpoint/expansions/company_compare.md): Compara a presença de expansão de várias empresas lado a lado, com pares comparáveis opcionais para uma empresa-alvo.
- [Resumos em Lote de Expansão de Empresas](https://docs.pubrio.com/pt/api-reference/endpoint/expansions/company_summaries.md): Resumos de expansão prontos para renderização de um lote de empresas, preparados para comparação lado a lado sem agregação no cliente.
- [Eventos de Sinal da Empresa](https://docs.pubrio.com/pt/api-reference/endpoint/expansions/company_pulse_events.md): Detalhamento paginado e enriquecido dos eventos de sinal que impulsionam a expansão de uma única empresa.
- [Classificações de Expansão](https://docs.pubrio.com/pt/api-reference/endpoint/expansions/company_markers.md): Lista classificada leve de pares empresa/mercado por score de expansão — adequada para renderização em mapa ou mapa de calor.
- [Busca de Sinais de Expansão](https://docs.pubrio.com/pt/api-reference/endpoint/expansions/signal_search.md): Linhas brutas e paginadas de sinais de expansão — a evidência datada por trás do estágio de cada empresa, com fonte e URL de evidência.

#### Resgate

- [Resgatar Pessoas - Individual](https://docs.pubrio.com/pt/api-reference/endpoint/redeem/people.md): Gasta créditos para desbloquear os dados de contato completos (email, telefone) de uma pessoa específica.
- [Resgatar Pessoas - Em Lote](https://docs.pubrio.com/pt/api-reference/endpoint/redeem/people/batch.md): Envia uma solicitação em lote para desbloquear os dados de contato de várias pessoas de uma só vez.
- [Resgatar Pessoas - Status em Lote](https://docs.pubrio.com/pt/api-reference/endpoint/redeem/people/batch/query.md): Verifica o status e os resultados de uma solicitação de resgate em lote enviada anteriormente.
- [Consulta de Contato - Individual](https://docs.pubrio.com/pt/api-reference/endpoint/redeem/people/contact/lookup.md): Faz a busca reversa de uma pessoa por email, telefone ou nome e sobrenome mais domínio ou empresa. Retorna o `people_search_id` e os dados básicos da pessoa correspondida, além dos metadados `match` que descrevem como a correspondência foi feita. Cobra 1 crédito por correspondência faturável.
- [Consulta de Contato - Em Lote](https://docs.pubrio.com/pt/api-reference/endpoint/redeem/people/contact/lookup/batch.md): Versão em lote de `/redeem/people/contact/lookup`. Envie até o limite de tamanho em lote da sua assinatura em uma única requisição. Cada entrada em `peoples` aceita os mesmos identificadores do corpo da busca individual. Cobra 1 crédito por correspondência faturável. Entradas duplicadas (o mesmo ema…

#### LinkedIn

- [Consulta de Empresa no LinkedIn (Tempo Real)](https://docs.pubrio.com/pt/api-reference/endpoint/companies/linkedin_lookup.md): Recupera os detalhes da empresa usando a URL da página da empresa no LinkedIn. Fornece recuperação de dados em tempo real.
- [Consulta de Pessoas no LinkedIn (Tempo Real)](https://docs.pubrio.com/pt/api-reference/endpoint/people/linkedin_lookup.md): Recupera os detalhes da pessoa usando uma URL de perfil do LinkedIn. Fornece recuperação de dados em tempo real.

#### Canais

##### Tipos

- [Tipo de Modelo de Canal](https://docs.pubrio.com/pt/api-reference/endpoint/channels/types/template_types.md): Recupera os tipos de canal disponíveis para modelos de prospecção.

##### Modelos

- [Modelos de Canal](https://docs.pubrio.com/pt/api-reference/endpoint/channels/templates/templates.md): Recupera uma lista de todos os modelos de contato do workspace.
- [Criar Modelo de Canal](https://docs.pubrio.com/pt/api-reference/endpoint/channels/templates/create.md): Cria um novo modelo de canal de contato com os parâmetros especificados.
- [Criar Versão de Modelo de Canal](https://docs.pubrio.com/pt/api-reference/endpoint/channels/templates/create_version.md): Cria uma nova versão de um modelo de canal existente.
- [Definir Modelo de Canal Padrão](https://docs.pubrio.com/pt/api-reference/endpoint/channels/templates/default.md): Recupera o modelo de canal padrão do workspace.
- [Consulta de Modelo de Canal](https://docs.pubrio.com/pt/api-reference/endpoint/channels/templates/lookup.md): Recupera os detalhes de um modelo de canal específico por ID.
- [Atualizar Modelo de Canal](https://docs.pubrio.com/pt/api-reference/endpoint/channels/templates/update.md): Atualiza a configuração de um modelo de canal existente.
- [Excluir Modelo de Canal](https://docs.pubrio.com/pt/api-reference/endpoint/channels/templates/delete.md): Exclui um modelo de canal do workspace.

#### Monitoramento

- [Obter Lista de Monitores](https://docs.pubrio.com/pt/api-reference/endpoint/monitors/monitors.md): Recupera uma lista de todos os monitores no workspace.
- [Criar Monitor](https://docs.pubrio.com/pt/api-reference/endpoint/monitors/create.md): Cria um monitor de dados: uma vigilância sempre ativa que traz continuamente os sinais de negócio que importam para você — novas vagas de emprego, notícias, anúncios ou movimentos de expansão de mercado — a partir das empresas e filtros que você define, enriquece cada correspondência com dados de em…
- [Interpretar Monitor](https://docs.pubrio.com/pt/api-reference/endpoint/monitors/interpret.md): Visualize um monitor antes de criá-lo — transforme um pedido em linguagem natural (em qualquer idioma) em uma configuração de **rascunho** validada que você pode inspecionar, ajustar e depois enviar para [Create Monitor](/pt/api-reference/endpoint/monitors/create). É seguro chamar quantas vezes prec…
- [Atualizar Monitor](https://docs.pubrio.com/pt/api-reference/endpoint/monitors/update.md): Atualiza a configuração e as regras de detecção de um monitor existente.
- [Duplicar Monitor](https://docs.pubrio.com/pt/api-reference/endpoint/monitors/duplicate.md): Cria uma cópia de um monitor existente com a mesma configuração.
- [Excluir Monitor](https://docs.pubrio.com/pt/api-reference/endpoint/monitors/delete.md): Exclui um monitor do workspace.
- [Consulta de Monitor](https://docs.pubrio.com/pt/api-reference/endpoint/monitors/lookup.md): Recupera informações detalhadas sobre um monitor específico.
- [Revelar Assinatura do Monitor](https://docs.pubrio.com/pt/api-reference/endpoint/monitors/signature_reveal.md): Recupera o segredo de assinatura do webhook de um monitor.
- [Validar Webhook do Monitor](https://docs.pubrio.com/pt/api-reference/endpoint/monitors/webhook_validate.md): Envia um payload de teste assinado para uma URL de webhook e informa se ele foi aceito.

##### Estatísticas

- [Estatísticas do Monitor](https://docs.pubrio.com/pt/api-reference/endpoint/monitors/statistics.md): Recupera uma visão geral, em todo o workspace, das estatísticas de acionamento de monitores. Não há parâmetro monitor_id — os números são agregados entre todos os monitores do workspace (monitores baseados em watchlist são excluídos).
- [Logs de Estatísticas do Monitor](https://docs.pubrio.com/pt/api-reference/endpoint/monitors/statistics_logs.md): Recupera uma lista paginada de logs de detecção de um monitor específico.
- [Consulta de Log de Estatísticas do Monitor](https://docs.pubrio.com/pt/api-reference/endpoint/monitors/statistics_logs_lookup.md): Recupera os detalhes de uma entrada específica de log de detecção de monitor.
- [Gráfico de Estatísticas do Monitor](https://docs.pubrio.com/pt/api-reference/endpoint/monitors/statistics_chart.md): Recupera dados de série temporal, prontos para exibição em gráfico, de um monitor.

##### Processamento

- [Testar Processamento do Monitor](https://docs.pubrio.com/pt/api-reference/endpoint/monitors/process_try.md): Executa um monitor salvo por id, ou executa uma configuração ad-hoc não salva passando a configuração inline; com monitor_id, os campos inline substituem o monitor salvo para esta execução.
- [Repetir Processamento do Monitor](https://docs.pubrio.com/pt/api-reference/endpoint/monitors/process_retry.md): Reenvia uma execução de processamento de monitor que falhou.

#### Filtros

- [Tecnologias](https://docs.pubrio.com/pt/api-reference/endpoint/technologies/technologies.md): Recupera a lista de tecnologias disponíveis para os filtros de busca.
- [Categorias de Tecnologia](https://docs.pubrio.com/pt/api-reference/endpoint/technologies/categories.md): Recupera a lista de categorias de tecnologia para filtragem.
- [Localizações](https://docs.pubrio.com/pt/api-reference/endpoint/locations/locations.md): Recupera a lista de localizações disponíveis para os filtros de busca.
- [Porte da Empresa](https://docs.pubrio.com/pt/api-reference/endpoint/company-size/company-size.md): Recupera a lista de categorias de porte de empresa para filtragem.
- [Níveis de Gestão](https://docs.pubrio.com/pt/api-reference/endpoint/management-levels/management-levels.md): Recupera a lista de níveis hierárquicos e de senioridade para filtragem.
- [Departamentos](https://docs.pubrio.com/pt/api-reference/endpoint/departments/departments.md): Recupera a lista de cargos de departamento para filtragem.
- [Função do Departamento](https://docs.pubrio.com/pt/api-reference/endpoint/departments/function.md): Recupera a lista de funções de departamento para filtragem.
- [Setores](https://docs.pubrio.com/pt/api-reference/endpoint/verticals/verticals.md): Recupera a lista de verticais de setor para filtragem.
- [Categorias de Setores](https://docs.pubrio.com/pt/api-reference/endpoint/verticals/vertical_categories.md): Recupera a lista de categorias de vertical para filtragem.
- [Subcategorias de Setores](https://docs.pubrio.com/pt/api-reference/endpoint/verticals/vertical_sub_categories.md): Recupera a lista de subcategorias de vertical para filtragem.
- [Categorias de Notícias](https://docs.pubrio.com/pt/api-reference/endpoint/news/categories.md): Recupera a lista de categorias de artigos de notícias para filtragem.
- [Galerias de Notícias](https://docs.pubrio.com/pt/api-reference/endpoint/news/galleries.md): Recupera a lista de galerias de notícias para filtragem.
- [Idiomas de Notícias](https://docs.pubrio.com/pt/api-reference/endpoint/news/languages.md): Recupera a lista de idiomas disponíveis para filtragem de notícias.
- [Filtros de Expansão](https://docs.pubrio.com/pt/api-reference/endpoint/expansions/types.md): Catálogo de referência da taxonomia de expansão — estágios, tipos de sinal, intensidades, polaridades, momentum e atualidade — usado para resolver os valores retornados pelos demais endpoints de expansão.

#### Diversos

- [Fusos Horários](https://docs.pubrio.com/pt/api-reference/endpoint/timezones/timezones.md): Recupera a lista de fusos horários suportados.

## OpenAPI Specs

- [pt-openapi](/pt/api-reference/pt-openapi.json)