NewsCatcher API Documentation

Documentation repository for the NewsCatcher API, built with Mintlify and hosted at newscatcherapi.com/docs.

Table of Contents

1. About
2. Repository Structure
3. Getting Started
4. Contributing
5. Support

About

NewsCatcher API provides access to news articles from over 140,000 sources worldwide with three main public APIs:

• Web Search API: AI web search that finds real-world events and extracts structured data.
• News API: Search and retrieve news articles with metadata enrichment and NLP.
• Local News API: Hyper local news with geographic detection and NLP.

NLP featues include summarisation, topic modeling, sentiment analysis, entity recognition, clustering, and deduplication.

Repository Structure

## Repository Structure
```txt
├── docs.json                   # Mintlify configuration
├── home/                       # Documentation landing page
├── web-search-api/             # Web Search API (formerly CatchAll)
│   ├── get-started/
│   ├── guides-and-concepts/
│   ├── how-to/
│   ├── api-reference/
│   ├── libraries/
│   └── integrations/
├── news-api/                   # News API
│   ├── get-started/
│   ├── guides-and-concepts/
│   ├── how-to/
│   ├── troubleshooting/
│   ├── api-reference/
│   └── libraries/
├── local-news-api/             # Local News API
│   ├── get-started/
│   ├── guides-and-concepts/
│   └── api-reference/
├── scripts/                    # Migration and maintenance scripts
├── v3/                         # Legacy structure (Events API only)
├── v2/                         # Legacy v2 docs (deprecated)
└── .github/workflows/          # CI/CD automation

Getting Started

Prerequisites

• Node.js (v18+)
• Python 3.10+ (for automation scripts)
• Git

Local Development

1. Clone and install Mintlify:

   git clone https://github.com/NewscatcherAPI/docs
   cd docs
   npm i -g mint

2. Start development server:

   mint dev

3. View documentation at http://localhost:3000

Quick API Example

curl -X GET "https://v3-api.newscatcherapi.com/api/search?q=artificial%20intelligence&lang=en" \
  -H "x-api-token: YOUR_API_KEY"

Contributing

Documentation Updates

1. Create a new branch: git checkout -b docs/your-change
2. Make changes following the Google Developer Documentation Style Guide
3. Test locally: mint dev
4. Submit a pull request

Content Guidelines

• Use clear, concise language for developers
• Include working code examples
• Test all links before submitting
• Follow existing file naming conventions (kebab-case)

Adding New Pages

1. Update navigation in docs.json
2. Create MDX files in appropriate directories
3. For each MDX file, include proper frontmatter (title, sidebarTitle, description)

Common Issues

Issue	Solution
mint dev not found	Install globally: npm i -g mint
Port 3000 in use	Use different port: mint dev --port 3001
Python script errors	Ensure Python 3.10+ is installed

Support

Documentation Issues

• GitHub Issues: Report documentation bugs and improvements
• Pull Requests: Submit fixes and enhancements directly

API Support

• Customer Portal: support.newscatcherapi.com
• Email: support@newscatcherapi.com
• Status Page: status.newscatcherapi.com

Resources

• NewsCatcher API homepage
• Book a demo
• Postman collections

---

Built by the NewsCatcher team with ❤️