# Marketindex — 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.

> Track ASX stock market data including company information, stock prices, dividends, director transactions, and sector performance. Search for stocks, monitor upcoming dividends, view market announcements, and analyze investment opportunities across the Australian securities exchange.

**Category:** Finance & Markets | **Website:** [marketindex.com.au/](https://marketindex.com.au/) | **Docs:** [parse.bot/marketplace/be89d625-7b03-4dd3-bd1f-99676d17e594/marketindex-com-au-api](https://parse.bot/marketplace/be89d625-7b03-4dd3-bd1f-99676d17e594/marketindex-com-au-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-marketindex-com-au-api-be89d625/`
**Auth:** `Authorization: Bearer <LOCUS_API_KEY>`

## Endpoints

### get_announcement_pdf

Retrieve the metadata and direct PDF download URL for a specific ASX announcement by its identifier string. The identifier is available from the get_asx_announcements or get_stock_announcements endpoints (the 'identifier' field, e.g. 'XASX:BHP:3A699003'). Returns announcement details including heading, date, file size, page count, price sensitivity, and a pdf_url field containing the direct URL to the PDF file.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `identifier` | string | Yes | Announcement identifier string as returned by get_asx_announcements or get_stock_announcements (e.g. 'XASX:BHP:3A699003') |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-marketindex-com-au-api-be89d625/get_announcement_pdf \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"identifier":"<string>"}'
```

### get_asx_announcements

Retrieve the latest ASX announcements across all listed companies. Supports pagination via limit and offset parameters. Each announcement includes heading, date, file type, price sensitivity, security name, and category types.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `limit` | integer | No | Number of announcements to retrieve per page. |
| `offset` | integer | No | Offset for pagination. Use with limit to page through results. |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-marketindex-com-au-api-be89d625/get_asx_announcements \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"limit":"<integer>","offset":"<integer>"}'
```

### get_asx_companies_list

Retrieve the full list of all ASX-listed companies. Returns every company with its stock code, name, security type, and trading status. The list is not paginated — the entire directory is returned in a single response.

**Estimated cost:** Metered

_No parameters required._

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-marketindex-com-au-api-be89d625/get_asx_companies_list \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
```

### get_asx_sectors

Retrieve performance data for all 11 ASX GICS sectors including Consumer Discretionary, Energy, Financials, Healthcare, Industrials, IT, Materials, Real Estate, Consumer Staples, Communication Services, and Utilities. Each sector includes live quote and period averages.

**Estimated cost:** Metered

_No parameters required._

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-marketindex-com-au-api-be89d625/get_asx_sectors \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
```

### get_director_profile

Retrieve a specific director's profile page data by their name slug. Returns the director name, slug, and raw Nuxt page data when available. The slug is derived from the director's full name in lowercase hyphenated format.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `director_slug` | string | Yes | Director name slug in lowercase hyphenated format (e.g. 'linda-elkins', 'john-smith') |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-marketindex-com-au-api-be89d625/get_director_profile \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"director_slug":"<string>"}'
```

### get_director_transactions

Retrieve the 200 most recent ASX director/insider transactions. Includes buy, sell, exercise, and issued transactions with price and value details. Results are pre-sorted by recency; no pagination or filtering is available.

**Estimated cost:** Metered

_No parameters required._

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-marketindex-com-au-api-be89d625/get_director_transactions \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
```

### get_highest_dividend_yield

Retrieve a list of ASX stocks ranked by highest dividend yield. Includes price, yield percentage, gross yield, annual change, franking average, and DRP (Dividend Reinvestment Plan) status. Covers ordinary shares, preference shares, and REITs.

**Estimated cost:** Metered

_No parameters required._

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-marketindex-com-au-api-be89d625/get_highest_dividend_yield \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
```

### get_market_news

Retrieve the latest market news articles from Market Index. Returns an array of articles each with title, publication date, URL path, category, related stock codes, video flag, and content type.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `limit` | integer | No | Number of news articles to retrieve. |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-marketindex-com-au-api-be89d625/get_market_news \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"limit":"<integer>"}'
```

### get_market_overview

Retrieve the current market overview including major ASX indices (ASX 200, All Ords, Resources, Small Ords, Industrials) with live quotes and historical averages. Returns both a curated set of key indices and the full list of all available indices.

**Estimated cost:** Metered

_No parameters required._

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-marketindex-com-au-api-be89d625/get_market_overview \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
```

### get_stock_announcements

Retrieve the latest announcements for a specific ASX stock. Returns up to 50 announcements with heading, date, file type, price sensitivity flag, and announcement category types. The response includes a total count of all available announcements.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `code` | string | Yes | ASX stock ticker code in uppercase (e.g. 'BHP', 'CBA') |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-marketindex-com-au-api-be89d625/get_stock_announcements \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"code":"<string>"}'
```

### get_stock_overview

Retrieve detailed overview for a specific ASX stock by ticker code. Returns comprehensive data including price, change, volume, market cap, dividend info, sector classification, GICS details, and fundamentals (EPS, book value, debt-to-equity, shares outstanding).

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `code` | string | Yes | ASX stock ticker code in uppercase (e.g. 'BHP', 'CBA', 'CSL') |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-marketindex-com-au-api-be89d625/get_stock_overview \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"code":"<string>"}'
```

### get_upcoming_dividends

Retrieve the list of upcoming ASX dividend payments ordered by ex-date. Includes dividend per share, franking percentage, yield, company details with current price and market cap, and days until payment.

**Estimated cost:** Metered

_No parameters required._

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-marketindex-com-au-api-be89d625/get_upcoming_dividends \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
```

### search_stocks

Search for ASX stocks by name or ticker code. Performs a case-insensitive match against all listed companies and returns up to 50 results. Matches against both the stock code and the full company name.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `query` | string | Yes | Search query to match against stock codes or company names (e.g. 'BHP', 'mining', 'bank') |

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