# Tipranks — Wrapped API

> **You are on:** `https://api.beta.paywithlocus.com/api` | [llms.txt](https://beta.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.

> Discover top-performing stocks and access detailed analyst ratings and earnings forecasts to make informed investment decisions. Get real-time stock information including performance metrics and expert analyst opinions all in one place.

**Category:** Finance & Markets | **Website:** [tipranks.com/](https://tipranks.com/) | **Docs:** [parse.bot/marketplace/697e5f16-1200-4c29-a181-c580bb62981f/tipranks-com-api](https://parse.bot/marketplace/697e5f16-1200-4c29-a181-c580bb62981f/tipranks-com-api)

Pay-per-use API proxy for Locus Pro. Each call burns credits from your workspace balance.

## Access

**Base URL:** `https://api.beta.paywithlocus.com/api/wrapped/credits/tipranks/`
**Auth:** `Authorization: Bearer <LOCUS_CREDITS_SECRET_KEY>` (an `lcr_` secret key or a scoped `lcac_` agent credential)
**Required header:** `Idempotency-Key: <fresh UUID per call>`. A retry with the same key replays the stored result without a new charge.
**Response:** the provider response after any endpoint-specific normalization. `X-Locus-Credits-Charged` carries the charge and `X-Locus-Credits-Balance` the remaining balance. Insufficient credits return `402` before the provider is called.
**Pricing:** estimated costs below are USD. Locus debits the credit equivalent at your workspace rate.

Full call contract: https://docs.paywithlocus.com/api-reference/introduction

> Using a Pay With Locus wallet key (`claw_` prefix)? Wallet routes are documented separately: https://docs.paywithlocus.com/wrapped-apis/for-agents

## Endpoints

### Get best stocks

Fetches top stocks ranked by TipRanks Smart Score and sorted by consensus upside potential. Each stock includes analyst detailed ratings (name, firm, price target, action) and earnings reports that caused greater than 6% price movement. The screener data refreshes periodically; results reflect TipRanks' current top-scored universe. Returns a single page capped by limit.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `limit` | integer | No | Maximum number of top stocks to return. |

```bash
curl -X POST https://api.beta.paywithlocus.com/api/wrapped/credits/tipranks/get-best-stocks \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"limit":"<integer>"}'
```

### Get stock info

Returns comprehensive analysis for a single stock ticker including company fundamentals (CEO, sector, industry, employees), current price, analyst consensus breakdown (buy/hold/sell counts, price target range, upside), individual analyst ratings with price targets and actions, and historical earnings reports that moved the stock price more than 6%. Requires a valid US or international ticker symbol recognized by TipRanks.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `ticker` | string | Yes | Stock ticker symbol (e.g. AAPL, TSLA, MSFT). |

```bash
curl -X POST https://api.beta.paywithlocus.com/api/wrapped/credits/tipranks/get-stock-info \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"ticker":"<string>"}'
```

### Get top stocks and analysts

Returns a combined view of the top 10 TipRanks SmartScore stocks (ranked by score) and the top 10 Wall Street analysts (ranked by TipRanks star rating). Each stock includes company name, ticker, smart score, current price, and consensus upside. Each analyst includes rank, name, firm, sector, success rate, average return, rating distribution, and their most recent stock analysis (ticker, position, action, price target, date). Data refreshes periodically from TipRanks' screener and expert ranking systems.

**Estimated cost:** Metered

_No parameters required._

```bash
curl -X POST https://api.beta.paywithlocus.com/api/wrapped/credits/tipranks/get-top-stocks-and-analysts \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{}'
```

## Next steps

- [All wrapped API providers](https://beta.paywithlocus.com/wapi/index.md): pick another provider.
- [Find and call tools](https://beta.paywithlocus.com/agent/tools.md): price ceilings, async results, and errors.
- [Credits and billing](https://beta.paywithlocus.com/agent/billing.md): what a call costs and how to add credits.
- [Agent docs index](https://beta.paywithlocus.com/agent/index.md): every Locus agent page.