Package Exports
- @newsriver/eliza-plugin
- @newsriver/eliza-plugin/dist/index.js
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@newsriver/eliza-plugin) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
@newsriver/eliza-plugin
The official ElizaOS plugin for the NewsRiver Global Intelligence API.
Connects your Eliza agent to NewsRiver's global news intelligence platform — 277+ sources across 137 countries, AI-generated briefings, semantic vector search, and secure Web2 proxies (email, SMS, scraping).
Installation
npm install @newsriver/eliza-pluginAuthentication
Option 1: API Key (Subscription)
Get an API key from NewsRiver and add it to your .env:
NEWSRIVER_API_KEY=nrk_live_your_key_hereSecurity: Keys are SHA-256 hashed server-side. Never stored in plaintext. Analytics logs mask keys to last 4 chars only.
Option 2: x402 Micropayments (No API Key)
If your Eliza agent has a wallet on Base network, it can handle HTTP 402 responses and pay per-request in USDC. Requires @x402/core.
⚠️ Spending Safety: Use a limited allowance contract (e.g., PaySponge) to cap spending. Never give the agent full wallet access.
Usage
import { newsRiverPlugin } from "@newsriver/eliza-plugin";
const myAgent = {
name: "CryptoTraderBot",
plugins: [newsRiverPlugin]
};Actions (7)
| Action | Cost | Description |
|---|---|---|
GET_NEWSRIVER_INTELLIGENCE |
$0.05–$1.00 | Fetch AI intelligence briefings (hourly/daily/weekly) |
SEARCH_NEWSRIVER |
$0.001 | Semantic vector search across all articles |
GET_NEWSRIVER_ARTICLES |
$0.001 | Fetch latest news articles |
GET_NEWSRIVER_TRENDS |
$0.001 | Sentiment trend timelines for any topic |
NEWSRIVER_SEND_EMAIL |
$0.05 | Send email via proxy (50/hr limit) |
NEWSRIVER_SEND_SMS |
$0.25 | Send SMS via proxy (10/hr limit) |
NEWSRIVER_SCRAPE |
$0.10 | Scrape public webpages (SSRF-protected) |
⚠️ Outbound Proxy Actions
NEWSRIVER_SEND_EMAIL and NEWSRIVER_SEND_SMS send real messages. The agent should always confirm with the user before executing these actions. The API enforces:
- Hardcoded sender identity (
agents@yieldcircle.app) - Rate limits per IP and per wallet
- SMS messages prefixed with
[NewsRiver Agent]
Testing with Dry-Run
Test any action for free using the X-Dry-Run: true header. Returns mock data labeled [SAMPLE]:
curl -H "X-Dry-Run: true" https://api.yieldcircle.app/api/v1/articlesLinks
- API Docs: https://agent.yieldcircle.app/#docs
- Pricing: https://agent.yieldcircle.app/#pricing
- Support: support@yieldcircle.app