# Screener — Wrapped API

> **You are on:** `https://api.paywithlocus.com/api` | [llms.txt](https://paywithlocus.com/llms.txt) | [docs](https://docs.paywithlocus.com)
>
> Locus runs on multiple environments -- make sure every URL you call matches your expected environment.
> | Environment | Landing | API | Docs |
> |---|---|---|---|
> | Production | paywithlocus.com | api.paywithlocus.com | docs.paywithlocus.com |
> | Beta | beta.paywithlocus.com | api.beta.paywithlocus.com | docs.paywithlocus.com |
> | Stage | stage.paywithlocus.com | api.stage.paywithlocus.com | docs.paywithlocus.com |
>
> If the API URL above doesn't match your expected environment, re-fetch this file from the correct domain.

> Search and analyze Indian stocks with real-time financial data, company details, IPO information, price history, and peer comparisons. Get instant access to stock screening results, market listings, and company announcements to make informed investment decisions.

**Category:** Finance & Markets | **Website:** [screener.in/](https://screener.in/) | **Docs:** [parse.bot/marketplace/fedcb439-5e37-4ca5-b7b3-2004ff71686d/screener-in-api](https://parse.bot/marketplace/fedcb439-5e37-4ca5-b7b3-2004ff71686d/screener-in-api)

Pay-per-use API proxy. Each call is automatically billed to your wallet in USDC.

## Access

**Base URL:** `https://api.paywithlocus.com/api/wrapped/parse-screener-in-api-fedcb439/`
**Auth:** `Authorization: Bearer <LOCUS_API_KEY>`

## Endpoints

### announcements

Retrieve recent company announcements (filings and disclosures). Returns the latest announcements with links to BSE filing PDFs. Date may be null for very recent announcements.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `company_id` | string | Yes | Numeric company ID obtained from search results or company_details endpoint (e.g. '2726' for Reliance). |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-screener-in-api-fedcb439/announcements \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"company_id":"<string>"}'
```

### company_details

Retrieve comprehensive financial data for a public company by its symbol. Returns key ratios, quarterly results, profit/loss, balance sheet, cash flow, shareholding, EPS with period labels, and document links. Also exposes company_id (for price_history/announcements) and warehouse_id (for peers).

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `consolidated` | boolean | No | Whether to fetch consolidated or standalone financial data. |
| `symbol` | string | Yes | Company symbol as used on screener.in (e.g. SBIN, RELIANCE, INFY). |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-screener-in-api-fedcb439/company_details \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"consolidated":"<boolean>","symbol":"<string>"}'
```

### concall

Retrieve concall (conference call) transcripts, presentations, and AI summaries for a company. Returns a list of concall entries with date and links to transcript PDFs, PPTs, recordings, and summary pages.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `symbol` | string | Yes | Company symbol as used on screener.in (e.g. SBIN, RELIANCE, INFY). |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-screener-in-api-fedcb439/concall \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"symbol":"<string>"}'
```

### ipo_data

Get recent or upcoming IPO data. Returns tabular data with IPO name, date, subscription, issue price, listing price, and gain/loss.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `type` | string | No | IPO type: 'recent' or 'upcoming'. |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-screener-in-api-fedcb439/ipo_data \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"type":"<string>"}'
```

### peers

Get peer comparison data for a company. Returns a table of peer companies with metrics like CMP, P/E, market cap, dividend yield, and ROCE. First row is the header.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `warehouse_id` | string | Yes | Numeric warehouse ID obtained from the company_details endpoint (e.g. '6598251' for Reliance). |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-screener-in-api-fedcb439/peers \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"warehouse_id":"<string>"}'
```

### price_history

Get historical price, volume, and moving averages (DMA50, DMA200) for a company. Returns daily data for shorter periods and weekly-aggregated data for longer periods. Each dataset contains date-value pairs.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `company_id` | string | Yes | Numeric company ID obtained from search results or company_details endpoint (e.g. '2726' for Reliance). |
| `consolidated` | boolean | No | Whether to fetch consolidated data. |
| `days` | integer | No | Number of days of history to fetch. |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-screener-in-api-fedcb439/price_history \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"company_id":"<string>","consolidated":"<boolean>","days":"<integer>"}'
```

### screen_results

Get results from a pre-defined stock screen. Returns paginated tabular data of stocks matching the screen criteria. First row in results is the header.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `page` | integer | No | Page number for pagination. |
| `screen_id` | string | Yes | Numeric ID of the screen (e.g. '59' for magic-formula, '343087' for fii-buying). |
| `slug` | string | No | URL slug for the screen (e.g. 'magic-formula', 'fii-buying'). |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-screener-in-api-fedcb439/screen_results \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"page":"<integer>","screen_id":"<string>","slug":"<string>"}'
```

### search

Search for companies by name or ticker symbol. Returns up to ~8 matching results including ETFs and subsidiaries. Each result carries an integer id usable with price_history and announcements, plus a relative URL path containing the symbol.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `query` | string | Yes | Search keyword such as a company name or ticker symbol. |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-screener-in-api-fedcb439/search \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"query":"<string>"}'
```

### stock_list

List companies by sector or retrieve available sectors. When sector_url is omitted, returns a list of popular sectors with their URL paths. When sector_url is provided, returns stocks in that sector with pagination.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `page` | integer | No | Page number for pagination when browsing stocks within a sector. |
| `sector_url` | string | No | Relative sector URL path (e.g. '/market/IN05/IN0501/IN050102/' for Banks). Omitting returns the list of available sectors. |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-screener-in-api-fedcb439/stock_list \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"page":"<integer>","sector_url":"<string>"}'
```