hashtags

HashTags API Endpoint: Automatically generate hashtags for posts based on the most relevant keywords. Takes into account real-time hashtag popularity.

Hashtag API Endpoints

Generate hashtags for TikTok, Instagram, Facebook, Twitter, LinkedIn, and YouTube.

Premium or Business Plan required.

❗Click the › in the endpoint to view details.

Auto Hashtags

POST https://app.ayrshare.com/api/hashtags/auto

Automatically add hashtags to your post. Maximum post length is 1,000 characters. If over limit, hashtags will not be added.

Headers

Name	Type	Description
Authorization*	string	Format: Authorization: Bearer API _KEY. See Overview for more information.

Request Body

Name	Type	Description
post*	string	Post text to add the hashtags. Max length 1,000 characters.
position	string	Values: "auto" or "end". "end" hashtags at the end of the text, "auto" hashtags anywhere in the text or at the end. Default "auto".
max	number	Integer of max number of Hashtags to add. Max value range 1 to 5. Default 2.

200 Returns the hashtagged post

{
    post: "Disney’s trouble with Oswald the #LuckyRabbit is a great lesson #ForStartups in a crisis"
}

Request Examples

cURL

curl \
-H "Authorization: Bearer API_Key" \
-d '{"post": "Today is a great day!", "max": 3, "position": "auto"}'
-X POST https://app.ayrshare.com/api/hashtags/auto

Node.js

const API_KEY = "API_KEY";
fetch(`https://app.ayrshare.com/api/hashtags/auto`, {
      method: "POST",
      headers: {
        "Authorization": `Bearer ${API_KEY}`
      },
      body: JSON.stringify({
        post: "Today is a great day!", // required
        max: 3,           // optional, range 1-5
        position: "auto"  // optional, "auto" or "end"
      })
    })
      .then((res) => res.json())
      .then((json) => console.log(json))
      .catch(console.error);

Python

import requests

payload = {
        'post': 'Today is a great day!',
        'max': 3,           # optional, range 1-5
        'position': 'auto'  # optional, 'auto' or 'end'
}
headers = {'Content-Type': 'application/json', 
        'Authorization': 'Bearer API_KEY'}

r = requests.post('https://app.ayrshare.com/api/hashtags/auto', 
    json=payload, 
    headers=headers)
        
print(r.json())

PHP

<?php
require 'vendor/autoload.php';// Composer auto-loader using Guzzle. See https://docs.guzzlephp.org/en/stable/overview.html

$client = new GuzzleHttp\Client();
$res = $client->request(
    'POST',
    'https://app.ayrshare.com/api/hashtags/auto',
    [
        'headers' => [
            'Content-Type'  => 'application/json',
            'Authorization' => 'Bearer API_KEY'
        ],
        'json' => [
            'post' => 'Today is a great day!',
            'max'  => 3,
            'position' => 'auto'
        ]
    ]
);

echo json_encode(json_decode($res->getBody()), JSON_PRETTY_PRINT);

Recommend Hashtags

GET https://app.ayrshare.com/api/hashtags/recommend

Get suggestions for hashtags based on a keyword. Data and view counts are generated from TikTok.

Query Parameters

Name	Type	Description
keyword*	string	A single keyword to get recommended hashtags from TikTok. Spaces in the keyword will be removed.

Headers

Name	Type	Description
Authorization*	string	Format: Authorization: Bearer API _KEY. See Overview for more information.

200: OK Success

{
    "keyword": "apple",
    "recommendations": [
        {
            "viewCount": 71950998550, // The number of views that the recommended hashtag has received.
            "name": "apple"           // Suggested hashtag
        },
        {
            "viewCount": 6318280101,
            "name": "applewatch"
        },
        {
            "viewCount": 2486358394,
            "name": "applepencil"
        },
        {
            "viewCount": 2142842131,
            "name": "applemusic"
        },
        {
            "viewCount": 1506224079,
            "name": "applesquad"
        },
        {
            "viewCount": 1307287255,
            "name": "apples"
        },
        {
            "viewCount": 1008293028,
            "name": "applepie"
        },
        {
            "viewCount": 788388838,
            "name": "applejuice"
        },
        {
            "viewCount": 1024901638,
            "name": "appletv"
        },
        {
            "viewCount": 679033194,
            "name": "applechallenge"
        }
    ]
}

400: Bad Request Missing keyword

{
    "action": "request",
    "status": "error",
    "code": 101,
    "message": "Missing or incorrect parameters. Please verify with the docs. https://docs.ayrshare.com/rest-api/endpoints"
}

Request Examples

cURL

curl \
-H "Authorization: Bearer API_KEY" \
-X GET https://app.ayrshare.com/api/hashtags/recommend?keyword=apple

Node.js

const API_KEY = "API_KEY";
fetch("https://app.ayrshare.com/api/hashtags/recommend?keyword=apple", {
      method: "GET",
      headers: {
        "Authorization": `Bearer ${API_KEY}`
      }
    })
      .then((res) => res.json())
      .then((json) => console.log(json))
      .catch(console.error);jav

