> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# AlphaSense

> How to set up the AlphaSense connector, plus the actions that are available.

![AlphaSense](https://stackone-logos.com/api/alphasense/filled/svg)

Betav0.1.0[See changelog](https://docs.stackone.com/connectors/alphasense/changelog.md)

[32 actions](#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](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [OAuth 2.0 (Password Grant) · Connector Profile](https://docs.stackone.com/connectors/alphasense/guides/connector-profile/oauth-2-0-password-grant.md)
>
> 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](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [OAuth 2.0 (Password Grant) · Link Account](https://docs.stackone.com/connectors/alphasense/guides/link-account/oauth-2-0-password-grant.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/connect/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

32 actions

ActionDescription

List Brokers`alphasense_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`alphasense_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`alphasense_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`alphasense_search_broker_research_proactive_companies`

Find companies by name fragment that have at least one user eligible for proactive broker-research entitlement under the...

Search Proactive Entitlement User`alphasense_search_broker_research_proactive_user`

Look up one end user by their full email address and return their current proactive broker-research entitlement standing...

Entitle Broker Research Users`alphasense_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`alphasense_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`alphasense_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`alphasense_lookup_companies`

Resolve one or more companies from any identifier — AlphaSense id, name, ticker, Crunchbase id, CIK or ISIN — and conver...

List Company Peers`alphasense_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`alphasense_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`alphasense_list_suggested_tickers`

Autocomplete companies from a free-text company name or ticker fragment, for resolving user input into searchable compan...

List Company Users`alphasense_list_company_users`

List the AlphaSense users belonging to a company, with search, sorting, active-only filtering and offset pagination

Export Documents`alphasense_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`alphasense_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`alphasense_filing_types_v3`

Retrieve the full document type and source taxonomy as a tree, supplying the type ids that search filters expect

Search Documents`alphasense_search_documents`

Search the AlphaSense document corpus by keyword, company, date, document type, industry, country, broker or expert-insi...

Search By Doc ID`alphasense_search_by_doc_id`

Retrieve a single document and its metadata by AlphaSense document id

Documents Data`alphasense_documents_data`

Retrieve metadata for several documents at once by their ids, optionally pinning each to a specific version

Get Document Snippets`alphasense_get_document_snippets`

Retrieve the keyword-hit snippets of a document, showing the surrounding statement, page number and hit offsets

Search Document Images`alphasense_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`alphasense_list_saved_searches`

List the saved searches available to the account, optionally narrowed to specific saved-search types

Search By ID`alphasense_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`alphasense_get_document_counts`

Count the documents matching a search filter, grouped by company, industry, country, or by document type over daily, wee...

Get User`alphasense_get_user`

Retrieve the authenticated user, or another user by numeric id, together with their broker research credentials and afte...

List Watchlists`alphasense_list_watchlists`

List the authenticated user's watchlists with their companies, or fetch specific watchlists by id

Create Watchlist`alphasense_create_watchlist`

Create a watchlist from a list of companies, optionally shared with other users, marked as favourite or created on behal...

Patch Watchlist`alphasense_watchlist_patch`

Partially update a watchlist — rename it, replace its company list, or change its type or source

Add Companies To Watchlist`alphasense_add_companies_to_watchlist`

Add companies to an existing watchlist without disturbing the companies already on it

Remove Companies From Watchlist`alphasense_remove_companies_from_watchlist`

Remove companies from a watchlist, leaving the rest of its membership in place

Delete Watchlist`alphasense_delete_watchlist`

Permanently delete a single watchlist by id

Delete Watchlists`alphasense_delete_watchlists`

Permanently delete several watchlists in one call and get back the ids that were actually deleted


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.