---
canonical_url: "https://docs.composio.dev/toolkits/finlight"
markdown_url: "https://docs.composio.dev/toolkits/finlight.md"
product: "platform"
version: null
last_updated: null
---

# Finlight

Search Finlight's financial news, retrieve articles by link, and list source metadata through its complete v2 REST API surface.

- **Category:** news & lifestyle
- **Auth:** API_KEY
- **Composio-managed OAuth available?** N/A
- **Tools:** 3
- **Triggers:** 0
- **Slug:** `FINLIGHT`
- **Version:** 00000000_00

## Tools

### Get Article by Link

**Slug:** `FINLIGHT_GET_ARTICLE_BY_LINK`

Retrieve one Finlight-indexed article by its original URL. Optional full content and company entities are plan-gated and may be silently absent even when the request succeeds.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `link` | string | Yes | Original article URL, typically copied from a Finlight search result. |
| `include_content` | boolean | No | Deprecated provider flag requesting full content. A successful response may still omit content when the connected plan does not provide it. |
| `include_entities` | boolean | No | Request mentioned-company entities. A successful response may still omit companies when the connected plan lacks entity enrichment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Sources

**Slug:** `FINLIGHT_LIST_SOURCES`

List all news source domains visible to the connected Finlight account, including default-source status, origin country, and supported languages.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Articles

**Slug:** `FINLIGHT_SEARCH_ARTICLES`

Search Finlight's indexed financial news using text, market, source, geography, category, language, and date filters. Returns one page at a time. Availability, recency, content, and entity enrichment depend on the connected plan and may be silently omitted.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `order` | string ("ASC" | "DESC") | No | Sort direction for order_by. |
| `query` | string | No | Keyword or advanced Finlight query. Searchable fields include ticker, exchange, isin, title, summary, content, openfigi, country, category, and source. |
| `sources` | array | No | Only return articles from these source domains; use '*' for all sources. |
| `tickers` | array | No | Only return articles associated with these stock tickers; use '*' for all tickers. |
| `to_date` | string | No | Inclusive end date as YYYY-MM-DD or an ISO 8601 date-time. Narrow this for deep result sets. |
| `language` | string | No | One ISO 639-1 language code. Run separate searches for multiple languages. |
| `order_by` | string ("publishDate" | "createdAt" | "revisedDate") | No | Article timestamp used to sort results. |
| `countries` | array | No | Only return articles associated with these ISO 3166-1 alpha-2 country codes. |
| `from_date` | string | No | Inclusive start date as YYYY-MM-DD or an ISO 8601 date-time. Narrow this for deep result sets. |
| `page_size` | integer | No | Maximum articles requested for this page (1-100). |
| `categories` | array | No | Filter by Finlight categories: markets, economy, business, politics, geopolitics, regulation, technology, energy, commodities, crypto, health, climate, or security. |
| `next_cursor` | string | No | Continuation cursor returned by a previous call. Pass it unchanged; it restores the original filters and requests the next provider page. |
| `opt_in_sources` | array | No | Add these source domains to the account's default source set. |
| `exclude_sources` | array | No | Exclude these source domains from the results. |
| `include_content` | boolean | No | Request full article content. This is plan-gated, so a successful response may omit content. |
| `include_entities` | boolean | No | Request mentioned-company entities. This is plan-gated, so a successful response may omit companies. |
| `exclude_empty_content` | boolean | No | Request exclusion of articles without full content. This may be silently ignored when the connected plan lacks content access. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |