# Ticker Finology — 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 stocks, view company financials and market indices, track super investors and their holdings, and explore IPO listings and sector performance. Get comprehensive market data including company overviews, financial statements, and real-time dashboard information to make informed investment decisions.

**Category:** Finance & Markets | **Website:** [ticker.finology.in/](https://ticker.finology.in/) | **Docs:** [parse.bot/marketplace/3e6fa799-c910-4ffe-885a-46d2bfbc6f3b/ticker-finology-in-api](https://parse.bot/marketplace/3e6fa799-c910-4ffe-885a-46d2bfbc6f3b/ticker-finology-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-ticker-finology-in-api-3e6fa799/`
**Auth:** `Authorization: Bearer <LOCUS_API_KEY>`

## Endpoints

### get_company_news

Recent news articles for a company. Returns headlines, publication dates/times, and full article content in HTML. Typically returns the most recent 3-5 articles.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `fincode` | string | Yes | Company fincode from search_company results (e.g., '100470') |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-ticker-finology-in-api-3e6fa799/get_company_news \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"fincode":"<string>"}'
```

### get_company_overview

Detailed overview of a company including current price, key financial ratios (P/E, P/B, EPS, ROE, ROCE), 52-week range, market cap, debt/cash position, Finstar ratings, and index memberships. Parsed from the company page HTML.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `ticker` | string | Yes | Company ticker symbol (e.g., 'TATASTEEL', 'RELIANCE', 'INFY') |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-ticker-finology-in-api-3e6fa799/get_company_overview \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"ticker":"<string>"}'
```

### get_financial_tables

Quarterly P&L results, annual P&L, balance sheet, and cash flow statements for a company. Each table is an array of line items with a PARTICULARS key and period-named columns (e.g., 'Mar 2025'). Tables may be empty when data is unavailable for the requested mode.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `mode` | string | No | Financial reporting mode: 'S' for Standalone, 'C' for Consolidated |
| `ticker` | string | Yes | Company ticker symbol (e.g., 'TATASTEEL') |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-ticker-finology-in-api-3e6fa799/get_financial_tables \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"mode":"<string>","ticker":"<string>"}'
```

### get_ipo_list

IPO listings categorized as upcoming, current, and recently listed. Returns available IPO data from the site's IPO page. Categories may be empty when no IPOs are in that stage.

**Estimated cost:** Metered

_No parameters required._

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-ticker-finology-in-api-3e6fa799/get_ipo_list \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
```

### get_market_dashboard

Market dashboard with featured stocks, top gainers, and top losers. Featured stocks include price and day high; gainers/losers include price and percent change. Data is from BSE.

**Estimated cost:** Metered

_No parameters required._

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-ticker-finology-in-api-3e6fa799/get_market_dashboard \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
```

### get_peer_comparison

Peer companies in the same sector with key financial metrics. Returns up to 10 peers ranked by market cap. Each peer includes price, P/E, P/B, ROE, ROCE, EPS, and market cap.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `fincode` | string | Yes | Company fincode from search_company results (e.g., '100470') |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-ticker-finology-in-api-3e6fa799/get_peer_comparison \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"fincode":"<string>"}'
```

### get_price_chart_data

Historical BSE price chart data for a company. Returns daily closing prices for the specified number of years. Requires all three company identifiers from search_company results.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `count` | string | No | Number of years of historical data to return (e.g., '1', '2', '5') |
| `fincode` | string | Yes | Company fincode from search_company results (e.g., '100470') |
| `scripcode` | string | Yes | Company BSE scripcode from search_company results (e.g., '500470') |
| `symbol` | string | Yes | Company ticker symbol (e.g., 'TATASTEEL') |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-ticker-finology-in-api-3e6fa799/get_price_chart_data \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"count":"<string>","fincode":"<string>","scripcode":"<string>","symbol":"<string>"}'
```

### get_sector_details

Companies in a specific sector with current price, change, market cap, P/E, and P/B. Sector slug must come from get_sector_list. Returns the sector display name and full company list.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `sector_slug` | string | Yes | Sector slug from get_sector_list results (e.g., 'abrasives', 'steel-iron-products', 'advertising-media') |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-ticker-finology-in-api-3e6fa799/get_sector_details \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"sector_slug":"<string>"}'
```

### get_sector_list

All available sector categories with URL slugs. Use the slug values with get_sector_details to retrieve companies in that sector. Returns approximately 70 sectors.

**Estimated cost:** Metered

_No parameters required._

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-ticker-finology-in-api-3e6fa799/get_sector_list \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
```

### search_company

Full-text search over Indian listed companies by name or ticker symbol. Returns matching companies with their identifiers (fincode, scripcode, symbol) needed for other endpoints. Single-page result set.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `query` | string | Yes | Company name or ticker symbol (e.g., 'TATASTEEL', 'Reliance') |

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