{"_id":"570f9c70986c040e008f7b5d","user":"56abbec30b9e0b0d00616274","parentDoc":null,"project":"56abbf55f25f160d00e17f4e","version":{"_id":"56abbf55f25f160d00e17f51","project":"56abbf55f25f160d00e17f4e","__v":12,"createdAt":"2016-01-29T19:36:53.665Z","releaseDate":"2016-01-29T19:36:53.665Z","categories":["56abbf56f25f160d00e17f52","56abca6bf9757e0d007c6650","56acddfa0ab3c00d00ce3332","56af65da9d32e30d0006d30f","56af66cab34d210d003d9ad0","56af6afcd21e9c0d00b628d1","56af6d6ecc4cbd0d00ce2c88","5705b12221cfed0e00e8c580","570a5676ade45d0e00c1ad33","570d7d25d1e4b82000d9e385","570eac3c3160d10e0041df0e","575709000fd6a3200010dded"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"__v":4,"category":{"_id":"56af6d6ecc4cbd0d00ce2c88","pages":["56af6e8460a37a0d00ed87ac","56af71e58be2ea0d00b48887","56af73a08be2ea0d00b48890"],"version":"56abbf55f25f160d00e17f51","__v":3,"project":"56abbf55f25f160d00e17f4e","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2016-02-01T14:36:30.275Z","from_sync":false,"order":2,"slug":"concepts","title":"Kongregate APIs & Concepts"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-04-14T13:34:40.437Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":8,"body":"### Kongpanions\n\nKongpanions are original characters that players on Kongregate can collect by earning \"badges of the day\" each week. A single badge of the day during a calendar week earns the regular Kongpanion, while earning 5 badges of the day within a week will upgrade it to the \"shiny\" version of the character. While these are fun items to show off on your profile, we've also put together a simple API that allows games to find out what Kongpanions a player has collected and incorporate them within the game.\n\n**Example: Shiny Kongbot and regular Puff Catty**\n\n![](http://cdn3.kongcdn.com/assets/kongpanion_icons/0000/0002/kongbot_shiny_2.png) ![](http://cdn2.kongcdn.com/assets/kongpanion_icons/0000/0003/cat.png)  \n\n### Overview\n\nDevelopers can integrate Kongpanions that users have earned into their games. You can see an example of this in [Curl Up and Fly](http://www.kongregate.com/games/Kongregate/curl-up-and-fly), in which the player can equip Kongpanions to improve stats and join them in flight.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/XlcoBYkVS5SQWsbNXkJx_curl.jpg\",\n        \"curl.jpg\",\n        \"250\",\n        \"200\",\n        \"#984939\",\n        \"\"\n      ],\n      \"caption\": \"Curl Up and Fly\",\n      \"border\": false,\n      \"sizing\": \"smart\"\n    }\n  ]\n}\n[/block]\nStructurally, a Kongpanion is very simple - it has a name and single image, with an alternate image for the shiny version. The value, strengths, and attributes of each Kongpanion are entirely open to you the developer to interpret. We also are tracking tags on Kongpanions, which will become more useful as a filtering method once the Kongpanion library grows. \n\nNote that at this time there is no guarantee that a player will have at least one Kongpanion. If you detect that a player has none, you should let them know and provide a link to [http://www.kongregate.com/kongpanions](http://www.kongregate.com/kongpanions) so they can go and earn one right away.\n\n### Accessing Kongpanions\n\nYou can use the following [HTTP APIs](doc:server-side-http) to obtain Kongpanion data. These endpoints can be accessed via AJAX, Flash, and Unity clients as well:\n\n* [Kongpanions](doc:server-api-kongpanions): Get a list of all Kongpanions\n* [Kongpanions - User](doc:server-api-user-kongpanions): Get a list of Kongpanions for a user","excerpt":"Integrate collectible Kongpanions into your game","slug":"api-kongpanions","type":"basic","title":"Kongpanions"}

Kongpanions

Integrate collectible Kongpanions into your game

### Kongpanions Kongpanions are original characters that players on Kongregate can collect by earning "badges of the day" each week. A single badge of the day during a calendar week earns the regular Kongpanion, while earning 5 badges of the day within a week will upgrade it to the "shiny" version of the character. While these are fun items to show off on your profile, we've also put together a simple API that allows games to find out what Kongpanions a player has collected and incorporate them within the game. **Example: Shiny Kongbot and regular Puff Catty** ![](http://cdn3.kongcdn.com/assets/kongpanion_icons/0000/0002/kongbot_shiny_2.png) ![](http://cdn2.kongcdn.com/assets/kongpanion_icons/0000/0003/cat.png) ### Overview Developers can integrate Kongpanions that users have earned into their games. You can see an example of this in [Curl Up and Fly](http://www.kongregate.com/games/Kongregate/curl-up-and-fly), in which the player can equip Kongpanions to improve stats and join them in flight. [block:image] { "images": [ { "image": [ "https://files.readme.io/XlcoBYkVS5SQWsbNXkJx_curl.jpg", "curl.jpg", "250", "200", "#984939", "" ], "caption": "Curl Up and Fly", "border": false, "sizing": "smart" } ] } [/block] Structurally, a Kongpanion is very simple - it has a name and single image, with an alternate image for the shiny version. The value, strengths, and attributes of each Kongpanion are entirely open to you the developer to interpret. We also are tracking tags on Kongpanions, which will become more useful as a filtering method once the Kongpanion library grows. Note that at this time there is no guarantee that a player will have at least one Kongpanion. If you detect that a player has none, you should let them know and provide a link to [http://www.kongregate.com/kongpanions](http://www.kongregate.com/kongpanions) so they can go and earn one right away. ### Accessing Kongpanions You can use the following [HTTP APIs](doc:server-side-http) to obtain Kongpanion data. These endpoints can be accessed via AJAX, Flash, and Unity clients as well: * [Kongpanions](doc:server-api-kongpanions): Get a list of all Kongpanions * [Kongpanions - User](doc:server-api-user-kongpanions): Get a list of Kongpanions for a user