{"id":20297377,"url":"https://github.com/ekelen/tarot-api","last_synced_at":"2025-04-05T18:09:46.241Z","repository":{"id":38711078,"uuid":"121244321","full_name":"ekelen/tarot-api","owner":"ekelen","description":"Simple REST API for the tarot cards of the Rider-Waite-Smith deck","archived":false,"fork":false,"pushed_at":"2023-12-21T00:27:09.000Z","size":100,"stargazers_count":313,"open_issues_count":4,"forks_count":105,"subscribers_count":7,"default_branch":"main","last_synced_at":"2025-03-29T17:11:12.366Z","etag":null,"topics":["get-request","rest-api","tarot-api","tarot-readings"],"latest_commit_sha":null,"homepage":"https://tarotapi.dev","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ekelen.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2018-02-12T12:31:08.000Z","updated_at":"2025-03-23T16:19:15.000Z","dependencies_parsed_at":"2023-12-21T01:56:46.605Z","dependency_job_id":"755af4a6-3faa-4793-9d31-c3744abfdec7","html_url":"https://github.com/ekelen/tarot-api","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ekelen%2Ftarot-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ekelen%2Ftarot-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ekelen%2Ftarot-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ekelen%2Ftarot-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ekelen","download_url":"https://codeload.github.com/ekelen/tarot-api/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247378149,"owners_count":20929297,"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":["get-request","rest-api","tarot-api","tarot-readings"],"created_at":"2024-11-14T15:47:26.270Z","updated_at":"2025-04-05T18:09:46.207Z","avatar_url":"https://github.com/ekelen.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Tarot Card API\n\n\u003e For all your cybermysticism needs. 🔮\n\nProvides information parsed from AE Waite's The Pictorial Key to the Tarot, meeting the OpenAPI 3 spec. This was created as a friendly introduction to REST APIs.\n\n---\n\n## API Usage\n\n1. [See full documentation + play with the API on SwaggerHub](https://app.swaggerhub.com/apis/ekswagger/tarot-api/1.3)\n\n2. See below for quick start\n\n### Quick start\n\nJS:\n\n```javascript\nfetch(\"https://tarotapi.dev/api/v1/cards/random?n=10\")\n  .then(function (response) {\n    return response.json();\n  })\n  .then(function (response) {\n    // handle ten random cards\n  })\n  .catch(function (error) {\n    // handle what went wrong\n  });\n```\n\n### Condensed documentation\n\n| GET path                      | Result                                  | Params                                                                                                          |\n| :---------------------------- | --------------------------------------- | :-------------------------------------------------------------------------------------------------------------- |\n| `/api/v1/` or `/api/v1/cards` | return all cards                        |                                                                                                                 |\n| `/api/v1/cards/:name_short`   | return card with specified `name_short` | **minors:** `/swac`, `/wa02`, ..., `/cupa`, `/pequ`, `/waqu`, `/swki`, **majors** `/ar01`, `/ar02`, ...`/ar[n]` |\n| `/api/v1/cards/search`        | search all cards                        | `q={text}`, `meaning={text}`, `meaning_rev={text}`                                                              |\n| `/api/v1/cards/random`        | get random card(s)                      | _optional_ `n={integer \u003c= 78}`                                                                                  |\n\n### Examples:\n\nGet all cards with word \"peace\" in meaning (reversed or upright):\n\nhttps://tarotapi.dev/api/v1/cards/search?meaning=peace\n\nGet 10 random cards:\n\nhttps://tarotapi.dev/api/v1/cards/random?n=10\n\nGet the Knight of Wands:\n\nhttps://tarotapi.dev/api/v1/cards/wakn\n\n---\n\n## 💻 Local development\n\n(Novice-friendly!)\n\n1. You are welcome to [just grab the JSON file](./static/card_data.json) that serves as the data source and use it for your own projects.\n\n2. Clone or fork this repository and install dependencies locally. Requires Node 10.0.0 or higher, and npm 6.0.0 or higher.\n\n```sh\ngit clone https://github.com/ekelen/tarot-api.git\n# or git@github.com:ekelen/tarot-api.git\n\n# -OR- click fork on this project's Github page, then:\n\ngit clone https://github.com/YOUR-USERNAME/tarot-api.git\n```\n\nThen:\n\n```sh\ncd tarot-api\n\nnpm install\n\nnpm run dev\n```\n\n---\n\n## External resources\nIf you are looking for images to complement your tarot app, the Rider Waite 1909 deck is public domain. You can find images of the cards here: https://www.sacred-texts.com/tarot/xr/index.htm\n\n---\n\n## 🗞 Updates\n\n### 2023/12/19\n\n- 'Tis the season for a nice domain name and a more reliable server. You can now use https://tarotapi.dev (and https://tarotapi.dev/api/v1 etc). The old `onrender` URL should still work (faster).\n\n### 2023/05/12\n\n- **Important** render.com stopped supporting my pretty URL (👎), so the project must be accessed at https://tarot-api-3hv5.onrender.com/.\n\n### 2023/12/30\n\n- **Important** Heroku stopped offering free dynos (👎), so you must replace all references to https://rws-cards-api.herokuapp.com to ~~tarot-api.onrender.com~~ https://tarot-api-3hv5.onrender.com (see May update) if you are using this API in your app.\n\n### 2022/06/18\n\n- Updated Swagger docs\n- Added a `courts` endpoint (no specific rank parameter required)\n- Bumped `nodemon`\n- `require` typo fix\n\n### 2021/01/25\n\n- Linted, finished, and published the Swagger documentation\n- Removed unused packages\n- Reorganized source files to remove extraneous files from build\n- Updated other documentation\n\n### 2020/10/17\n\n- Now supports CORS, so you can use this pretty much anywhere 🧙‍♂️\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fekelen%2Ftarot-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fekelen%2Ftarot-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fekelen%2Ftarot-api/lists"}