Skip to main content
GET
/
api
/
us
/
v0
/
documents
/
announcement
8-K/6-K Tagged Feed
curl --request GET \
  --url https://stockinsights-ai-us-main-f5fd25a.zuplo.app/api/us/v0/documents/announcement \
  --header 'Authorization: Bearer <token>'
{
  "status": "success",
  "data": [
    {
      "id": "<string>",
      "type": "<string>",
      "cik": "0001045810",
      "ticker": "<string>",
      "company_name": "<string>",
      "source_link": "<string>",
      "ai_insights": {
        "category_id": "<string>",
        "category_name": "<string>",
        "summary_title": "<string>",
        "summary_text": "<string>",
        "sentiment": "positive"
      },
      "published_date": "2023-11-07T05:31:56Z"
    }
  ],
  "meta": {}
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
document_type
enum<string>

Optional param. Only provide if exclusive 8-K feed or 6-K feed is needed. Accepted values=8-K or 6-K

Available options:
8-K,
6-K
Example:

"8-K"

​
cik
string

CIKs (Central Index Keys) of companies. Multiple CIKs can be provided separated by commas. Each CIK should be a 10-digit number (include leading zeros if necessary). Get CIKs from Company Details.

Example:

"0001045810"

​
from_date
string

Start date in YYYY-MM-DD format. Use this parameter to filter data from a specific start date.

​
to_date
string

End date in YYYY-MM-DD format. Use this parameter to filter data till a specific end date

​
category_id
string

Comma-separated 8-K/6-K Category IDs (Allowed Values - 1 to 26). Check the filings-8k-type mapping.

​
sentiment
enum<string>

Comma-separated sentiment values (Allowed values - positive, negative, neutral).

Available options:
positive,
negative,
neutral
Example:

"negative"

​
sector
string

Sector classification of the companies. Multiple values can be provided separated by commas. Get valid sector values from Company Details.

​
industry
string

Industry classification of the companies. Multiple values can be provided separated by commas. Check valid industry values from Company Details.

​
limit
integer

The number of results to return per page. This parameter is optional and defaults to 20 if not specified. Maximum value is 50.

Required range: x <= 50
​
page
integer

Page number for pagination. This parameter is optional and defaults to 1 if not specified.

Required range: x >= 1

Response

Success response. Contains Paginated 8-K/6-K Documents.

​
status
enum<string>
Available options:
success
​
data
object[]
​
meta
object
⌘I