# Morningstar (Australia) — 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.

> Access comprehensive financial data for Australian stocks, ETFs, and managed funds including key metrics, valuations, dividends, and historical prices. Search securities, review company profiles and ownership details, and stay informed with market news and upcoming dividend information.

**Category:** Finance & Markets | **Website:** [morningstar.com.au/](https://morningstar.com.au/) | **Docs:** [parse.bot/marketplace/123752f8-1821-4c64-ab0a-409b4236ce29/morningstar-com-au-api](https://parse.bot/marketplace/123752f8-1821-4c64-ab0a-409b4236ce29/morningstar-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-morningstar-com-au-api-123752f8/`
**Auth:** `Authorization: Bearer <LOCUS_API_KEY>`

## Endpoints

### get_company_profile

Retrieve company profile including business description, contact information (address, phone, website), sector, industry, fiscal year end, most recent earnings date, and total number of employees.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `exchange` | string | Yes | Exchange code. |
| `symbol` | string | Yes | Ticker symbol. |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-morningstar-com-au-api-123752f8/get_company_profile \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"exchange":"<string>","symbol":"<string>"}'
```

### get_dividends

Retrieve dividend history for a security including per-share amounts, trailing yield, payout ratio, buyback yield over multiple years, plus detailed dividend event history (ex-date, pay-date, amount, franked rate).

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `exchange` | string | Yes | Exchange code. |
| `symbol` | string | Yes | Ticker symbol. |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-morningstar-com-au-api-123752f8/get_dividends \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"exchange":"<string>","symbol":"<string>"}'
```

### get_financial_statements

Retrieve detailed financial statements (Income Statement, Balance Sheet, or Cash Flow) with line-item breakdowns across multiple years. Returns hierarchical rows with labels and data arrays corresponding to column definitions (years). Some data is premium-only.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `exchange` | string | Yes | Exchange code. |
| `period` | string | No | Period: 'A' for Annual, 'Q' for Quarterly. |
| `statement` | string | No | Statement type: 'incomeStatement', 'balanceSheet', or 'cashFlow'. |
| `symbol` | string | Yes | Ticker symbol. |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-morningstar-com-au-api-123752f8/get_financial_statements \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"exchange":"<string>","period":"<string>","statement":"<string>","symbol":"<string>"}'
```

### get_historical_prices

Retrieve historical price time series for a security at daily frequency. Returns an array of datetime/value pairs and a change summary with net price change and percentage over the period.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `exchange` | string | Yes | Exchange code. |
| `period` | string | No | Time period for historical data. |
| `symbol` | string | Yes | Ticker symbol. |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-morningstar-com-au-api-123752f8/get_historical_prices \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"exchange":"<string>","period":"<string>","symbol":"<string>"}'
```

### get_market_overview

Retrieve global market indices overview including major equity indices (ASX 200, S&P 500, NASDAQ, etc.), currency pairs (AUD/USD, etc.), and commodities (Gold, Oil, Silver) with latest prices and percentage changes.

**Estimated cost:** Metered

_No parameters required._

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

### get_news_and_insights

Retrieve news articles and insights from Morningstar analysts. Parses the insights page for the specified category. Returns article titles, URLs, authors, and publication dates.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `category` | string | No | Article category. |
| `limit` | integer | No | Maximum number of articles to return. |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-morningstar-com-au-api-123752f8/get_news_and_insights \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"category":"<string>","limit":"<integer>"}'
```

### get_ownership

Retrieve institutional and mutual fund ownership data for a security. Returns top 5 holders in each category with shares held, percentage of total shares, change amounts, and dates.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `exchange` | string | Yes | Exchange code. |
| `symbol` | string | Yes | Ticker symbol. |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-morningstar-com-au-api-123752f8/get_ownership \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"exchange":"<string>","symbol":"<string>"}'
```

### get_security_key_metrics

Retrieve multi-year key financial metrics including income statement summary, revenue/earnings growth rates, profitability ratios (ROA, ROE, ROIC), financial health indicators (current ratio, debt/equity), and cash flow metrics (free cash flow growth, FCF per share).

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `exchange` | string | Yes | Exchange code. |
| `symbol` | string | Yes | Ticker symbol. |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-morningstar-com-au-api-123752f8/get_security_key_metrics \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"exchange":"<string>","symbol":"<string>"}'
```

### get_security_summary

Retrieve the summary overview for a security including Morningstar star rating, fundamentals (fair value, moat, stewardship), ESG sustainability data, trading ranges, market cap, volume, and valuation ratios. Some fields are premium-only (marked '_PO_').

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `exchange` | string | Yes | Exchange code (e.g. 'ASX', 'NYSE'). |
| `symbol` | string | Yes | Ticker symbol (e.g. 'BHP', 'CBA', 'CSL'). |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-morningstar-com-au-api-123752f8/get_security_summary \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"exchange":"<string>","symbol":"<string>"}'
```

### get_upcoming_dividends

Retrieve calendar of upcoming dividend payments for ASX-listed securities within the next 90 days. Returns securities with ex-date, pay-date, dividend amount, and franking rate sorted by pay date ascending.

**Estimated cost:** Metered

_No parameters required._

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

### get_valuation

Retrieve valuation metrics including Price/Sales, Price/Earnings, Price/Cash Flow, Price/Book, PEG Ratio, Earnings Yield, Enterprise Value, and EV/EBIT over multiple calendar years plus current and 5-year averages.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `exchange` | string | Yes | Exchange code. |
| `symbol` | string | Yes | Ticker symbol. |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-morningstar-com-au-api-123752f8/get_valuation \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"exchange":"<string>","symbol":"<string>"}'
```

### search_securities

Search for stocks, ETFs, and managed funds by name or ticker symbol. Returns matching securities across all security types (stocks, ETFs, managed funds). Results include the security ID, performanceId, type, name, symbol, and exchange code needed to call other endpoints.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `limit` | integer | No | Maximum number of results to return. |
| `query` | string | Yes | Search term such as a company name or ticker symbol. |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-morningstar-com-au-api-123752f8/search_securities \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"limit":"<integer>","query":"<string>"}'
```