Search - Linq Alpha API Docs

Authorizations

X-API-KEY

string

header

required

Body

application/json

query

string

required

A search query

Example:

"What are the latest updates on AAPL?"

external_types

string[]

required

External document types

Example:

["transcript", "filing", "news", "ir_slide"]

stock_ids

string[]

Bloomberg stock IDs (optional)

Example:

["BBG001S5N8V8"]

tickers

string[]

Ticker symbols (optional)

Example:

["AAPL"]

top_k

number

Specifies the number of top search results to return. If the value exceeds 50, it will be capped at 50 The number of returned results will be less than or equal to the specified top_k value. Results are sorted by relevancy in descending order (from highest to lowest).

Example:

50

upload_period

object

Show child attributes

upload_period.start_time

string

required

Start time

upload_period.end_time

string

required

End time

Response

Search response

chat_message_id

string<uuid>

required

Chat message ID

search_result_count

number

Search result count

execution_time_ms

number

Execution time in milliseconds

references

object[]

References

Show child attributes

references.citation_idx

string

required

Citation index

references.chunk_id

string

required

Chunk ID

references.text

string

required

Text

references.text_type

string

required

Text type

references.document_name

string

required

Document name

references.external_url

string

required

External URL

references.metadata

object

required

Additional metadata information

Show child attributes

references.metadata.source

string | null

Example:

"news"

references.metadata.rms_type

enum<string> | null

Available options:

emailnotes,

generalnotes,

templatednotes,

custom-data,

structured-data

references.metadata.rms_sub_type

string | null

references.metadata.rms_document_type

enum<string> | null

Available options:

note,

attachment

references.metadata.parent_id

string | null

references.metadata.parent_document_id

string | null

references.metadata.countries

string[] | null

references.metadata.regions

string[] | null

references.metadata.participants

object[] | null

Show child attributes

references.metadata.participants.name

string

references.metadata.participants.organization

string

references.metadata.participants.role

string | null

references.metadata.participants.participant_type

enum<string> | null

Available options:

author,

analyst,

attendee,

mentioned,

others

references.metadata.tags

string[] | null

references.metadata.publisher

string | null

references.metadata.calendar_date

string<date-time> | null

references.metadata.creation_timestamp

string | null

references.metadata.last_contribution_timestamp

string | null

references.metadata.fiscal_year

integer | null

references.metadata.fiscal_quarter

string | null

references.metadata.document_category

enum<string> | null

Available options:

internal,

brokerage,

expert_network,

corporate_data,

external,

earnings_call,

filing

references.metadata.document_subcategory

enum<string> | null

Available options:

calls,

model,

analysis,

report,

filings,

ir_slide,

factsheet,

email,

earning,

slides,

10-K,

10-Q,

6-K,

8-K,

DEF 14A,

20-F,

annual_results,

interim_results,

annual_report,

interim_report,

offerings,

others

references.metadata.document_tags

string[] | null

references.metadata.sector

enum<string>[] | null

Available options:

Basic Materials,

Consumer Cyclicals,

Consumer Staples,

Energy,

Financial Services,

Healthcare,

Industrials,

Technology,

Transportation,

Telecom Services,

Utilities

references.metadata.subsector

enum<string>[] | null

Available options:

Agriculture,

Chemicals,

Metals & Mining,

Paper & Forest,

Steel,

Automobiles,

Branded Consumer Goods,

Business Services,

Consumer Cyclicals,

Consumer Durables,

Education,

Entertainment & Leisure,

Gaming,

Housing,

Lodging,

Media,

Restaurants & Pubs,

Retail,

Textile,

Apparel & Footwear,

Travel,

Beverages,

Consumer Products,

Food,

Tobacco,

Clean Energy,

Energy,

Gas,

Oil,

Oil Services,

Banks,

Brokers & Asset Managers,

Capital Markets,

Diversified Financials,

Insurance,

Real Estate,

Specialty Finance,

Biotechnology,

Healthcare Services,

Life Sciences,

Medical Technology,

Pharmaceuticals,

Aerospace & Defense,

Capital Goods,

Construction,

Electrical Equipment,

Environmental Services,

Machinery,

Machinery & Diversified Industrials,

Multi-Industry,

Packaging,

Communications Technology,

Hardware,

Info Services,

Integrated Electricals,

Internet,

IT Services,

IT Supply Chain,

Semiconductors,

Software,

Technology,

Air Freight,

Airlines,

Airports,

Infrastructure,

Logistics,

Railroads,

Shipping,

Trucking,

Communication Services,

Satellite,

Telecom Wireless,

Towers,

Diversified,

MLPs,

Power,

Utilities,

Water

references.metadata.stock_ids

string[] | null

references.metadata.tickers

string[] | null

references.metadata.company_names

string[] | null

references.metadata.offset

object[] | null

Show child attributes

references.metadata.offset.top

number

references.metadata.offset.left

number

references.metadata.offset.width

number

references.metadata.offset.height

number

references.metadata.offset.page

integer

references.document_id

string

Document ID

references.custom_metadata

object

User-defined metadata. This field may contain additional structured data based on the document type and user configuration.

Show child attributes

references.custom_metadata.edgar_metadata

object

SEC EDGAR filing metadata. This field is only available for SEC filing documents and is provided upon request. Not all users will have access to this data. Contact [email protected] to enable EDGAR metadata for your organization.

Show child attributes

references.custom_metadata.edgar_metadata.public_url

string<uri>

required

Public EDGAR URL to the source filing document on the SEC website

Example:

"https://www.sec.gov/Archives/edgar/data/1045810/000104581023000227/nvda-20231029.htm"

references.custom_metadata.edgar_metadata.accession_number

string

required

SEC accession number uniquely identifying the filing. Format: XXXXXXXXXX-XX-XXXXXX

Example:

"0001045810-23-000227"

references.custom_metadata.edgar_metadata.filing_values

object

Additional SEC filing identifiers

Show child attributes

references.custom_metadata.edgar_metadata.filing_values.film_number

string

SEC film number assigned to the filing

Example:

"231428716"

references.custom_metadata.edgar_metadata.filing_values.sec_file_number

string

SEC file number for the registrant

Example:

"000-23985"

Basic

RMS (On request)

Authorizations

Body

Response