This guide walks you through installing the SDK, making your first search request, and understanding the response.Documentation Index
Fetch the complete documentation index at: https://newscatcherinc-docs.mintlify.dev/docs/llms.txt
Use this file to discover all available pages before exploring further.
Before you begin
Make sure you have the following:- A News API key — contact your account manager or sign up at newscatcherapi.com/news-api
- Python 3.10 or later — for the Python SDK
- Node.js 16 or later — for the TypeScript SDK
- Java 8 or later — for the Java SDK
Steps
Make your first request
Search for articles about renewable energy using the
/search endpoint:Store your API key in an environment variable rather than hardcoding it.
The examples below use
YOUR_API_KEY as a placeholder.Review the response
A successful request returns a JSON object with pagination metadata and an
articles array:If
total_hits returns exactly 10000, your query matches more articles
than the per-request cap. To learn how to retrieve the full result set, see
Retrieve large datasets
.Next steps
API reference
Explore all endpoints and request parameters
Query syntax
Build precise queries with Boolean operators and proximity search
Retrieve large datasets
Retrieve result sets beyond the 10,000 article cap
NLP features
Sentiment, entities, themes, and summaries

