Featured Stories Details

GET 2 Credits / Request /ios/stories/details.json

Featured Stories Details allows you to fetch details about stories obtained by querying the Filtered Featured Stories endpoint.

Please note that the example has been stripped of redundant data to keep the documentation as concise as possible. The API might return additional, undocumented fields in the JSON, which your App should not rely upon.

Featured Stories Details

With the results from the Filtered Featured Stories endpoint, you will have a list of stories available for the given countries. For each country and language combination that you're interested in, you can provide a list of story ids to get the full details about them. If you don't pass a language, the language will be chosen for you depending on the country.

Header parameters
X-AppTweak-Key:
Your AppTweak API Key.
Query parameters
country: string Required

The two letter country code (ISO Alpha-2) you want to fetch the app in.

Get the list of our country codes, here.

story_ids: string Required

A list of comma separated story ids. These can be obtained by querying the Filtered Featured Stories endpoint

language: string

The two letter language (ISO Alpha-2) you want to fetch the stories in.

Get the list of our language codes, here.

GET /ios/stories/details.json

Request example
GET /ios/stories/details.json?country=be&story_ids=1450572364
cURL example
curl -X GET -H "X-Apptweak-Key: ${API_KEY}" https://api.apptweak.com/ios/stories/details.json?country=be&story_ids=1450572364

Featured Stories Details Response

The response to this endpoint contains detailed information about a story. For each id requested, we will give full information about the story. This includes how the story is supposed to be displayed on different devices, editorial text and images and other information. This data is formatted by Apple and we do minimal processing, which means the format can change from one story to the other.

Object properties
story_id: number

The ID that Apple has given to the story.

country: string

The country this story was shown at.

language: string

The language this story is in.

content: string

A hash that contains details about the story itself. This object comes directly from the App Store, so it might change and not look like the one shown here.

Response Example

