# Ticker Ids

Return ticker ids from a public sitemap shard. Pass a returned id unchanged to quote, ratings, statement, price and news. Without type and part, shard 0/0 is read.

- **Documentation:** [https://scrappa.co/docs/finviz-api/finviz_ticker_ids](https://scrappa.co/docs/finviz-api/finviz_ticker_ids)
- **API group:** Finviz API
- **Endpoint:** `GET https://scrappa.co/api/finviz/ticker-ids`

## Authentication

Send your Scrappa API key in the `X-API-KEY` request header. Paid endpoints also support accountless x402 payments when called without an API key.

## Parameters

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| `type` | string | No | Optional sitemap shard type. |
| `part` | integer | No | Optional sitemap shard number. |

## Example request

```bash
#!/bin/bash

curl -X GET \
    -H "x-api-key: YOUR_API_KEY_HERE" \
    "https://scrappa.co/api/finviz/ticker-ids"
```

## Example response

```json
{
    "tickers": [
        "AAPL",
        "MSFT"
    ],
    "count": 2,
    "source": "finviz"
}
```

## Errors

| Status | Error | Description |
| --- | --- | --- |
|  | No tickers | No ticker ids were returned. |

## More Scrappa resources

- [API documentation](https://scrappa.co/docs)
- [Full LLM-readable API reference](https://scrappa.co/llms-full.txt)
- [OpenAPI specification](https://scrappa.co/docs/api.json)
- [Pricing](https://scrappa.co/pricing)
