Skip to main content
AlphaSense
Betav0.1.0
32 actions · 1 auth method

Getting Started

1

Create or Select a Project

Set up a new project or select an existing one. See Organizations & Projects.
2

Configure the Connector

Enable the connector and set up a Connector Profile in your project. See Setup Connector Profile.

Connector Profile · OAuth 2.0 (Password Grant)

Requires an AlphaSense-issued API key and OAuth client pair alongside the login email and password of an AlphaSense user…
3

Link an Account

Link an account from the dashboard (or via StackOne Hub).See the guide for the authentication type chosen in the Connector Profile:

Link Account · OAuth 2.0 (Password Grant)

4

Use Actions

Connect an AI platform to the linked account’s actions. See AI Platforms.Other ways to call actions are listed in Protocols & SDKs.

Actions

32 actions
Action
Description
List Brokers
List the broker research sources the account is entitled to, as a hierarchy of groups and the brokers inside them
List Broker Research User Entitlements
Check which broker research entitlement groups are currently granted to specific users, and the status of their entitlem…
List Broker Research Entitlement Requests
List broker research entitlement requests raised to the provider, filtered by status and request date, with offset pagin…
Search Proactive Entitlement Companies
Find companies by name fragment that have at least one user eligible for proactive broker-research entitlement under the…
Search Proactive Entitlement User
Look up one end user by their full email address and return their current proactive broker-research entitlement standing…
Entitle Broker Research Users
Proactively grant broker research entitlement groups to individual users or to a whole firm, without waiting for an enti…
Update Broker Research User Entitlements
Change the entitlement groups held by users who already have an entitlement request, optionally approving or declining t…
Update Broker Research Entitlement Requests
Approve or decline broker research entitlement requests by request id, and set the entitlement groups granted with them
Look Up Companies
Resolve one or more companies from any identifier — AlphaSense id, name, ticker, Crunchbase id, CIK or ISIN — and conver…
List Company Peers
List the peer companies of a company identified by AlphaSense id, name, ticker, Crunchbase id, CIK or ISIN
List Company Quarterly Trending Topics
List the trending topics discussed in a company’s transcripts for a given quarter, each with an AI-generated summary and…
List Suggested Tickers
Autocomplete companies from a free-text company name or ticker fragment, for resolving user input into searchable compan…
List Company Users
List the AlphaSense users belonging to a company, with search, sorting, active-only filtering and offset pagination
Export Documents
Start an export job for one or more documents and get back a task id per document for polling the download link
Check Export Document Status
Check the status of a document export task and retrieve its download URL once the export has finished
Filing Types V3
Retrieve the full document type and source taxonomy as a tree, supplying the type ids that search filters expect
Search Documents
Search the AlphaSense document corpus by keyword, company, date, document type, industry, country, broker or expert-insi…
Search By Doc ID
Retrieve a single document and its metadata by AlphaSense document id
Documents Data
Retrieve metadata for several documents at once by their ids, optionally pinning each to a specific version
Get Document Snippets
Retrieve the keyword-hit snippets of a document, showing the surrounding statement, page number and hit offsets
Search Document Images
Search for charts, tables and other images inside documents, filtered by image type and by the same document filters as…
List Saved Searches
List the saved searches available to the account, optionally narrowed to specific saved-search types
Search By ID
Execute a saved search by id and return the matching documents, optionally overriding its stored filters and sort order
Get Document Counts
Count the documents matching a search filter, grouped by company, industry, country, or by document type over daily, wee…
Get User
Retrieve the authenticated user, or another user by numeric id, together with their broker research credentials and afte…
List Watchlists
List the authenticated user’s watchlists with their companies, or fetch specific watchlists by id
Create Watchlist
Create a watchlist from a list of companies, optionally shared with other users, marked as favourite or created on behal…
Patch Watchlist
Partially update a watchlist — rename it, replace its company list, or change its type or source
Add Companies To Watchlist
Add companies to an existing watchlist without disturbing the companies already on it
Remove Companies From Watchlist
Remove companies from a watchlist, leaving the rest of its membership in place
Delete Watchlist
Permanently delete a single watchlist by id
Delete Watchlists
Permanently delete several watchlists in one call and get back the ids that were actually deleted