Getting API access
API data access is available as a paid add-on. Please contact your Customer Success Manager or email us at support@youscan.io. Our team will share pricing options and help you understand how API access can support your goals.
Once API access is enabled, you can generate an API Key by following the steps below.
👉 Please refer to our API Documentation: https://youscan.docs.apiary.io/ to learn what types of data are available through the API.
Create an API Key
Navigate to the YouScan account of the user who needs the API key.
Go to "My Settings."
Click "Create" in the API key section.
☝️ Remember to copy your key right away, since you cannot view it twice.
How to re-create an API key?
Go to "My Settings."
Click "Re-create" in the API key section.
Limit access to certain topics
The API key is attached to specific users. The API will only contain the topics accessible to that user within the YouScan interface.
You can check which users have an API key in the Account Settings under Users.
💡 We recommend setting up a test user to be flexible with your topic access.
‼️ Sources limitations
Data availability via API and external exports is limited for certain platforms due to their technical restrictions.
Reddit
Exports and API responses for Reddit mentions include only:
the mention URL;
YouScan proprietary metrics (sentiment, aspects, etc.).
The following data is no longer available in exports:
mention text and titles;
author information;
engagement statistics.
Twitter (X)
Access to Twitter mentions via API is limited. The following restrictions apply:
Mention Text, Full Text, and URLs are removed.
Author Name, URL, and Avatar are removed.
Profile ID and Post ID remain available.
💡 Combine the Profile ID and Post ID to navigate directly to the original Tweet.
Other sources
Quora: Data is not available through the API.
Small sources: Certain niche platforms may have restricted API access.
--
For any questions or issues relating to APIs or the API documentation, please contact our Support team via our dedicated email address: support@youscan.io