# GET /v1/hashtag: Instagram hashtag API

A hashtag's id, name and how many posts use it.

- Call: `GET https://storiesfly.com/api/v1/hashtag`
- Price **1 request**
- Answers up to **1 hour** old

## Parameters

All parameters go in the query string.

| Name | Type | Sent | Description |
| --- | --- | --- | --- |
| `name` | string | required | Hashtag, with or without the #. Letters, digits and underscores. |

## Example request

Put your own key in the header.

### cURL

```bash
curl "https://storiesfly.com/api/v1/hashtag?name=sunset" \
  -H "X-Api-Key: sf_live_your_key"
```

### JavaScript

```javascript
const res = await fetch(
  "https://storiesfly.com/api/v1/hashtag?name=sunset",
  { headers: { "X-Api-Key": process.env.STORIESFLY_KEY } }
);
const data = await res.json();
```

### Python

```python
import os
import requests

r = requests.get(
    "https://storiesfly.com/api/v1/hashtag",
    params={"name": "sunset"},
    headers={"X-Api-Key": os.environ["STORIESFLY_KEY"]},
)
data = r.json()
```

## Example response

200 OK · X-Units-Charged: 1

```json
{
  "id": "17843814268026415",
  "name": "sunset",
  "posts_count": 347287896,
  "profile_pic_url": null
}
```

A real answer, shortened: lists are cut to two items and long texts to 160 characters.

## Price and freshness

A call takes 1 request. Free requests are spent first, then your balance. The [pricing](https://storiesfly.com/developers/pricing) page has the rates.

Answers are kept for up to 1 hour. Asking again inside that time returns the same answer and takes 1 request again.

## Errors

A failed call answers with an HTTP status and a body `{error, code}`. These are the codes this endpoint gives. [Errors and what is charged](https://storiesfly.com/developers/docs#errors) covers all of them.

| Status | Code | When |
| --- | --- | --- |
| `400` | `bad_request` | A parameter is missing or wrong. `fields` lists the names. Free. |
| `401` | `unauthorized` | The `X-Api-Key` header is missing or the key is wrong. Free. |
| `402` | `credits_exhausted` | The free requests and the balance are used up. Top up in the [dashboard](https://storiesfly.com/developers/dashboard). Free. |
| `403` | `telegram_required` | The account behind the key is not linked to Telegram. The answer has a `link_url` to do it. Free. |
| `404` | `not_found` | The hashtag does not exist. Charged like an answer. |
| `429` | `rate_limited` | More requests in a second than your level allows. Wait for the `Retry-After` header. Free. |
| `500` | `internal_error` | A fault on our side. Retry shortly. Refunded. |
| `503` | `upstream_unavailable` | Our side failed or timed out. Retry shortly. Refunded. |

## Questions about this endpoint

### What does it return?

The `id` of the hashtag, its `name`, `posts_count` (how many posts use it) and a picture link when there is one.

### Do I send the # sign?

With or without it. `name` takes letters, digits and underscores, and is read in lower case.

### How do I see the posts?

[hashtag/posts](https://storiesfly.com/developers/docs/hashtag-posts) lists the posts under a hashtag: top, recent or reels.

## Related endpoints

- [GET /v1/hashtag/posts](https://storiesfly.com/developers/docs/hashtag-posts): Posts under a hashtag: top, recent or reels
- [GET /v1/search/hashtags](https://storiesfly.com/developers/docs/search-hashtags): Find hashtags, with their post counts
- [GET /v1/search/top](https://storiesfly.com/developers/docs/search-top): The top posts for a text

## Links

- [This page on the site](https://storiesfly.com/developers/docs/hashtag)
- [Instagram data API](https://storiesfly.com/developers): what the API is and what it returns
- [Pricing](https://storiesfly.com/developers/pricing): rates, examples and billing rules
- [Documentation](https://storiesfly.com/developers/docs): quick start, authentication, errors and every endpoint
- [OpenAPI file](https://storiesfly.com/openapi.json): the whole API in one file
- [API dashboard](https://storiesfly.com/developers/dashboard): get a key and top up
- [Changelog](https://storiesfly.com/developers/changelog): what changed and when