news_api_flutter_package 2.0.0

A Dart/Flutter client for News API (newsapi.org), with type-safe enum parameters, structured responses, and no unnecessary dependencies.

News API Flutter Package

A Dart/Flutter client for News API, with type-safe parameters, structured responses, and no unnecessary dependencies.

Getting Started

• Installation Guide
• Example Project
• Get an API key

Initialization

Configure a shared instance once, e.g. in main():

NewsAPI.init(apiKey: "your_api_key");

Then use it anywhere via NewsAPI.instance (throws StateError if called before init()):

final response = await NewsAPI.instance.getTopHeadlines(country: NewsCountry.us);

NewsAPI.instance lives for your app's lifetime, so you don't need to call close() on it.

Top Headlines

final response = await NewsAPI.instance.getTopHeadlines(country: NewsCountry.us);
print(response.totalResults);
print(response.articles);

Parameter	Type	Notes
country	NewsCountry?	Cannot be combined with sources.
category	NewsCategory?	Cannot be combined with sources.
sources	List<String>?	Source IDs. Cannot be combined with country/category.
query	String?	Keywords or phrase to search for.
pageSize	int?	Results per page (max 100).
page	int?	Page number.

Endpoint details

Everything

final response = await NewsAPI.instance.getEverything(
  query: "bitcoin",
  language: NewsLanguage.en,
  sortBy: ArticleSortBy.publishedAt,
);

Parameter	Type	Notes
query	String?	Keywords or phrase to search for.
queryInTitle	String?	Keywords or phrase, restricted to the title.
searchIn	Set<ArticleSearchIn>?	Fields to search: title, description, content.
sources	List<String>?	Source IDs.
domains	List<String>?	Domains to include.
excludeDomains	List<String>?	Domains to exclude.
from	DateTime?	Oldest article date/time.
to	DateTime?	Newest article date/time.
language	NewsLanguage?	Article language.
sortBy	ArticleSortBy?	relevancy, popularity, or publishedAt.
pageSize	int?	Results per page (max 100).
page	int?	Page number.

Endpoint details

Sources

final sources = await NewsAPI.instance.getSources(category: NewsCategory.technology);

Parameter	Type	Notes
category	NewsCategory?	Filter by category.
language	NewsLanguage?	Filter by language.
country	NewsCountry?	Filter by country.

Endpoint details

Errors

Failed requests throw a NewsApiException with code and message:

try {
  final response = await NewsAPI.instance.getTopHeadlines();
} on NewsApiException catch (e) {
  print("${e.code}: ${e.message}");
}

Details on error codes

Custom HTTP Client

NewsAPI.init() accepts an optional http.Client:

NewsAPI.init(apiKey: "your_api_key", client: myClient);

• Testing — pass a MockClient to avoid real network calls.
• Caching — News API's free plan has tight rate limits; wrap a caching http.Client if needed.
• Retrying — package:http/retry.dart's RetryClient retries transient failures with backoff: NewsAPI.init(apiKey: "your_api_key", client: RetryClient(http.Client())).