{
  "content": {
    "1450572364": {
      "story_id": "1450572364",
      "country": "be",
      "language": "en",
      "content": {
        "canvas": [
          {
            "displayType": "TextBlock",
            "editorialCopy": "<b>With little more</b> than a torch to light their way, would-be heroes enter <i>The Greedy Cave 2: Time Gate</i> in search of shiny coins. But this particular dungeon crawler goes overboard with the treasure&mdash;it&rsquo;s exploding with sacks of gold, chests brimming with gear, and vases glowing with the promise of untold fortunes. <br><br>Of course, the potential to line your pockets with such riches comes with its share of risks. And therein lies the rub...and the game&rsquo;s wonderful hook."
          },
          {
            "displayType": "InlineImage",
            "artwork": {
              "width": 3524,
              "height": 1985,
              "url": "https://is1-ssl.mzstatic.com/image/thumb/Features114/v4/4d/49/98/4d499878-5690-2f0d-eb60-b8b15436e105/pr_source.png/{w}x{h}bb.{f}",
              "supportsLayeredImage": false,
              "hasP3": false,
              "hasAlpha": false
            },
            "editorialCopy": "Take down this ferocious beast for some awesome loot&mdash;or lose everything trying.",
            "inlineImageDisplayType": "BoundingBox"
          },
          {
            "displayType": "TextBlock",
            "editorialCopy": "<i>The Greedy Cave 2</i> is a roguelike: When you die, you&rsquo;re stripped of all possessions and progress. The one caveat is that you get to keep any gold-tier gear you&rsquo;ve collected, regardless of what unfortunate fate you might meet at the fangs and claws of the dungeon&rsquo;s monsters. <br><br>On the other hand, if you leave voluntarily with your life intact, you get to retain all collected currency and, more critically, the level progress you&rsquo;ve fought tooth and nail for. Triggering an Escape Scroll allows you to make a swift exit when your health meter&rsquo;s running dangerously low, but it sends you back to the beginning of the dungeon. This is where the game&rsquo;s brilliant risk-versus-reward dynamic really kicks in: Do you leave with what you have or stick around for a few seconds longer to scoop up more precious treasure? "
          },
          {
            "displayType": "InlineImage",
            "artwork": {
              "width": 3524,
              "height": 1985,
              "url": "https://is1-ssl.mzstatic.com/image/thumb/Features114/v4/9a/74/f4/9a74f476-fc2b-1f3b-6ba8-1c11a63728bc/pr_source.png/{w}x{h}bb.{f}",
              "supportsLayeredImage": false,
              "hasP3": false,
              "hasAlpha": false
            },
            "editorialCopy": "It might mean a little less loot for you, but multiplayer increases your odds of survival.",
            "inlineImageDisplayType": "BoundingBox"
          },
          {
            "displayType": "TextBlock",
            "editorialCopy": "With every cleared floor comes better loot, cooler monsters, and alchemy stations capable of transforming your favourite gear into gold. Role-playing mechanics add even more temptation as you push to level up your character, unlock cool gear and weapons, and score rare crafting material. And should you find it in your heart to share, you can join forces with friends to take on the cave as a team. <br><br>This dungeon-crawling romp is ready to reward you with glory and fortune...as long as you don&rsquo;t get too greedy. "
          },
          {
            "contentId": "1237463989",
            "displayType": "AppLockup",
            "appLockupSize": "Large",
            "appLockupVideo": "NoVideo"
          }
        ],
        "label": "GAME\nOF THE\nDAY",
        "id": "1450572364",
        "cardIds": [
          "1237463989"
        ],
        "relatedContent": {
          "1237463989": {
            "artwork": {
              "width": 1024,
              "url": "https://is2-ssl.mzstatic.com/image/thumb/Purple123/v4/32/70/49/32704938-bba3-3b92-6dbb-721fb626c95f/AppIcon-0-1x_U007emarketing-0-85-220-0-8.png/{w}x{h}bb.{f}",
              "height": 1024,
              "textColor3": "cbcbcb",
              "textColor2": "f16f0b",
              "textColor4": "c05909",
              "hasAlpha": false,
              "textColor1": "ffffff",
              "bgColor": "000000",
              "hasP3": false,
              "supportsLayeredImage": false
            },
            "artistName": "AvalonGames",
            "firstVersionSupportingInAppPurchaseApi": "1.4.0",
            "hasMessagesExtension": true,
            "url": "https://apps.apple.com/be/app/the-greedy-cave-2-time-gate/id1237463989",
            "shortUrl": "https://apps.apple.com/be/app/the-greedy-cave-2-time-gate/id1237463989",
            "videoPreviewsByType": {
              "ipadPro": [
                {
                  "previewFrame": {
                    "width": 1600,
                    "url": "https://is5-ssl.mzstatic.com/image/thumb/PurpleVideo118/v4/46/3f/43/463f4390-148e-cd44-e4bb-a0aa7950a0ac/Jobdbdee5c1-8c2e-4dbd-b618-8b53d2cd7897-101541067-PreviewImage_preview_image_nonvideo_sdr-Time1543038040954.png/{w}x{h}bb.{f}",
                    "height": 1200,
                    "textColor3": "c1772c",
                    "textColor2": "ec684b",
                    "textColor4": "bc533c",
                    "hasAlpha": false,
                    "textColor1": "f19537",
                    "bgColor": "000000",
                    "checksum": "c31070ea9ee07ce77197d7eb18276bd3",
                    "hasP3": false,
                    "supportsLayeredImage": false
                  },
                  "video": "https://apptrailers-ssl.itunes.apple.com/itunes-assets/PurpleVideo118/v4/f6/5e/f6/f65ef66c-4fec-68d7-d338-1ad754742218/P56489642_default.m3u8"
                }
              ],
              "iphone_6_5": [
                {
                  "previewFrame": {
                    "width": 1920,
                    "url": "https://is4-ssl.mzstatic.com/image/thumb/PurpleVideo128/v4/a5/e4/c0/a5e4c0c0-26da-71a0-9587-eddede116d71/Jobcd6fa332-a28f-43f2-9daf-b964d93ca13a-101656428-PreviewImage_preview_image_nonvideo_sdr-Time1544198230107.png/{w}x{h}bb.{f}",
                    "height": 886,
                    "textColor3": "c1943a",
                    "textColor2": "ed694d",
                    "textColor4": "be543e",
                    "hasAlpha": false,
                    "textColor1": "f1b948",
                    "bgColor": "000000",
                    "checksum": "92a3acf5ef725f9fb3539fe6a097c0cc",
                    "hasP3": false,
                    "supportsLayeredImage": false
                  },
                  "video": "https://apptrailers-ssl.itunes.apple.com/itunes-assets/PurpleVideo128/v4/e2/f1/83/e2f183ee-2fcb-6404-ba1b-f87a3d3c905c/P56708954_default.m3u8"
                }
              ]
            },
            "deviceFamilies": [
              "iphone",
              "ipad",
              "ipod"
            ],
            "genreNames": [
              "Games",
              "Adventure",
              "Entertainment",
              "Role-Playing"
            ],
            "nameSortValue": "TheGreedyCaveTimeGate",
            "id": "1237463989",
            "releaseDate": "2018-12-11",
            "userRating": {
              "value": 5,
              "ratingCount": 1,
              "ratingCountList": [
                0,
                0,
                0,
                0,
                1
              ],
              "ariaLabelForRatings": "5.0 stars"
            },
            "contentRatingsBySystem": {
              "appsApple": {
                "name": "9+",
                "value": 200,
                "rank": 2,
                "advisories": [
                  "Infrequent/Mild Horror/Fear Themes",
                  "Infrequent/Mild Profanity or Crude Humour",
                  "Infrequent/Mild Cartoon or Fantasy Violence"
                ]
              }
            },
            "name": "The Greedy Cave 2: Time Gate",
            "artistUrl": "https://apps.apple.com/be/developer/avalongames/id671601536",
            "screenshotsByType": {
              "iphone6+": [
                {
                  "width": 1242,
                  "url": "https://is4-ssl.mzstatic.com/image/thumb/Purple123/v4/4d/ec/df/4decdfe7-643d-99b3-4c82-af5368119e2f/pr_source.png/{w}x{h}bb.{f}",
                  "height": 2208,
                  "textColor3": "d0ced1",
                  "textColor2": "fff2f8",
                  "textColor4": "d0c6cc",
                  "hasAlpha": false,
                  "textColor1": "fffbff",
                  "bgColor": "151b1d",
                  "checksum": "c8aa0ae8dc9c18d92faa5c555d6ab010",
                  "hasP3": false,
                  "supportsLayeredImage": false
                },
                {
                  "width": 1242,
                  "url": "https://is1-ssl.mzstatic.com/image/thumb/Purple123/v4/57/21/8a/57218a9c-e0de-0cda-50a6-edd2a5f08b24/pr_source.png/{w}x{h}bb.{f}",
                  "height": 2208,
                  "textColor3": "cccad0",
                  "textColor2": "f6ece7",
                  "textColor4": "c8c0bd",
                  "hasAlpha": false,
                  "textColor1": "fcf9ff",
                  "bgColor": "101317",
                  "checksum": "cbd2ea3f7e787e7d8ed71edf8b7debe5",
                  "hasP3": false,
                  "supportsLayeredImage": false
                }
              ]
            },
            "ovalArtwork": {
              "width": 1024,
              "url": "https://is1-ssl.mzstatic.com/image/thumb/Purple123/v4/9b/0d/2c/9b0d2ce0-8c80-39f9-8431-198b7f4d41fa/iMessage_App_Icon-0-1x_U007emarketing-0-0-GLES2_U002c0-512MB-sRGB-0-0-0-85-181-0-0-0-0.png/{w}x{h}bb.{f}",
              "height": 768,
              "textColor3": "c3a88b",
              "textColor2": "35e8cc",
              "textColor4": "2abaa3",
              "hasAlpha": false,
              "textColor1": "f4d2ae",
              "bgColor": "000000",
              "hasP3": false,
              "supportsLayeredImage": false
            },
            "nameRaw": "The Greedy Cave 2: Time Gate",
            "editorialArtwork": {
              "subscriptionHero": {
                "width": 4320,
                "url": "https://is2-ssl.mzstatic.com/image/thumb/Features114/v4/be/1c/2a/be1c2a8f-3059-3936-e0e6-b629ffe84557/source/{w}x{h}{c}.{f}",
                "height": 1080,
                "textColor3": "c4c3b9",
                "textColor2": "d6d2d0",
                "textColor4": "aba8a6",
                "hasAlpha": false,
                "textColor1": "f5f4e7",
                "bgColor": "000000",
                "hasP3": false,
                "supportsLayeredImage": false
              }
            },
            "subtitle": "Multiplayer Roguelike Game",
            "bundleId": "com.avalon.caveonline.global",
            "hasInAppPurchases": true,
            "kind": "iosSoftware",
            "copyright": "© 2016-2018 Avalon Games",
            "chartPositionForStore": {
              "appStore": {
                "position": 11,
                "genreName": "Adventure",
                "chartUrl": "https://itunes.apple.com/WebObjects/MZStore.woa/wa/viewTop?cc=be&genreId=7002&popId=96"
              }
            },
            "artistId": "671601536",
            "genres": [
              {
                "genreId": "6014",
                "name": "Games",
                "url": "https://itunes.apple.com/be/genre/id6014",
                "mediaType": "8",
                "parentGenreId": "36"
              }
            ],
            "minimumOSVersion": "9.0",
            "messagesScreenshots": {
              "iphone6+": [
                {
                  "width": 1242,
                  "url": "https://is1-ssl.mzstatic.com/image/thumb/Purple123/v4/9d/15/72/9d157231-9295-e309-44eb-168384e93af2/mzl.kewznnxy.png/{w}x{h}bb.{f}",
                  "height": 2208,
                  "textColor3": "313131",
                  "textColor2": "35231d",
                  "textColor4": "5c4d49",
                  "hasAlpha": false,
                  "textColor1": "000000",
                  "bgColor": "f9f9f9",
                  "checksum": "3cc7b52b5233cebd53e70e63eb9d1e06",
                  "hasP3": false,
                  "supportsLayeredImage": false
                },
                {
                  "width": 1242,
                  "url": "https://is2-ssl.mzstatic.com/image/thumb/Purple123/v4/76/4b/13/764b13b7-4704-1605-fb6a-4ca14cccd660/mzl.apszdmnm.png/{w}x{h}bb.{f}",
                  "height": 2208,
                  "textColor3": "303030",
                  "textColor2": "341e1b",
                  "textColor4": "5a4947",
                  "hasAlpha": false,
                  "textColor1": "000000",
                  "bgColor": "f4f4f4",
                  "checksum": "ee8db58c8b051556597922cbc98af7d5",
                  "hasP3": false,
                  "supportsLayeredImage": false
                }
              ]
            },
            "requiredCapabilities": "opengles-1 accelerometer ",
            "offers": [
              {
                "actionText": {
                  "short": "GET",
                  "medium": "Get",
                  "long": "GET APP",
                  "downloaded": "Installed",
                  "downloading": "Installing"
                },
                "type": "get",
                "priceFormatted": "0,00 €",
                "price": 0,
                "buyParams": "productType=C&price=0&salableAdamId=1237463989&pricingParameters=STDQ&pg=default&appExtVrsId=831579072",
                "version": {
                  "display": "1.6.1",
                  "externalId": 831579072
                },
                "assets": [
                  {
                    "flavor": "iosSoftware",
                    "size": 379742208
                  }
                ]
              },
              {
                "actionText": {
                  "short": "Download",
                  "medium": "Download",
                  "long": "Download App",
                  "downloaded": "Installed",
                  "downloading": "Installing"
                },
                "type": "update",
                "priceFormatted": "0,00 €",
                "price": 0,
                "buyParams": "productType=C&price=0&salableAdamId=1237463989&pricingParameters=SWUPD&pg=default&appExtVrsId=831579072",
                "version": {
                  "display": "1.6.1",
                  "externalId": 831579072
                },
                "assets": [
                  {
                    "flavor": "iosSoftware",
                    "size": 379742208
                  }
                ]
              }
            ]
          }
        },
        "editorialArtwork": {
          "dayCard": {
            "width": 3524,
            "url": "https://is3-ssl.mzstatic.com/image/thumb/Features114/v4/1c/b9/a8/1cb9a8bb-ac7b-5244-2145-f6de3f3164f4/source/{w}x{h}{c}.{f}",
            "height": 2160,
            "textColor3": "08cd12",
            "textColor2": "fa5614",
            "textColor4": "c84612",
            "hasAlpha": false,
            "textColor1": "09ff14",
            "bgColor": "04070b",
            "hasP3": false,
            "supportsLayeredImage": false
          }
        },
        "kind": "editorialItem",
        "link": {
          "url": "https://apps.apple.com/be/story/id1450572364",
          "kindId": "59"
        },
        "displayStyle": "Branded",
        "editorialNotes": {
          "name": "The Greedy Cave 2: Time Gate",
          "short": "Go for the gold in this risky action romp.",
          "tagline": ""
        },
        "cardDisplayStyle": "GameOfTheDay",
        "displaySubStyle": "GameOfDay"
      },
      "metadata": {
        "storefront": {
          "id": "143446",
          "cc": "BE"
        },
        "language": {
          "tag": "en-gb"
        }
      },
      "app_ids": [
        "1237463989"
      ]
    }
  },
  "metadata": {
    "request": {
      "path": "/stories/details.json",
      "store": "ios",
      "params": {
        "country": "be",
        "story_ids": "1450572364,1458704318,1463233973",
        "format": "json"
      },
      "performed_at": "2019-07-31 13:06:20 UTC"
    },
    "content": {
    }
  }
}