finance.filings.get

POST

ops

finance.filings.get

Extract one named section (Risk Factors, MD&A, Business …) of a 10-K / 10-Q / 8-K filing as plain text or HTML. Returns a Filing with text and sections filled.

curl --request POST \
  --url https://api.agentkey.app/v2/ops/finance.filings.get \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "<string>",
  "fields": [
    "<string>"
  ],
  "format": "text",
  "include_raw": false,
  "provider": "<string>",
  "routing": {
    "allow_fallbacks": true,
    "only": [
      "<string>"
    ],
    "order": [
      "<string>"
    ],
    "strategy": "auto"
  }
}
'

import requests

url = "https://api.agentkey.app/v2/ops/finance.filings.get"

payload = {
    "url": "<string>",
    "fields": ["<string>"],
    "format": "text",
    "include_raw": False,
    "provider": "<string>",
    "routing": {
        "allow_fallbacks": True,
        "only": ["<string>"],
        "order": ["<string>"],
        "strategy": "auto"
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    url: '<string>',
    fields: ['<string>'],
    format: 'text',
    include_raw: false,
    provider: '<string>',
    routing: {
      allow_fallbacks: true,
      only: ['<string>'],
      order: ['<string>'],
      strategy: 'auto'
    }
  })
};

fetch('https://api.agentkey.app/v2/ops/finance.filings.get', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.agentkey.app/v2/ops/finance.filings.get",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'url' => '<string>',
    'fields' => [
        '<string>'
    ],
    'format' => 'text',
    'include_raw' => false,
    'provider' => '<string>',
    'routing' => [
        'allow_fallbacks' => true,
        'only' => [
                '<string>'
        ],
        'order' => [
                '<string>'
        ],
        'strategy' => 'auto'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.agentkey.app/v2/ops/finance.filings.get"

	payload := strings.NewReader("{\n  \"url\": \"<string>\",\n  \"fields\": [\n    \"<string>\"\n  ],\n  \"format\": \"text\",\n  \"include_raw\": false,\n  \"provider\": \"<string>\",\n  \"routing\": {\n    \"allow_fallbacks\": true,\n    \"only\": [\n      \"<string>\"\n    ],\n    \"order\": [\n      \"<string>\"\n    ],\n    \"strategy\": \"auto\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.agentkey.app/v2/ops/finance.filings.get")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"url\": \"<string>\",\n  \"fields\": [\n    \"<string>\"\n  ],\n  \"format\": \"text\",\n  \"include_raw\": false,\n  \"provider\": \"<string>\",\n  \"routing\": {\n    \"allow_fallbacks\": true,\n    \"only\": [\n      \"<string>\"\n    ],\n    \"order\": [\n      \"<string>\"\n    ],\n    \"strategy\": \"auto\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.agentkey.app/v2/ops/finance.filings.get")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"url\": \"<string>\",\n  \"fields\": [\n    \"<string>\"\n  ],\n  \"format\": \"text\",\n  \"include_raw\": false,\n  \"provider\": \"<string>\",\n  \"routing\": {\n    \"allow_fallbacks\": true,\n    \"only\": [\n      \"<string>\"\n    ],\n    \"order\": [\n      \"<string>\"\n    ],\n    \"strategy\": \"auto\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "attempts": [
    {
      "provider": "<string>",
      "status": 123,
      "took_ms": 123,
      "tool": "<string>",
      "error_type": "<string>",
      "refunded": true,
      "upstream_status": 123
    }
  ],
  "credits_charged": 123,
  "data": {
    "cik": "<string>",
    "company": "<string>",
    "description": "<string>",
    "filed_at": "2023-11-07T05:31:56Z",
    "form_type": "<string>",
    "id": "<string>",
    "period": "2023-12-25",
    "sections": [
      {
        "item": "<string>",
        "text": "<string>"
      }
    ],
    "symbol": "<string>",
    "text": "<string>",
    "url": "<string>"
  },
  "op": "<string>",
  "op_version": 123,
  "provider": "<string>",
  "request_id": "<string>",
  "took_ms": 123,
  "unsupported_fields": [
    "<string>"
  ],
  "raw": "<unknown>",
  "raw_truncated": true
}

{
  "code": 123,
  "error": "<string>",
  "error_type": "<string>",
  "attempts": [
    {
      "provider": "<string>",
      "status": 123,
      "took_ms": 123,
      "tool": "<string>",
      "error_type": "<string>",
      "refunded": true,
      "upstream_status": 123
    }
  ],
  "op": "<string>",
  "request_id": "<string>"
}

{
  "code": 123,
  "error": "<string>",
  "error_type": "<string>",
  "attempts": [
    {
      "provider": "<string>",
      "status": 123,
      "took_ms": 123,
      "tool": "<string>",
      "error_type": "<string>",
      "refunded": true,
      "upstream_status": 123
    }
  ],
  "op": "<string>",
  "request_id": "<string>"
}

{
  "code": 123,
  "error": "<string>",
  "error_type": "<string>",
  "attempts": [
    {
      "provider": "<string>",
      "status": 123,
      "took_ms": 123,
      "tool": "<string>",
      "error_type": "<string>",
      "refunded": true,
      "upstream_status": 123
    }
  ],
  "op": "<string>",
  "request_id": "<string>"
}

{
  "code": 123,
  "error": "<string>",
  "error_type": "<string>",
  "attempts": [
    {
      "provider": "<string>",
      "status": 123,
      "took_ms": 123,
      "tool": "<string>",
      "error_type": "<string>",
      "refunded": true,
      "upstream_status": 123
    }
  ],
  "op": "<string>",
  "request_id": "<string>"
}

{
  "code": 123,
  "error": "<string>",
  "error_type": "<string>",
  "attempts": [
    {
      "provider": "<string>",
      "status": 123,
      "took_ms": 123,
      "tool": "<string>",
      "error_type": "<string>",
      "refunded": true,
      "upstream_status": 123
    }
  ],
  "op": "<string>",
  "request_id": "<string>"
}

{
  "code": 123,
  "error": "<string>",
  "error_type": "<string>",
  "attempts": [
    {
      "provider": "<string>",
      "status": 123,
      "took_ms": 123,
      "tool": "<string>",
      "error_type": "<string>",
      "refunded": true,
      "upstream_status": 123
    }
  ],
  "op": "<string>",
  "request_id": "<string>"
}

Authorizations

Authorization

string

header

required

AgentKey API key (ak_…).

Body

application/json

section

enum<string>

required

Section id: 10-K item (1A = Risk Factors, 7 = MD&A), 10-Q part/item (part1item2 = MD&A), or 8-K item (2-2 = Results of Operations).

Available options:

1,

1A,

1B,

1C,

2,

3,

4,

5,

6,

7,

7A,

8,

9,

9A,

9B,

9C,

10,

11,

12,

13,

14,

15,

part1item1,

part1item2,

part1item3,

part1item4,

part2item1,

part2item1a,

part2item2,

part2item3,

part2item4,

part2item5,

part2item6,

1-1,

1-2,

1-3,

1-4,

1-5,

2-1,

2-2,

2-3,

2-4,

2-5,

2-6,

3-1,

3-2,

3-3,

4-1,

4-2,

5-1,

5-2,

5-3,

5-4,

5-5,

5-6,

5-7,

5-8,

6-1,

6-2,

6-3,

6-4,

6-5,

6-6,

6-10,

7-1,

8-1,

9-1,

signature

url

string

required

Primary document URL on www.sec.gov (…/Archives/edgar/data///.htm).

fields

string[]

Projection: keep only these dotted paths of data, e.g. ["items.id", "items.text"].

format

enum<string>

default:text

Return the section as plain text or as the original HTML.

Available options:

text,

html

include_raw

boolean

default:false

Attach the raw upstream payload as raw (not a stable contract; truncated above 256 KB).

provider

string

Shorthand for routing.only = [provider].

routing

object

Provider routing override. order: try these providers first; only: restrict to these (equivalent to pinning); allow_fallbacks: false tries only the first eligible provider.

Show child attributes

Response

Success envelope

Success envelope whose data is a Filing.

attempts

object[]

required

Show child attributes

credits_charged

number

required

Credits charged for this call (the method's fixed price).

data

object

required

A regulatory filing (SEC EDGAR). Search methods fill the metadata; finance.filings.get fills text / sections for one document.

Show child attributes

string

required

Method name.

op_version

integer

required

Method version that served the call.

provider

string

required

Provider that actually served the call.

request_id

string

required

Correlation id; quote it in support requests.

took_ms

integer

required

unsupported_fields

string[]

required

Output paths this provider structurally does not supply; such fields are null for a different reason than 'missing on this record'.

raw

any

Upstream payload, only with include_raw=true. Not a stable contract.

raw_truncated

boolean

Extract one named section (Risk Factors, MD&A, Business …) of a 10-K / 10-Q / 8-K filing as plain text or HTML. Returns a Filing with text and sections filled.

curl --request POST \
  --url https://api.agentkey.app/v2/ops/finance.filings.get \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "<string>",
  "fields": [
    "<string>"
  ],
  "format": "text",
  "include_raw": false,
  "provider": "<string>",
  "routing": {
    "allow_fallbacks": true,
    "only": [
      "<string>"
    ],
    "order": [
      "<string>"
    ],
    "strategy": "auto"
  }
}
'

import requests

url = "https://api.agentkey.app/v2/ops/finance.filings.get"

payload = {
    "url": "<string>",
    "fields": ["<string>"],
    "format": "text",
    "include_raw": False,
    "provider": "<string>",
    "routing": {
        "allow_fallbacks": True,
        "only": ["<string>"],
        "order": ["<string>"],
        "strategy": "auto"
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    url: '<string>',
    fields: ['<string>'],
    format: 'text',
    include_raw: false,
    provider: '<string>',
    routing: {
      allow_fallbacks: true,
      only: ['<string>'],
      order: ['<string>'],
      strategy: 'auto'
    }
  })
};

