Forex News API

https://forexnewsapi.com/documentation
Admin
Forex News API provides real-time and historical financial news data for currency pairs, general...
Tokens:4,102
Snippets:11
Trust Score:6.8
Update:11 months ago
Show doc for...
Tokens:
Raw
### GET Tickers DB

Source: https://forexnewsapi.com/documentation/index

View all tickers/symbols available in the database.

```APIDOC
## GET /websites/forexnewsapi/tickers_db

### Description
Use this endpoint to view all tickers/symbols in our Database. This endpoint can be accessed once per day (non-trial).

### Method
GET

### Endpoint
/websites/forexnewsapi/tickers_db

### Query Parameters
- **items** (integer) - Optional - Number of tickers to return (default 50).
- **page** (integer) - Optional - Page number for paginating results.

### Response
#### Success Response (200)
- **tickers** (array) - List of available tickers.

#### Response Example
```json
{
  "tickers": [
    "EUR-USD",
    "GBP-USD",
    "USD-JPY",
    "AUD-USD"
  ]
}
```
```

--------------------------------

### GET General Forex News

Source: https://forexnewsapi.com/documentation/index

Retrieve general forex news articles.

```APIDOC
## GET /websites/forexnewsapi/general_forex_news

### Description
Use this endpoint to retrieve General Forex News.

### Method
GET

### Endpoint
/websites/forexnewsapi/general_forex_news

### Query Parameters
- **items** (integer) - Optional - Number of news items to return (1-50).
- **csv** (boolean) - Optional - Set to true to download data as a CSV file.
- **source** (string) - Optional - Comma-separated list of news sources to filter by.
- **type** (string) - Optional - Filter by news type ('video' or 'article').
- **sentiment** (string) - Optional - Filter by sentiment ('neutral', 'positive', 'negative').
- **sort_by_rank** (boolean) - Optional - Sort news by rank.
- **sort_by_rank_days** (integer) - Optional - Sort by rank for the last X days (compatible with sort_by_rank).
- **sort_by_date** (string) - Optional - Sort order ('newest' or 'oldest').
- **page** (integer) - Optional - Page number for more news results (limits apply based on plan).
- **news_id** (string) - Optional - Retrieve news item by news ID (comma-separated for multiple).
- **event_id** (string) - Optional - Retrieve news item by event ID.
- **rank_score** (boolean) - Optional - Include rank score in response.
- **metadata** (boolean) - Optional - Include metadata information in response.
- **date** (string) - Optional - Filter by date (e.g., 'MMDDYYYY', 'last7days', 'today').
- **time** (string) - Optional - Filter by exact time (HHMMSS, compatible with 'date' parameter).
- **keywords** (string) - Optional - Search for news containing specific keywords.

### Response
#### Success Response (200)
- **news** (array) - List of news articles.
- **metadata** (object) - Metadata about the response (if requested).

#### Response Example
```json
{
  "news": [
    {
      "id": "11223",
      "title": "Global Economic Outlook Uncertain, Forex Markets React",
      "publish_time": "2023-10-27T09:00:00Z",
      "source": "Associated Press"
    }
  ],
  "metadata": {
    "total_results": 20,
    "returned_results": 1
  }
}
```
```

--------------------------------

### GET Sentiment Analysis (All)

Source: https://forexnewsapi.com/documentation/index

Retrieve daily sentiment for All Currency Pairs and General Forex News.

```APIDOC
## GET /websites/forexnewsapi/sentiment_analysis_all

### Description
Retrieve the daily sentiment of All Currency Pairs and General Forex News. The Sentiment Score ranges from -1.5 (Negative) to +1.5 (Positive).

### Method
GET

### Endpoint
/websites/forexnewsapi/sentiment_analysis_all

### Query Parameters
- **date** (string) - Optional - Specify date range (e.g., 'MMDDYYYY', 'last7days').
- **no_cache** (boolean) - Optional - Set to true to bypass the cache (1-hour cache by default).

### Response
#### Success Response (200)
- **sentiment** (object) - Daily sentiment data for currency pairs and general news.

#### Response Example
```json
{
  "sentiment": {
    "date": "2023-10-27",
    "currency_pairs": [
      {"pair": "EUR-USD", "sentiment_score": 0.35},
      {"pair": "GBP-USD", "sentiment_score": -0.15}
    ],
    "general_forex_news": {"sentiment_score": 0.20}
  }
}
```
```

