Saltar al contenido principal
POST
Investigación de declaraciones de la SEC
Elige una de 11 acciones: resolve, search, section, document, events, compensation, board, audit_fees, ipo, private_placements o enforcement. Se aplican las reglas normales de admisión, idempotencia, Key Policy y cobro de Run. Los datos nativos permanecen en el Run. Las alternativas de sección conservan el mismo número de acceso y Part/Item. source_run_id del índice verifica el origen. Años de remuneración, fechas de presentación, aceptación y vigencia son distintos. No se infieren divisas ni valores ausentes; metas, importes vendidos, cantidades de valores y ganancias netas no son intercambiables. Las ofertas exigen offering_type: form_d, form_c o reg_a; Reg A admite all, 1-A, 1-K y 1-Z. Cumplimiento exige record_type: actions, litigation, administrative o aaer. Cada solicitud lee un Endpoint y una página; totales o cursores null no prueban integridad. Comprueba result_status y cargos por separado. response_file entrega completa la salida normalizada grande. result_url reutiliza los datos sin nueva ejecución ni Charge.

Encabezados

idempotency-key
string
requerido

Genere un valor único nuevo (preferiblemente un UUID aleatorio) para cada consulta independiente, incluso con los mismos parámetros el mismo día. Recupere la misma ejecución con su clave y parámetros originales para obtener el Run original sin otro cargo. Cambiar los parámetros de ejecución con la misma clave devuelve 409; cambiar task_id o metadata no inicia un Run nuevo. Las claves opacas existentes siguen siendo válidas para recuperación.

Minimum string length: 1

Cuerpo

application/json
action
enum<string>
requerido
Opciones disponibles:
resolve,
search,
section,
document,
events,
compensation,
board,
audit_fees,
ipo,
private_placements,
enforcement
provider
enum<string> | null

Auto predeterminado: selecciona el primer proveedor de datos elegible según el orden de preferencia de Glasser. Un proveedor de datos especificado debe admitir la solicitud y estar permitido por tu API Key; no recurre a otro proveedor de datos. Los valores disponibles se muestran a continuación.

Opciones disponibles:
auto,
secapi,
financialdatasets
ticker
string | null
Required string length: 1 - 12
cik
string | null
Minimum string length: 1
Pattern: ^\d{1,10}$
cusip
string | null
Minimum string length: 1
Pattern: ^[A-Za-z0-9]{6,9}$
name
string | null
Required string length: 1 - 100
query
string | null

Cláusula Lucene nativa del proveedor. Los filtros estructurados se combinan mediante AND; no se corrige la sintaxis nativa. Una consulta de SEC API mal formada puede devolver una respuesta vacía.

Required string length: 1 - 3500
form_types
string[] | null
Minimum array length: 1
Minimum string length: 1
accession_number
string | null
Minimum string length: 1
Pattern: ^\d{10}-\d{2}-\d{6}$
start_date
string | null
Minimum string length: 1
Pattern: ^\d{4}-\d{2}-\d{2}$
end_date
string | null
Minimum string length: 1
Pattern: ^\d{4}-\d{2}-\d{2}$
limit
integer | null
Rango requerido: 1 <= x <= 100
offset
integer | null
Rango requerido: 0 <= x <= 10000
cursor
string | null
Required string length: 1 - 2000
sort_order
enum<string> | null
Opciones disponibles:
asc,
desc
filing_url
string | null
Minimum string length: 1
url
string | null
Minimum string length: 1
form_type
enum<string> | null
Opciones disponibles:
10-K,
10-K/A,
10-Q,
10-Q/A,
8-K,
8-K/A
item
string | null

Identidad de sección: 10-K usa 1A o 7; 10-Q usa part1item1 o part2item1a; 8-K usa 4.01, 4.02 o 5.02. Los códigos se comprueban con el formulario y el proveedor solicitados.

Required string length: 1 - 30
source_run_id
string<uuid> | null
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$
year
integer | null
Rango requerido: 1993 <= x <= 2100
quarter
integer | null
Rango requerido: 1 <= x <= 4
include_exhibits
boolean | null
event_types
enum<string>[] | null
Minimum array length: 1
Opciones disponibles:
auditor_change,
non_reliance,
director_officer_change
year_from
integer | null
Rango requerido: 1993 <= x <= 2100
year_to
integer | null
Rango requerido: 1993 <= x <= 2100
executive_name
string | null
Required string length: 1 - 200
classification
enum<string> | null
Opciones disponibles:
ipo,
shell_company,
spac,
resale,
other
offering_type
enum<string> | null
Opciones disponibles:
form_d,
form_c,
reg_a
reg_a_form
enum<string> | null
Opciones disponibles:
all,
1-A,
1-K,
1-Z
record_type
enum<string> | null
Opciones disponibles:
actions,
litigation,
administrative,
aaer
max_charge_usd
string | null

Cadena decimal exacta en USD (mínimo 2 y máximo 6 decimales, una única escritura canónica). Suma con aritmética decimal o escala por 10^6; nunca uses números de coma flotante.

