Use the **Social Follow API** to link your audience to your many profiles

Reliable, customizable, and fast to help you grow your brand.

## Grow Your Followers [Anchor](/content/api/follow#grow-your-followers/index.html)

Grow your social influence and brand following faster by linking to and encouraging your visitors to follow and connect with your brand across all of your social media channels such as Instagram, YouTube, WhatsApp, Facebook, Pinterest, etc. The Social Follow API is free to use with [premium upgrades available](/content/plans/index.html).

The **[Shareaholic JavaScript SDK](/content/website-tools/social-follow-buttons/index.html)** incorporates this API and has many other very useful bells and whistles, including the ability to customize the buttons to match the look and feel of your site or application. It typically takes less than 10 minutes and 2 lines of code to install. We highly recommend using the SDK to save time. It is the preferred implementation for Social Follow Buttons.

## API Designed for Ease [Anchor](/content/api/follow#api-designed-for-ease/index.html)

We have optimized for ease of implementation. All API methods are accessible via simple HTTP calls. Most implementations of this API take less than 15 minutes to setup. Simply call the provided URLs with their respective parameters, and you're done.

## Getting Started: Authentication [Anchor](/content/api/follow#getting-started-authentication/index.html)

All API endpoints require API authentication credentials to be supplied as query arguments (`apikey`). To get started, you'll need a free [Shareaholic account](/content/signup/index.html) and Site ID. Signup for an account and then [add your site](/content/sites/index.html) to get your Site ID. The Site ID is your API Key for the Social Follow API.

Example:

```html
...&apikey=8943b7fd64cd8b1770ff5affa9a9437b&...
```

Note: the apikey used in this document is intended for use as an example only. It is subject to change.

## Parameters [Anchor](/content/api/follow#parameters/index.html)

Endpoint:`https://www.shareaholic.com/v2/follow/`

| Parameter | Description | Required | Example |
| --- | --- | --- | --- |
| `apikey` | API Key | Required | apikey=8943b7fd64cd8b1770ff5affa9a9437b |
| `service_nickname` | Destination | Required | service_nickname=x |
| `username` | Username for Destination |  | username=beyonce |
| `app_id` | Reference to Follow Button ID saved in your [Shareaholic Admin Console](/content/sites/index.html) |  | app_id=123 |
| `app_id_name` | Reference to Follow Button Name saved in your [Shareaholic Admin Console](/content/sites/index.html) |  | app_id_name=contact_page_placement |

One of either `username`, `app_id` or `app_id_name` is required.

Working Example:

```html
https://www.shareaholic.com/v2/follow/?service_nickname=x&username=beyonce&apikey=8943b7fd64cd8b1770ff5affa9a9437b
```

Give it a try:
[🥂  Follow Beyonce on X](/content/v2/follow/?service_nickname=x&username=beyonce&apikey=8943b7fd64cd8b1770ff5affa9a9437b/index.html)

## Cloud Settings (app_id & app_id_name) [Anchor](/content/api/follow#cloud-settings-app_id-app_id_name/index.html)

If you prefer not to include the service `username` in the request, you may store them in your [Shareaholic Admin Console](/content/sites/index.html) and specify a corresponding `app_id` or `app_id_name` in your request. The API will automatically lookup the saved username from the cloud settings linked to the API Key for the specified `app_id` or `app_id_name`.

You can create App ID's in the Follow Buttons section of the [Shareaholic Admin Console](/content/sites/index.html) under Apps and can lookup the `app_id` value by clicking "code". App ID value (ex. 12345) is displayed as `data-app-id=12345`. `app_id_name` is the name of an In-Page Follow Button instance, with spaces replaced with underscores. For instance: `follow_buttons_after_post`. Keep in mind that if you change your Follow Buttons instance name, this value will change too!

## JSON Response for JavaScript and AJAX [Anchor](/content/api/follow#json-response-for-javascript-and-ajax/index.html)

To get a JSON response, simply add the `.js` extension to the request path. For example:

```html
https://www.shareaholic.com/v2/follow.js?service_nickname=x&username=beyonce&apikey=8943b7fd64cd8b1770ff5affa9a9437b
```

Example success response:

```json

{
 "data":{

"id":"6552803",

"type":"follow-request",

"attributes":{

"link":"https://x.com/intent/follow?screen_name=beyonce"
    }
 },

"meta":{

"copyright":"Copyright Shareaholic Inc.",

"version":"3"
 }

}
```

