---
title: "Yahoo Finance lookup"
method: GET
path: "/yahoo-finance/lookup"
tags: ["Yahoo Finance"]
---

# Yahoo Finance lookup

`GET /yahoo-finance/lookup`

## Request

- Base URL: `https://api.crawlora.net/api/v1`
- URL: `https://api.crawlora.net/api/v1/yahoo-finance/lookup`
- Auth: API key in header `x-api-key`

Looks up instruments on Yahoo Finance by ticker symbol or company name, optionally filtered to one type: equity, ETF, mutual fund, index, future, currency or cryptocurrency. Page with `count` and `start`. Returns the matching instruments, each with its symbol, short name, quote type and exchange, and the total.

## Query parameters

- `query` string, required
- `type` 'all' | 'equity' | 'etf' | 'mutualfund' | 'index' | 'future' | 'currency' | 'cryptocurrency'
- `count` integer
- `start` integer

## Headers

- `x-api-key` string, required

## Response `200`

OK

- YahoofinanceLookupResponseDoc
  - `code` integer
  - `data` YahoofinanceLookupResponse
    - `count` integer: Number of documents returned.
    - `documents` object[]: Matching instruments, one object per match.
    - `query` string: Lookup text that was run.
    - `start` integer: Zero-based offset of the first result.
    - `total` integer: Total number of matches reported by Yahoo Finance.
    - `type` string: Instrument type filter applied, for example `all`.
  - `msg` string

## Other responses

- `400`: Bad Request
- `404`: Not Found
- `500`: Internal Server Error
- `503`: Service Unavailable

---

[API](https://skmtc.dev/crawlora/apis/crawlora-api.md) · [All operations](https://skmtc.dev/crawlora/apis/crawlora-api/llms.txt) · [OpenAPI document](https://skmtc.dev/crawlora/apis/crawlora-api/revisions/0497899e2016?raw)