Quickstart
The Finlight.me API is a real-time financial news API that provides market-relevant news articles enriched with sentiment analysis. It offers both REST and WebSocket APIs, allowing developers to access and integrate financial news data into their applications efficiently.
- Real-time Financial News: Stay updated with the latest financial news articles as they are published.
- Sentiment Analysis: Each article includes sentiment data, helping you gauge market sentiment quickly.
Get started quickly with the Finlight.me API by following these simple steps:
Sign Up and Get Your Free API Key
- Visit the Finlight Dashboard and sign up for a free account.
- Once registered, navigate to the API Keys section to obtain your API key.
- The free tier includes 10,000 requests per month or 10,000 WebSocket minutes per month.
Choose your client
Before making your first API request, you need to pick which API client you will use. In addition to good ol' cURL HTTP requests, Protocol offers clients for JavaScript, Python, and PHP. In the following example, you can see how to install each client.
# Install the Node.js client library via npm
npm install finlight-client
Make Your First API Call
After picking your preferred client, you are ready to make your first call to the finlight API. Below, you can see how to send a GET request to the Articles endpoint to search for articles with the example query.
import { FinlightApi } from "finlight-client";
const client = new FinlightApi({ apiKey: 'YOUR_API_KEY' }) // Replace with your API key
client.articles
.getBasicArticles({
query: "Nvidia",
language: "en"
})
.then((articles) => console.log(articles));
.catch((error) => console.error(error))
What's next?
Great, you're now set up with an API client and have made your first request to the API. Here are a few links that might be handy as you venture further into the finlight API: