Search: Web Stories API Reference

Search Web Stories that matches the search parameters specified in an API request.

Methods

search

Returns a list of Web Stories.

API Request

GET https://webstories.today/api/v1/search

Parameters

q	string, required The q parameter specifies the query term to search for.
apikey	string, required
category	string, optional Use the displayname_encoded from the StoryCategory Resource.
language	string, required, default: en The language parameter specifies in which language the category list should be returned.
maxresults	string, optional default: 10, max 50

Request body

Do not provide a request body when calling this method.

Response

The following table defines the properties that appear in this resource:

title	string Title of the web story
description	string The description of the web stories, max 280 chars long
language	string The language of the story, 2 letter language code.
url	string The full URL of the web story
channelinfo	ChannelInfo Information on the channel/creator who owns the web story.
category	StoryCategory Information on the category, the web story belongs too.

If successful, this method returns a response body with the following structure:

{
  "searchquery": "dogs",
  "searchcategory": "",
  "pagination": 1,
  "webstories": [
    {
      "title": "Amazing facts about dogs that are unbelievable.",
      "url": "fascinating-facts-about-dogs",
      "language": "en",
      "category": {
        "displayname": "Animals \u0026 Pets",
        "displayname_encoded": "pets"
      },
      "description": "Dogs are around us and are part of our family. They give unconditional love and companionship. Is there something far more than what we know about them?"
    },
    {
      "title": "Importance of dog toys and their role in development",
      "url": "importance-of-dog-toys",
      "language": "en",
      "category": {
        "displayname": "Animals \u0026 Pets",
        "displayname_encoded": "pets"
      },
      "description": "Dog toys play a crucial role in the proper growth of the dog."
    },
    {
      "title": "10 ways your dog says I LOVE YOU",
      "url": "10-ways-your-dog-says-i-love-you",
      "language": "en",
      "category": {
        "displayname": "Animals \u0026 Pets",
        "displayname_encoded": "pets"
      },
      "description": "Dogs are very communicative if you know how to read their expression. Here are 10 ways your dog is telling you he or she loves you"
    },
    {
      "title": "Why do dogs make the best emotional support companions?",
      "url": "why-do-dogs-make-the-best-emotional-support-companions",
      "language": "en",
      "category": {
        "displayname": "Animals \u0026 Pets",
        "displayname_encoded": "pets"
      },
      "description": "Companionship with dogs make us happy, healthier and more complete person."
    }
  ]
}