## Error codes [Anchor](/content/api/follow#error-codes/index.html)

| Code | Description |
| --- | --- |
| 100 | `apikey` not provided |
| 101 | `apikey` provided is invalid |
| 110 | `service_nickname` not provided |
| 111 | `service_nickname` provided is invalid |
| 120 | `username` or `app_id` or `app_id_name` is missing or invalid value provided |

Example error response:

```json

{
 "errors":[\
\
    {\
\
       "code":"120",\
\
       "source":{\
\
          "pointer":"/data/attributes/username"\
\
       },\
\
       "detail":"Missing or invalid username, app_id or app_id_name. See https://www.shareaholic.com/api/follow/ for usage examples."\
\
    }\
\
 ]
}
```

## Destination Services [Anchor](/content/api/follow#services/index.html)

| Service | Service Nickname | Icon |
| --- | --- | --- |
| [500px](/content/website-tools/social-follow-buttons/five-hundred-px/index.html) | `five_hundred_px` |  |
| [about.me](/content/website-tools/social-follow-buttons/about-me/index.html) | `about_me` |  |
| [Behance](/content/website-tools/social-follow-buttons/behance/index.html) | `behance` |  |
| [Better Business Bureau](/content/website-tools/social-follow-buttons/bbb/index.html) | `bbb` |  |
| [Bloglovin](/content/website-tools/social-follow-buttons/bloglovin/index.html) | `bloglovin` |  |
| [Bluesky](/content/website-tools/social-follow-buttons/bluesky/index.html) | `bluesky` |  |
| [Discord](/content/website-tools/social-follow-buttons/discord/index.html) | `discord` |  |
| [Disqus](/content/website-tools/social-follow-buttons/disqus/index.html) | `disqus` |  |
| [Dribbble](/content/website-tools/social-follow-buttons/dribbble/index.html) | `dribbble` |  |
| [eBay](/content/website-tools/social-follow-buttons/ebay/index.html) | `ebay` |  |
| [Email This](/content/website-tools/social-follow-buttons/email-this/index.html) | `email_this` |  |
| [Etsy](/content/website-tools/social-follow-buttons/etsy/index.html) | `etsy` |  |
| [Facebook](/content/website-tools/social-follow-buttons/facebook/index.html) | `facebook` |  |
| [Feedly](/content/website-tools/social-follow-buttons/feedly/index.html) | `feedly` |  |
| [Flickr](/content/website-tools/social-follow-buttons/flickr/index.html) | `flickr` |  |
| [Foursquare](/content/website-tools/social-follow-buttons/foursquare/index.html) | `foursquare` |  |
| [Gab](/content/website-tools/social-follow-buttons/gab/index.html) | `gab` |  |
| [GETTR](/content/website-tools/social-follow-buttons/gettr/index.html) | `gettr` |  |
| [Github](/content/website-tools/social-follow-buttons/github/index.html) | `github` |  |
| [Google Classroom](/content/website-tools/social-follow-buttons/google-classroom/index.html) | `google_classroom` |  |
| [Houzz](/content/website-tools/social-follow-buttons/houzz/index.html) | `houzz` |  |
| [Instagram](/content/website-tools/social-follow-buttons/instagram/index.html) | `instagram` |  |
| [iTunes](/content/website-tools/social-follow-buttons/itunes-podcast/index.html) | `itunes_podcast` |  |
| [Kakao](/content/website-tools/social-follow-buttons/kakao/index.html) | `kakao` |  |
| [LinkedIn](/content/website-tools/social-follow-buttons/linkedin/index.html) | `linkedin` |  |
| [LinkedIn Company](/content/website-tools/social-follow-buttons/linkedin-company/index.html) | `linkedin_company` |  |
| [LiveJournal](/content/website-tools/social-follow-buttons/livejournal/index.html) | `livejournal` |  |
| [Medium](/content/website-tools/social-follow-buttons/medium/index.html) | `medium` |  |
| [Meetup](/content/website-tools/social-follow-buttons/meetup/index.html) | `meetup` |  |
| [MeWe](/content/website-tools/social-follow-buttons/mewe/index.html) | `mewe` |  |
| [Micro.blog](/content/website-tools/social-follow-buttons/micro-blog/index.html) | `micro_blog` |  |
| [Mix](/content/website-tools/social-follow-buttons/mix/index.html) | `mix` |  |
| [Odnoklassniki](/content/website-tools/social-follow-buttons/odnoklassniki/index.html) | `odnoklassniki` |  |
| [Parler](/content/website-tools/social-follow-buttons/parler/index.html) | `parler` |  |
| [Patreon](/content/website-tools/social-follow-buttons/patreon/index.html) | `patreon` |  |
| [Pinterest](/content/website-tools/social-follow-buttons/pinterest/index.html) | `pinterest` |  |
| [Raindrop.io](/content/website-tools/social-follow-buttons/raindrop-io/index.html) | `raindrop_io` |  |
| [Rakuten (楽天ブログ)](/content/website-tools/social-follow-buttons/rakuten-blog/index.html) | `rakuten_blog` |  |
| [Reddit](/content/website-tools/social-follow-buttons/reddit/index.html) | `reddit` |  |
| [RSS](/content/website-tools/social-follow-buttons/rss/index.html) | `rss` |  |
| [Skype](/content/website-tools/social-follow-buttons/skype/index.html) | `skype` |  |
| [Slack](/content/website-tools/social-follow-buttons/slack/index.html) | `slack` |  |
| [SlideShare](/content/website-tools/social-follow-buttons/slideshare/index.html) | `slideshare` |  |
| [Snapchat](/content/website-tools/social-follow-buttons/snapchat/index.html) | `snapchat` |  |
| [SoundCloud](/content/website-tools/social-follow-buttons/soundcloud/index.html) | `soundcloud` |  |
| [Spotify](/content/website-tools/social-follow-buttons/spotify/index.html) | `spotify` |  |
| [Stack Overflow](/content/website-tools/social-follow-buttons/stackoverflow/index.html) | `stackoverflow` |  |
| [Steam](/content/website-tools/social-follow-buttons/steam/index.html) | `steam` |  |
| [Stocktwits](/content/website-tools/social-follow-buttons/stocktwits/index.html) | `stocktwits` |  |
| [Strava](/content/website-tools/social-follow-buttons/strava/index.html) | `strava` |  |
| [Telegram](/content/website-tools/social-follow-buttons/telegram/index.html) | `telegram` |  |
| [Threads](/content/website-tools/social-follow-buttons/threads/index.html) | `threads` |  |
| [TikTok](/content/website-tools/social-follow-buttons/tiktok/index.html) | `tiktok` |  |
| [Trello](/content/website-tools/social-follow-buttons/trello/index.html) | `trello` |  |
| [Tripadvisor](/content/website-tools/social-follow-buttons/tripadvisor/index.html) | `tripadvisor` |  |
| [Truth Social](/content/website-tools/social-follow-buttons/truthsocial/index.html) | `truthsocial` |  |
| [Tumblr](/content/website-tools/social-follow-buttons/tumblr/index.html) | `tumblr` |  |
| [Twitch](/content/website-tools/social-follow-buttons/twitch/index.html) | `twitch` |  |
| [Vimeo](/content/website-tools/social-follow-buttons/vimeo/index.html) | `vimeo` |  |
| [VK](/content/website-tools/social-follow-buttons/vk/index.html) | `vk` |  |
| [WeChat](/content/website-tools/social-follow-buttons/wechat/index.html) | `wechat` |  |
| [WhatsApp](/content/website-tools/social-follow-buttons/whatsapp/index.html) | `whatsapp` |  |
| [X (Twitter)](/content/website-tools/social-follow-buttons/twitter/index.html) | `twitter` |  |
| [Yelp](/content/website-tools/social-follow-buttons/yelp/index.html) | `yelp` |  |
| [YouTube](/content/website-tools/social-follow-buttons/youtube/index.html) | `youtube` |  |
| [Zillow](/content/website-tools/social-follow-buttons/zillow-digs/index.html) | `zillow_digs` |  |

## Feedback [Anchor](/content/api/follow#feedback/index.html)

If you believe you have found a bug, or you’d like to request additional functionality, or you release something using this API, we’d love to [hear from you](/content/contact/index.html).

Build with Shareaholic

Developer Tools and APIs that are reliable, stable, and fast. Built and run on the same scaled cloud infrastructure that runs Shareaholic products and powers functionality across over 300,000+ sites. Over 10 rock solid years in production.