--------------------------------

### GET All Currency Pairs

Source: https://forexnewsapi.com/documentation/index

Retrieve all news published under the 'All Currency Pairs' category.

```APIDOC
## GET /websites/forexnewsapi/all_currency_pairs_news

### Description
If you want to retrieve all the news published under All Currency Pairs, use below endpoint.

### Method
GET

### Endpoint
/websites/forexnewsapi/all_currency_pairs_news

### Query Parameters
- **items** (integer) - Optional - Number of news items to return (1-50).
- **csv** (boolean) - Optional - Set to true to download data as a CSV file.
- **source** (string) - Optional - Comma-separated list of news sources to filter by.
- **type** (string) - Optional - Filter by news type ('video' or 'article').
- **sentiment** (string) - Optional - Filter by sentiment ('neutral', 'positive', 'negative').
- **sort_by_rank** (boolean) - Optional - Sort news by rank.
- **sort_by_rank_days** (integer) - Optional - Sort by rank for the last X days (compatible with sort_by_rank).
- **sort_by_date** (string) - Optional - Sort order ('newest' or 'oldest').
- **page** (integer) - Optional - Page number for more news results (limits apply based on plan).
- **news_id** (string) - Optional - Retrieve news item by news ID (comma-separated for multiple).
- **event_id** (string) - Optional - Retrieve news item by event ID.
- **rank_score** (boolean) - Optional - Include rank score in response.
- **metadata** (boolean) - Optional - Include metadata information in response.
- **date** (string) - Optional - Filter by date (e.g., 'MMDDYYYY', 'last7days', 'today').
- **time** (string) - Optional - Filter by exact time (HHMMSS, compatible with 'date' parameter).
- **keywords** (string) - Optional - Search for news containing specific keywords.

### Response
#### Success Response (200)
- **news** (array) - List of news articles.
- **metadata** (object) - Metadata about the response (if requested).

#### Response Example
```json
{
  "news": [
    {
      "id": "44556",
      "title": "Global Forex Markets Experience Fluctuations",
      "publish_time": "2023-10-27T08:00:00Z",
      "source": "Reuters"
    }
  ],
  "metadata": {
    "total_results": 15,
    "returned_results": 1
  }
}
```
```

--------------------------------

### GET Events

Source: https://forexnewsapi.com/documentation/index

Retrieve the latest news events and eventIDs.

```APIDOC
## GET /websites/forexnewsapi/events

### Description
Retrieve the latest news events and eventIDs. Events are important headlines that are receiving a significant amount of news coverage.

### Method
GET

### Endpoint
/websites/forexnewsapi/events

### Query Parameters
- **eventid** (string) - Optional - Retrieve all news items from a specific event (e.g., "eventid=abc123def456").
- **no_cache** (boolean) - Optional - Set to true to bypass the cache (1-hour cache by default).

### Response
#### Success Response (200)
- **events** (array) - List of news events.

#### Response Example
```json
{
  "events": [
    {
      "event_id": "abc123def456",
      "headline": "Central Bank Announces Interest Rate Decision",
      "publish_time": "2023-10-27T14:00:00Z"
    },
    {
      "event_id": "ghi789jkl012",
      "headline": "US Non-Farm Payrolls Data Released",
      "publish_time": "2023-10-27T13:30:00Z"
    }
  ]
}
```
```

--------------------------------

### GET Trending Headlines

Source: https://forexnewsapi.com/documentation/index

Filter out the noise and stay up to date with the latest important headliners.

```APIDOC
## GET /websites/forexnewsapi/trending_headlines

### Description
With our headlines endpoint, you can filter out the noise and stay up to date with the latest important headliners.

### Method
GET

### Endpoint
/websites/forexnewsapi/trending_headlines

### Query Parameters
- **items** (integer) - Optional - Number of headlines to return (1-50).
- **page** (integer) - Optional - Page number for paginating results.
- **date** (string) - Optional - Filter by date (e.g., 'MMDDYYYY', 'last7days', 'today').

### Response
#### Success Response (200)
- **headlines** (array) - List of trending headlines.

#### Response Example
```json
{
  "headlines": [
    "Major Stock Indices Reach Record Highs",
    "Oil Prices Surge on Supply Concerns",
    "Tech Stocks Lead Market Rally"
  ]
}
```
```

