{"id":17033534,"url":"https://github.com/morgul/cardcast-api","last_synced_at":"2025-04-12T12:51:35.801Z","repository":{"id":23831938,"uuid":"27209106","full_name":"Morgul/cardcast-api","owner":"Morgul","description":"An unofficial library for working with the cardcastgame.com api.","archived":false,"fork":false,"pushed_at":"2015-03-29T02:03:14.000Z","size":228,"stargazers_count":12,"open_issues_count":4,"forks_count":2,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-03-26T07:36:24.439Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Morgul.png","metadata":{"files":{"readme":"Readme.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2014-11-27T04:33:53.000Z","updated_at":"2021-04-21T09:05:53.000Z","dependencies_parsed_at":"2022-08-22T00:00:46.789Z","dependency_job_id":null,"html_url":"https://github.com/Morgul/cardcast-api","commit_stats":null,"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Morgul%2Fcardcast-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Morgul%2Fcardcast-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Morgul%2Fcardcast-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Morgul%2Fcardcast-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Morgul","download_url":"https://codeload.github.com/Morgul/cardcast-api/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248571398,"owners_count":21126517,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-10-14T08:35:08.656Z","updated_at":"2025-04-12T12:51:35.750Z","avatar_url":"https://github.com/Morgul.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Unofficial Cardcast API\n\nThis is an unofficial API for searching/retrieving decks from [cardcastgame.com](cardcastgame.com).\n\n**Disclaimer**: This library is not associated with Cardcast, but they are aware of it's existence. If you use this\nlibrary, you should contact them to make sure they are okay with how you intend to use it.\n\n## Usage\n\nThis api is promise based, and is basically just a thing wrapper around rest calls. Start by creating an instance of\nthe api library:\n\n```javascript\nvar CardcastAPI = require('cardcast-api');\n\nvar api = new CardcastAPI();\n```\n\nEasy, right?\n\n### `api.search()`\n\n* `search` - Text to search by. (This is equivalent to what you put in the search box on the website.)\n* Returns a `PaginatedResult` object, containing a list of matching deck summaries.\n\nThis is just a simple wrapper around the search on the website. It's just useful enough to get play codes, if you have\nan idea of what the name of the deck is.\n\nIf you want to get a complete list, simply don't pass in anything for `search`.\n\n### `api.deck()`\n\n* `playCode` - The play code of the deck you're looking to retrieve.\n* Returns a `Deck` object.\n\nThis retrieves a deck and then populates the `Deck` object. This object is basically a convenience wrapper that also\nwraps all cards in `Card` objects, which should eventually support things like formatting.\n\n### Example\n\nIf you want to see a complete example, check out [/example/test.js](https://github.com/Morgul/cardcast-api/blob/master/example/test.js)\n\n## Status\n\nThe api is complete working, but as you can see I'm very light on documentation. I need to document the various objects\nthat get returned, and then focus on improving the `Card` object.\n\nPlease, keep in mind, this is a project that has had minimal effort. I'm more than willing to keep going with this, but\nit is not even remotely my primary focus. OTOH, the api is simple, and should be relatively robust and easy to maintain.\nFeel free to file bugs, or make improvements.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmorgul%2Fcardcast-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmorgul%2Fcardcast-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmorgul%2Fcardcast-api/lists"}