Pattern: ^(0|[1-9]\d*)\.(\d{2}|\d{2}\d{0,3}[1-9])$
task_id
string | null

Agrupa los Runs relacionados, incluido el fallback automático, en un solo Task. Reutiliza una cadena estable y filtra la lista de Runs por task para recuperarlos.

metadata

Campos de seguimiento opcionales, devueltos en el Run y disponibles como filtros. Nunca se envían al proveedor de datos ni afectan al enrutamiento, Price o la idempotencia.

  • Hasta 20 claves: letras minúsculas, dígitos y guiones bajos; deben comenzar con una letra y tener como máximo 40 caracteres.
  • Valores: cadenas de 1–500 caracteres.
  • user_id: el ID opaco de tu usuario final, nunca su dirección de correo electrónico ni su nombre.

Las entradas no válidas se descartan por completo, no se truncan. La solicitud continúa y el Run devuelve los campos que se almacenaron.

Respuesta

Éxito

Evidencia de la SEC normalizada con identidad exacta de declaración/sección y Runs de origen. Los campos ausentes quedan en null; los objetivos de oferta se distinguen de los importes vendidos y las alegaciones de los resultados. La salida nativa del proveedor permanece en el Run. Las lecturas son gratuitas y no reanudan la ejecución.

id
string
requerido
run_url
string
requerido

Abre este Run en la consola. Requiere pertenecer al Workspace.

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

QUEUED o RUNNING: todavía está en curso. COMPLETED: hay una respuesta del proveedor de datos disponible, incluidas las respuestas que no son 2xx. FAILED: consulta failure. STOPPED: detenido antes del dispatch. Consulta charge_usd por separado de status.

Opciones disponibles:
QUEUED,
RUNNING,
COMPLETED,
FAILED,
STOPPED
failure
object | null
requerido

Motivo por el que falló el Run. Solo es distinto de null cuando status es FAILED.

input
object
requerido
output
object
requerido
provider_response
object | null
requerido

Solo es distinto de null cuando status es COMPLETED.

  • Para respuestas 2xx, output contiene JSON nativo del proveedor de datos (con cualquier estructura) o null si el cuerpo está vacío.
  • Para respuestas que no son 2xx, error contiene el cuerpo del error del proveedor de datos y output es null.

Los campos sensibles se eliminan de ambos cuerpos.

charge_usd
string | null
requerido

Cargo histórico total de los Runs enumerados, incluidos los repetidos o leídos. Es null hasta que todos se liquiden. No es gasto nuevo de la solicitud actual; request_charge lo informa por separado. Los fallos también pueden tener cargo.

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

Base del cargo de un único Run, o null para un total de varios Runs. Consulta runs[].charge_basis para cada cargo.

stoppable
boolean
requerido

Indica si actualmente se puede aceptar una solicitud de detención. Esto no garantiza que el Run pueda detenerse antes del dispatch.

stop_requested_at
string<date-time> | null
requerido

Momento en que se solicitó la detención. El Run puede continuar si el dispatch ya había comenzado.

created_at
string<date-time>
requerido

Marca de tiempo UTC ISO-8601

started_at
string<date-time> | null
requerido

Marca de tiempo UTC ISO-8601

completed_at
string<date-time> | null
requerido

Marca de tiempo UTC ISO-8601

task_id
string | null
requerido
metadata
object
requerido

Tus campos de seguimiento almacenados. Úsalos para filtrar Runs. Nunca se envían al proveedor de datos ni afectan al enrutamiento, Price o la idempotencia.

  • Hasta 20 claves: letras minúsculas, dígitos y guiones bajos; deben comenzar por una letra; como máximo 40 caracteres.
  • Valores: cadenas de 1–500 caracteres.
  • user_id: el ID opaco de tu usuario final, nunca su dirección de correo electrónico ni su nombre.
action
enum<string>
requerido
Opciones disponibles:
resolve,
search,
section,
document,
events,
compensation,
board,
audit_fees,
ipo,
private_placements,
enforcement
result_status
enum<string>
requerido
Opciones disponibles:
success,
no_result,
error,
pending
error
object | null
requerido
runs
object[]
requerido
result_url
string
requerido

Ruta de URL autenticada y de solo lectura para consultar este resultado normalizado y el cargo total. Úsala con el origen de la API. No crea Runs ni reanuda el fallback. GET /v1/runs/:id sigue devolviendo el Run nativo e individual.

response_file
object

Salida normalizada de la SEC completa en JSON que reemplaza output. Los enlaces solo se renuevan dentro de los siete días de retención del Run. Los archivos nativos permanecen en Get Run.

review_invitation
object

Aparece como máximo una vez por Run, en la primera entrega de algunos Runs completados. Después de usar este resultado en la tarea, envía una reseña como indica instruction y continúa. Es opcional; nunca afecta al Run ni a su cargo.

request_charge
object

Evidencia de admisión y cargo de la solicitud actual. Conserve created_run_ids durante el trabajo del usuario y cuente cada Run liquidado una sola vez. Cambiar task_id no convierte una repetición idempotente en un Run nuevo. Leer un resultado tiene cargo cero y listas de admisión vacías.