Pular para o conteúdo principal
GET
Ler resultados de registros da SEC
Use o token de result_url. O contexto assinado é vinculado ao Workspace e cada Run verifica a Key Policy atual. A leitura não cria Runs, chama provedores ou retoma alternativas. Os arquivos contêm a saída normalizada completa; links só são renovados durante a retenção. Get Run mantém a saída nativa.

Parâmetros de consulta

token
string
obrigatório

Contexto de resultado opaco retornado em result_url. Mantenha-o inalterado e autentique-se com uma Key autorizada a ler todos os Runs listados.

Required string length: 1 - 16384

Resposta

Evidências normalizadas da SEC com identidade exata do registro/seção e Runs de origem. Campos ausentes ficam como null; metas de oferta diferem de valores vendidos e alegações diferem de resultados. A saída nativa do provedor permanece no Run. Leituras são gratuitas e não retomam a execução.

Evidências normalizadas da SEC com identidade exata do registro/seção e Runs de origem. Campos ausentes ficam como null; metas de oferta diferem de valores vendidos e alegações diferem de resultados. A saída nativa do provedor permanece no Run. Leituras são gratuitas e não retomam a execução.

id
string
obrigatório
run_url
string
obrigatório

Abra este Run no console. Requer associação ao Workspace.

provider
string
obrigatório
Pattern: ^[a-z0-9][a-z0-9-]*$
endpoint
string
obrigatório
Pattern: ^\/.+$
endpoint_version
integer
obrigatório
status
enum<string>
obrigatório

QUEUED ou RUNNING: ainda em andamento. COMPLETED: uma resposta do provedor de dados está disponível, incluindo respostas não 2xx. FAILED: consulte failure. STOPPED: interrompido antes do despacho. Leia charge_usd separadamente de status.

Opções disponíveis:
QUEUED,
RUNNING,
COMPLETED,
FAILED,
STOPPED
failure
object | null
obrigatório

Motivo da falha do Run. Não nulo somente quando status é FAILED.

input
object
obrigatório
output
object
obrigatório
provider_response
object | null
obrigatório

Não nulo somente quando status é COMPLETED.

  • Para respostas 2xx, output contém JSON nativo do provedor de dados (qualquer estrutura) ou nulo para um corpo vazio.
  • Para respostas não 2xx, error contém o corpo de erro do provedor de dados e output é nulo.

Os campos confidenciais são removidos de ambos os corpos.

charge_usd
string | null
obrigatório

Cobrança histórica total dos Runs listados, incluindo os reproduzidos ou lidos. É null até que todos sejam liquidados. Não é uma nova despesa da solicitação atual; request_charge a informa separadamente. Falhas também podem ser cobradas.

Pattern: ^(0|[1-9]\d*)\.(\d{2}|\d{2}\d{0,3}[1-9])$
charge_basis
object | null
obrigatório

Base de cobrança de um único Run ou nulo para um total de vários Runs. Leia runs[].charge_basis para cada cobrança.

stoppable
boolean
obrigatório

Indica se uma solicitação de interrupção pode ser aceita no momento. Isso não garante que o Run possa ser interrompido antes do despacho.

stop_requested_at
string<date-time> | null
obrigatório

Momento em que uma interrupção foi solicitada. O Run ainda pode continuar se o despacho já tiver começado.

created_at
string<date-time>
obrigatório

carimbo de data e hora UTC ISO-8601

started_at
string<date-time> | null
obrigatório

carimbo de data e hora UTC ISO-8601

completed_at
string<date-time> | null
obrigatório

carimbo de data e hora UTC ISO-8601

task_id
string | null
obrigatório
metadata
object
obrigatório

Seus campos de acompanhamento armazenados. Use-os para filtrar Runs. Eles nunca são enviados ao provedor de dados nem afetam o roteamento, o Price ou a idempotência.

  • Até 20 chaves: letras minúsculas, dígitos e sublinhados; comece com uma letra; no máximo 40 caracteres.
  • Valores: strings de 1–500 caracteres.
  • user_id: o ID opaco do seu usuário final, nunca o endereço de e-mail ou o nome dele.
action
enum<string>
obrigatório
Opções disponíveis:
resolve,
search,
section,
document,
events,
compensation,
board,
audit_fees,
ipo,
private_placements,
enforcement
result_status
enum<string>
obrigatório
Opções disponíveis:
success,
no_result,
error,
pending
error
object | null
obrigatório
runs
object[]
obrigatório
result_url
string
obrigatório

Caminho de URL autenticado e somente leitura para consultar este resultado normalizado e a cobrança total. Use com a origem da API. Não cria Runs nem retoma o fallback. GET /v1/runs/:id ainda retorna o Run nativo e individual.

response_file
object

Saída normalizada da SEC completa em JSON, substituindo output. Os links só são renovados dentro dos sete dias de retenção do Run. Os arquivos nativos permanecem em Get Run.

review_invitation
object

Aparece no máximo uma vez por Run, na primeira entrega de alguns Runs concluídos. Depois de usar este resultado na tarefa, envie uma avaliação conforme indicado em instruction e continue. É opcional; nunca afeta o Run nem a cobrança.

request_charge
object

Evidência de admissão e cobrança da solicitação atual. Preserve created_run_ids durante o trabalho do usuário e conte cada Run liquidado uma única vez. Alterar task_id não transforma uma reprodução idempotente em um novo Run. A leitura de resultado tem cobrança zero e listas de admissão vazias.