Description

Equest Explorer backend provides news articles related to stocks via News REST API integrations such as

• NewsAPI
• AlphaVantage
• Marketaux
• Bing (2/7/2024)
• NewsData (2/8/2024)
• GNews (2/8/2024)
• TheNewsAPI (2/8/2024)

Work in progress 🔧

• Search in progress...

  

Prerequisites

.env file in root directory

• API keys procured from their respective websites
• MongoDB URI for news record keeping

NODE_ENV="local"
INTEGRATIONS_ENABLED=true
BING_API_KEY=
NEWS_API_KEY=
ALPHAV_API_KEY=
MARKETAUX_API_KEY=
BING_API_KEY=
NEWSDATA_API_KEY=
GNEWS_API_KEY=
THENEWS_API_KEY=
MONGODB_URI=

Documentation

Endpoints

Swagger (OpenAPI)

• run locally and proceed to http://localhost:3001/api

Installation

$ npm install

Running the app

# development
$ npm run start

# watch mode
$ npm run start:dev

# production mode
$ npm run start:prod

Test

# unit tests
$ npm run test

# e2e tests
$ npm run test:e2e

# test coverage
$ npm run test:cov

Technologies