fetch('https://api.agentkey.app/v2/ops/finance.filings.get', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.agentkey.app/v2/ops/finance.filings.get",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'url' => '<string>',
    'fields' => [
        '<string>'
    ],
    'format' => 'text',
    'include_raw' => false,
    'provider' => '<string>',
    'routing' => [
        'allow_fallbacks' => true,
        'only' => [
                '<string>'
        ],
        'order' => [
                '<string>'
        ],
        'strategy' => 'auto'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.agentkey.app/v2/ops/finance.filings.get"

	payload := strings.NewReader("{\n  \"url\": \"<string>\",\n  \"fields\": [\n    \"<string>\"\n  ],\n  \"format\": \"text\",\n  \"include_raw\": false,\n  \"provider\": \"<string>\",\n  \"routing\": {\n    \"allow_fallbacks\": true,\n    \"only\": [\n      \"<string>\"\n    ],\n    \"order\": [\n      \"<string>\"\n    ],\n    \"strategy\": \"auto\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.agentkey.app/v2/ops/finance.filings.get")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"url\": \"<string>\",\n  \"fields\": [\n    \"<string>\"\n  ],\n  \"format\": \"text\",\n  \"include_raw\": false,\n  \"provider\": \"<string>\",\n  \"routing\": {\n    \"allow_fallbacks\": true,\n    \"only\": [\n      \"<string>\"\n    ],\n    \"order\": [\n      \"<string>\"\n    ],\n    \"strategy\": \"auto\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.agentkey.app/v2/ops/finance.filings.get")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"url\": \"<string>\",\n  \"fields\": [\n    \"<string>\"\n  ],\n  \"format\": \"text\",\n  \"include_raw\": false,\n  \"provider\": \"<string>\",\n  \"routing\": {\n    \"allow_fallbacks\": true,\n    \"only\": [\n      \"<string>\"\n    ],\n    \"order\": [\n      \"<string>\"\n    ],\n    \"strategy\": \"auto\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "attempts": [
    {
      "provider": "<string>",
      "status": 123,
      "took_ms": 123,
      "tool": "<string>",
      "error_type": "<string>",
      "refunded": true,
      "upstream_status": 123
    }
  ],
  "credits_charged": 123,
  "data": {
    "cik": "<string>",
    "company": "<string>",
    "description": "<string>",
    "filed_at": "2023-11-07T05:31:56Z",
    "form_type": "<string>",
    "id": "<string>",
    "period": "2023-12-25",
    "sections": [
      {
        "item": "<string>",
        "text": "<string>"
      }
    ],
    "symbol": "<string>",
    "text": "<string>",
    "url": "<string>"
  },
  "op": "<string>",
  "op_version": 123,
  "provider": "<string>",
  "request_id": "<string>",
  "took_ms": 123,
  "unsupported_fields": [
    "<string>"
  ],
  "raw": "<unknown>",
  "raw_truncated": true
}

{
  "code": 123,
  "error": "<string>",
  "error_type": "<string>",
  "attempts": [
    {
      "provider": "<string>",
      "status": 123,
      "took_ms": 123,
      "tool": "<string>",
      "error_type": "<string>",
      "refunded": true,
      "upstream_status": 123
    }
  ],
  "op": "<string>",
  "request_id": "<string>"
}

{
  "code": 123,
  "error": "<string>",
  "error_type": "<string>",
  "attempts": [
    {
      "provider": "<string>",
      "status": 123,
      "took_ms": 123,
      "tool": "<string>",
      "error_type": "<string>",
      "refunded": true,
      "upstream_status": 123
    }
  ],
  "op": "<string>",
  "request_id": "<string>"
}

{
  "code": 123,
  "error": "<string>",
  "error_type": "<string>",
  "attempts": [
    {
      "provider": "<string>",
      "status": 123,
      "took_ms": 123,
      "tool": "<string>",
      "error_type": "<string>",
      "refunded": true,
      "upstream_status": 123
    }
  ],
  "op": "<string>",
  "request_id": "<string>"
}

{
  "code": 123,
  "error": "<string>",
  "error_type": "<string>",
  "attempts": [
    {
      "provider": "<string>",
      "status": 123,
      "took_ms": 123,
      "tool": "<string>",
      "error_type": "<string>",
      "refunded": true,
      "upstream_status": 123
    }
  ],
  "op": "<string>",
  "request_id": "<string>"
}

{
  "code": 123,
  "error": "<string>",
  "error_type": "<string>",
  "attempts": [
    {
      "provider": "<string>",
      "status": 123,
      "took_ms": 123,
      "tool": "<string>",
      "error_type": "<string>",
      "refunded": true,
      "upstream_status": 123
    }
  ],
  "op": "<string>",
  "request_id": "<string>"
}

{
  "code": 123,
  "error": "<string>",
  "error_type": "<string>",
  "attempts": [
    {
      "provider": "<string>",
      "status": 123,
      "took_ms": 123,
      "tool": "<string>",
      "error_type": "<string>",
      "refunded": true,
      "upstream_status": 123
    }
  ],
  "op": "<string>",
  "request_id": "<string>"
}

Overview

Scenario Methods

Catalog & Describe

Methods

Tool Catalog (MCP)

finance.filings.get

Authorizations

Body

Response