Python

import requests

headers = {'Authorization': 'Bearer API_KEY'}

r = requests.get('https://app.ayrshare.com/api/hashtags/recommend?keyword=apple', headers=headers)
    
print(r.json())

PHP

<?php
require 'vendor/autoload.php';// Composer auto-loader using Guzzle. See https://docs.guzzlephp.org/en/stable/overview.html

$client = new GuzzleHttp\Client();
$res = $client->request(
    'GET',
    'https://app.ayrshare.com/api/hashtags/recommend?keyword=apple',
    [
        'headers' => [
            'Content-Type'      => 'application/json',
            'Authorization'     => 'Bearer API_KEY'
        ]
    ]
);

echo json_encode(json_decode($res->getBody()), JSON_PRETTY_PRINT); 

C#

using System;
using System.Net;
using System.IO;

namespace HistoryGETRequest_charp
{
    class History
    {
        static void Main(string[] args)
        {
            string API_KEY = "API_KEY";
            string url = "https://app.ayrshare.com/api/hashtags/recommend?keyword=apple";

            var httpWebRequest = WebRequest.CreateHttp(url);
            httpWebRequest.ContentType = "application/json";
            httpWebRequest.Headers.Add("Authorization", "Bearer " + API_KEY);

            var httpResponse = (HttpWebResponse)httpWebRequest.GetResponse();
            using (var streamReader = new StreamReader(httpResponse.GetResponseStream()))
            {
                var response = streamReader.ReadToEnd();
                Console.WriteLine(response);
            }
        }
    }
}

---

Check Banned Hashtags

GET https://app.ayrshare.com/api/hashtags/banned

A banned hashtag checker to validate if the given hashtag has been banned by Instagram or other social networks.

Headers

Name	Value
Content-Type	application/json
Authorization	Bearer API_KEY

Query

Name	Type	Description
*	string	The hashtag to validate. Format: "hashtag" or "#hashtag"

Response

200

{
    "hashtag": "#bikinibody",
    "banned": true
}

400

{
    "action": "request",
    "status": "error",
    "code": 101,
    "message": "Missing or incorrect parameters. Please verify with the docs. https://docs.ayrshare.com/rest-api/endpoints"
}

Request Examples

cURL

curl --location --request GET 'https://app.ayrshare.com/ayrshare/api/hashtags/banned?hashtag=%23bikinibody' \
--header 'Authorization: Bearer API_KEY'

Node.js

const myHeaders = new Headers();
myHeaders.append("Authorization", "Bearer API_KEY");

const urlencoded = new URLSearchParams();

const requestOptions = {
  method: 'GET',
  headers: myHeaders,
};

fetch("https://app.ayrshare.com/api/hashtags/banned?hashtag=%23bikinibody", requestOptions)
  .then(response => response.json())
  .then(result => console.log(result))
  .catch(error => console.log('error', error));

Python

import requests

# Your API key
API_KEY = "Bearer API_KEY"

# Headers
headers = {
    "Authorization": API_KEY
}

# URL
url = "https://app.ayrshare.com/api/hashtags/banned?hashtag=%23bikinibody"

# Making the GET request
response = requests.get(url, headers=headers)

# Checking if the request was successful
if response.status_code == 200:
    # Parse JSON response
    result = response.json()
    print(result)
else:
    print("Error:", response.status_code)

PHP

<?php

// Your API key
$apiKey = "Bearer API_KEY";

// URL
$url = "https://app.ayrshare.com/api/hashtags/banned?hashtag=%23bikinibody";

// Initialize cURL session
$ch = curl_init($url);

// Set cURL options
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "Authorization: $apiKey"
]);

// Execute cURL session
$response = curl_exec($ch);

// Check if any error occurred
if(curl_errno($ch)) {
    echo 'Curl error: ' . curl_error($ch);
} else {
    // Decode JSON response
    $result = json_decode($response, true);
    echo print_r($result, true);
}

// Close cURL session
curl_close($ch);

?>

C#

using System;
using System.Net.Http;
using System.Threading.Tasks;

namespace ConsoleApp
{
    class Program
    {
        static async Task Main(string[] args)
        {
            // Your API key
            string apiKey = "Bearer API_KEY";

            // URL
            string url = "https://app.ayrshare.com/api/hashtags/banned?hashtag=%23bikinibody";

            using (var httpClient = new HttpClient())
            {
                // Set the Authorization header with your API key
                httpClient.DefaultRequestHeaders.Add("Authorization", apiKey);

                try
                {
                    // Make the GET request
                    HttpResponseMessage response = await httpClient.GetAsync(url);

                    if (response.IsSuccessStatusCode)
                    {
                        // Read the response content as a string
                        string result = await response.Content.ReadAsStringAsync();
                        Console.WriteLine(result);
                    }
                    else
                    {
                        Console.WriteLine($"Error: {response.StatusCode}");
                    }
                }
                catch (HttpRequestException e)
                {
                    Console.WriteLine($"Request exception: {e.Message}");
                }
            }
        }
    }
}