--------------------------------

### GET Sentiment Analysis (Individual Currency Pair)

Source: https://forexnewsapi.com/documentation/index

Retrieve daily sentiment for an individual currency pair.

```APIDOC
## GET /websites/forexnewsapi/sentiment_analysis_pair

### Description
Retrieve the daily sentiment for an individual currency pair. The Sentiment Score ranges from -1.5 (Negative) to +1.5 (Positive).

### Method
GET

### Endpoint
/websites/forexnewsapi/sentiment_analysis_pair

### Query Parameters
- **pair** (string) - Required - The currency pair (e.g., "EUR-USD").
- **date** (string) - Optional - Specify date range (e.g., 'MMDDYYYY', 'last7days').
- **no_cache** (boolean) - Optional - Set to true to bypass the cache (1-hour cache by default).

### Response
#### Success Response (200)
- **sentiment** (object) - Daily sentiment data for the specified currency pair.

#### Response Example
```json
{
  "sentiment": {
    "date": "2023-10-27",
    "pair": "EUR-USD",
    "sentiment_score": 0.40
  }
}
```
```

--------------------------------

### GET Top Mentioned Currency Pairs

Source: https://forexnewsapi.com/documentation/index

Retrieve the top 50 most mentioned currency pairs, with an option to specify a date range.

```APIDOC
## GET /websites/forexnewsapi/top_mentioned_currency_pairs

### Description
Retrieve the top 50 most mentioned currency pairs. Use the `date` parameter to specify your desired date range.

### Method
GET

### Endpoint
/websites/forexnewsapi/top_mentioned_currency_pairs

### Query Parameters
- **date** (string) - Optional - Specify date range (e.g., 'MMDDYYYY', 'last7days').
- **no_cache** (boolean) - Optional - Set to true to bypass the cache (1-hour cache by default).

### Response
#### Success Response (200)
- **currency_pairs** (array) - List of top mentioned currency pairs with mention counts.

#### Response Example
```json
{
  "currency_pairs": [
    {"pair": "EUR-USD", "mentions": 1500},
    {"pair": "GBP-USD", "mentions": 1200},
    {"pair": "USD-JPY", "mentions": 1000}
  ]
}
```
```

--------------------------------

### GET Currency Pair News

Source: https://forexnewsapi.com/documentation/index

Retrieve news for a specific currency pair or multiple currency pairs.

```APIDOC
## GET /websites/forexnewsapi/currency_pair_news

### Description
Use this endpoint to obtain news for a currency pair. You can specify one or multiple currency pairs separated by a comma.

### Method
GET

### Endpoint
/websites/forexnewsapi/currency_pair_news

### Query Parameters
- **pairs** (string) - Required - Comma-separated list of currency pairs (e.g., "EUR-USD,GBP-USD").
- **items** (integer) - Optional - Number of news items to return (1-50).
- **csv** (boolean) - Optional - Set to true to download data as a CSV file.
- **source** (string) - Optional - Comma-separated list of news sources to filter by.
- **type** (string) - Optional - Filter by news type ('video' or 'article').
- **sentiment** (string) - Optional - Filter by sentiment ('neutral', 'positive', 'negative').
- **sort_by_rank** (boolean) - Optional - Sort news by rank.
- **sort_by_rank_days** (integer) - Optional - Sort by rank for the last X days (compatible with sort_by_rank).
- **sort_by_date** (string) - Optional - Sort order ('newest' or 'oldest').
- **page** (integer) - Optional - Page number for more news results (limits apply based on plan).
- **news_id** (string) - Optional - Retrieve news item by news ID (comma-separated for multiple).
- **event_id** (string) - Optional - Retrieve news item by event ID.
- **rank_score** (boolean) - Optional - Include rank score in response.
- **metadata** (boolean) - Optional - Include metadata information in response.
- **date** (string) - Optional - Filter by date (e.g., 'MMDDYYYY', 'last7days', 'today').
- **time** (string) - Optional - Filter by exact time (HHMMSS, compatible with 'date' parameter).
- **keywords** (string) - Optional - Search for news containing specific keywords.

### Response
#### Success Response (200)
- **news** (array) - List of news articles.
- **metadata** (object) - Metadata about the response (if requested).

#### Response Example
```json
{
  "news": [
    {
      "id": "12345",
      "title": "EUR/USD Shows Resilience Amidst Market Volatility",
      "publish_time": "2023-10-27T10:00:00Z",
      "source": "Reuters",
      "currency_pairs": ["EUR-USD"]
    }
  ],
  "metadata": {
    "total_results": 10,
    "returned_results": 1
  }
}
```
```

