Stock Screening API

Overview

GET /v1/finance/stock/screen provides stock screening and ranking. Without filter parameters it returns a simple ranking; with filters it screens by multiple dimensions.

Usage Modes

Mode	Example	Description
Top gainers	`?sort_by=change_pct&limit=10`	Today's top 10 gainers
Top losers	`?sort_by=change_pct&order=asc&limit=10`	Today's top 10 losers
Screening	`?industry=半导体&pe_max=30`	Semiconductor stocks with PE < 30
High dividend	`?min_dividend_yield=3`	Stocks with dividend yield > 3%

Request Parameters

Parameter	Type	Required	Default	Description
`industry`	string	No	-	Industry filter
`pe_max`	float	No	-	PE(TTM) upper bound
`pe_min`	float	No	-	PE(TTM) lower bound
`pb_max`	float	No	-	PB upper bound
`min_market_cap`	float	No	-	Min market cap (CNY)
`max_market_cap`	float	No	-	Max market cap (CNY)
`min_dividend_yield`	float	No	-	Min dividend yield (%)
`sort_by`	string	No	`change_pct`	Sort field
`order`	string	No	`desc`	Sort order: desc/asc
`limit`	int	No	20	Results limit (1-100)

Request Example

curl -H "X-API-Key: sk_gapi_xxxxx" \
  "https://api.groundapi.net/v1/finance/stock/screen?industry=半导体&pe_max=30&limit=10"

Response Fields

Field	Description
`trade_date`	Trading date
`filter_summary`	Filter criteria summary
`match_count`	Matching stock count
`items[].symbol`	Stock code
`items[].name`	Stock name
`items[].industry`	Industry
`items[].price`	Current price (CNY)
`items[].change_pct`	Change (%)
`items[].pe_ttm`	PE (TTM)
`items[].pb`	PB
`items[].total_market_cap`	Market cap (CNY)

Pricing

$0.02/call (stock_analysis). First 500 calls/month are free.