API Reference

Base URL: https://api.feedplaza.com/v1 · Version: 0.2.0

Authentication & Account News & Feeds Stocks Weather IP Geolocation Air Quality GitHub Trending Crypto & Forex Sources & Usage Error Codes Rate Limit Headers

Authentication & Account

All data endpoints require an API key passed in the x-api-key header. Get your key by registering.

Register

POST/v1/auth/registerCreate account, get API key

Field	Type	Required	Description
`email`	string	✅	Your email address
`password`	string	✅	Min 8 characters

$ curl -X POST https://api.feedplaza.com/v1/auth/register \
  -H "Content-Type: application/json" \
  -d '{"email":"you@example.com","password":"yourpassword"}'


→ {"api_key":"feed_live_...","key_prefix":"feed_live_","message":"..."}

Login

POST/v1/auth/loginLogin with email + password

$ curl -X POST https://api.feedplaza.com/v1/auth/login \
  -H "Content-Type: application/json" \
  -d '{"email":"you@example.com","password":"yourpassword"}'


→ {"api_key":"feed_live_...","plan":"free","credits_signup_remaining":4999,...}

Get Account Info

GET/v1/auth/meView your key info and usage

$ curl -H "x-api-key: YOUR_KEY" \ https://api.feedplaza.com/v1/auth/me

News & Feeds

Get News

GET/v1/news/:sourceLatest headlines from any news source

Param	Type	Default	Description
`source`	path	—	`bbc-news` · `npr-news` · `hackernews`
`limit`	query	20	Max 100 results

$ curl -H "x-api-key: YOUR_KEY" \ "https://api.feedplaza.com/v1/news/bbc-news?limit=5"

Stocks

GET/v1/news/yahoo-stocksUS stock quotes (10 major tickers)

$ curl -H "x-api-key: YOUR_KEY" \
  "https://api.feedplaza.com/v1/news/yahoo-stocks?limit=3"


→ {"data":[{"symbol":"AAPL","name":"Apple Inc.","price":298.44,"change_pct":1.23},...]}

Tickers: AAPL, GOOGL, MSFT, AMZN, TSLA, NVDA, META, JPM, V, WMT

Weather

GET/v1/weather/:cityCurrent weather for any city worldwide

$ curl -H "x-api-key: YOUR_KEY" \ https://api.feedplaza.com/v1/weather/Beijing

IP Geolocation

GET/v1/geo/:ipLook up location for any IP address

$ curl -H "x-api-key: YOUR_KEY" \
  https://api.feedplaza.com/v1/geo/8.8.8.8


→ {"data":{"city":"Mountain View","country":"United States","org":"Google LLC",...}}

Air Quality

GET/v1/air/:cityAir quality index for 15 major cities

$ curl -H "x-api-key: YOUR_KEY" \
  https://api.feedplaza.com/v1/air/beijing


→ {"data":{"city":"beijing","aqi":87,"aqi_level":"very poor","pm2_5":163.4,...}}

Cities: beijing, shanghai, tokyo, seoul, new-york, london, paris, delhi, singapore, sydney, los-angeles, mumbai, moscow, istanbul, jakarta

GET/v1/trendingGitHub trending repositories

Param	Type	Default	Description
`language`	query	all	Filter: python, javascript, go, rust…
`since`	query	daily	daily · weekly · monthly

$ curl -H "x-api-key: YOUR_KEY" \ "https://api.feedplaza.com/v1/trending?language=python&since=weekly"

Crypto & Forex

GET/v1/news/coingeckoBTC & ETH prices

GET/v1/news/exchangerateUSD exchange rates (8 currencies)

$ curl -H "x-api-key: YOUR_KEY" \ https://api.feedplaza.com/v1/news/coingecko
$ curl -H "x-api-key: YOUR_KEY" \ https://api.feedplaza.com/v1/news/exchangerate

Sources & Usage

GET/v1/sourcesList all data sources + status

GET/v1/usageCurrent billing period usage

GET/v1/healthAPI health check (no auth)

Error Codes

Status	Code	Meaning
401	unauthorized	Missing or invalid API key
402	quota_exceeded	Monthly limit reached — upgrade plan
409	conflict	Email already registered
422	validation_error	Invalid request parameters
429	rate_limited	Too many requests — slow down
502	source_unavailable	Upstream data source down
503	source_disabled	Source temporarily unavailable

Rate Limit Headers

Every API response includes these headers:

Header	Description
`X-RateLimit-Remaining`	Total credits left (signup + monthly)
`X-RateLimit-Signup`	Sign-up bonus credits remaining
`X-RateLimit-Monthly`	Monthly quota remaining
`X-RateLimit-Limit`	Total credits granted

Response Format

{
  "status": "ok",
  "data": [ ... ],
  "meta": {
    "source": "bbc-news",
    "count": 20,
    "credits_consumed": 1
  }
}

Questions? Sign up free and start building.