--------------------------------

### GET Sundown Digest

Source: https://forexnewsapi.com/documentation/index

Retrieve the Sundown Digest, an evening article summarizing the day's crucial news and events.

```APIDOC
## GET /websites/forexnewsapi/sundown_digest

### Description
Sundown Digest is an engaging evening article that encapsulates the crucial news and events of the day, presented in a digestible format. Available Mon-Fri at 7pm Eastern Time.

### Method
GET

### Endpoint
/websites/forexnewsapi/sundown_digest

### Query Parameters
- **date** (string) - Optional - Specify the date for the digest (e.g., 'MMDDYYYY'). Defaults to the current day if not provided.

### Response
#### Success Response (200)
- **digest** (string) - The content of the Sundown Digest article.

#### Response Example
```json
{
  "digest": "Today's market saw significant movement driven by key economic releases. The Federal Reserve's announcement on interest rates impacted currency values, with the Dollar showing strength against the Euro. Oil prices also reacted to geopolitical tensions..."
}
```
```

--------------------------------

### GET Currency Pair News Advanced

Source: https://forexnewsapi.com/documentation/index

Retrieve news items where multiple specified currency pairs are mentioned together, or news where only a specific ticker is mentioned.

```APIDOC
## GET /websites/forexnewsapi/currency_pair_news_advanced

### Description
Use this endpoint to retrieve news that include multiple pairs OR news where only a specific ticker is mentioned. Note: This endpoint reduces the amount of news results compared to the regular 'Currency Pair News' endpoint.

### Method
GET

### Endpoint
/websites/forexnewsapi/currency_pair_news_advanced

### Query Parameters
- **pairs** (string) - Required - Comma-separated list of currency pairs to search for (e.g., "EUR-USD,GBP-USD" for news mentioning both, or "EUR-USD" for news mentioning only EUR-USD).
- **items** (integer) - Optional - Number of news items to return (1-50).
- **csv** (boolean) - Optional - Set to true to download data as a CSV file.
- **source** (string) - Optional - Comma-separated list of news sources to filter by.
- **type** (string) - Optional - Filter by news type ('video' or 'article').
- **sentiment** (string) - Optional - Filter by sentiment ('neutral', 'positive', 'negative').
- **sort_by_rank** (boolean) - Optional - Sort news by rank.
- **sort_by_rank_days** (integer) - Optional - Sort by rank for the last X days (compatible with sort_by_rank).
- **sort_by_date** (string) - Optional - Sort order ('newest' or 'oldest').
- **page** (integer) - Optional - Page number for more news results (limits apply based on plan).
- **news_id** (string) - Optional - Retrieve news item by news ID (comma-separated for multiple).
- **event_id** (string) - Optional - Retrieve news item by event ID.
- **rank_score** (boolean) - Optional - Include rank score in response.
- **metadata** (boolean) - Optional - Include metadata information in response.
- **date** (string) - Optional - Filter by date (e.g., 'MMDDYYYY', 'last7days', 'today').
- **time** (string) - Optional - Filter by exact time (HHMMSS, compatible with 'date' parameter).
- **keywords** (string) - Optional - Search for news containing specific keywords.

### Response
#### Success Response (200)
- **news** (array) - List of news articles.
- **metadata** (object) - Metadata about the response (if requested).

#### Response Example
```json
{
  "news": [
    {
      "id": "67890",
      "title": "EUR/USD and GBP/USD Movements Analyzed",
      "publish_time": "2023-10-27T11:00:00Z",
      "source": "Bloomberg",
      "currency_pairs": ["EUR-USD", "GBP-USD"]
    }
  ],
  "metadata": {
    "total_results": 5,
    "returned_results": 1
  }
}
```
```
Tokens:
Raw