Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/khalby786/getxkcd
xkcd api with cors
https://github.com/khalby786/getxkcd
api cors go golang xkcd xkcd-api xkcd-comics xkcd-scraper
Last synced: about 1 month ago
JSON representation
xkcd api with cors
- Host: GitHub
- URL: https://github.com/khalby786/getxkcd
- Owner: khalby786
- Created: 2020-09-11T03:16:28.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-02-19T15:55:32.000Z (11 months ago)
- Last Synced: 2024-04-28T05:23:24.463Z (9 months ago)
- Topics: api, cors, go, golang, xkcd, xkcd-api, xkcd-comics, xkcd-scraper
- Language: Go
- Homepage: https://getxkcd.now.sh
- Size: 27.3 KB
- Stars: 7
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# getxkcd
[](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fkhalby786%2Fgetxkcd)
### get the latest comic
https://getxkcd.now.sh/latest
https://getxkcd.now.sh/0
#### example response
```json
{
"month": "1",
"num": 2886,
"link": "",
"year": "2024",
"news": "",
"safe_title": "Fast Radio Bursts",
"transcript": "",
"alt": "Dr. Petroff has also shown that the Higgs boson signal was actually sparks from someone microwaving grapes, the EHT black hole photo was a frozen bagel someone left in too long, and the LIGO detection was just someone slamming the microwave door too hard.",
"img": "https://imgs.xkcd.com/comics/fast_radio_bursts.png",
"title": "Fast Radio Bursts",
"day": "26"
}
```
### get a comic by number
https://getxkcd.now.sh/1481
#### example response
```json
{
"month": "2",
"num": 1481,
"link": "",
"year": "2015",
"news": "",
"safe_title": "API",
"transcript": "((This is a faux-screenshot of a technical document))\n[[A figure sits at a computer upon a desk, apparently engrossed in the document which we now see before us.]]\nTITLE: API GUIDE\nRequest URL Format: domain\nuser\nitem\nServer will return an XML document which contains the requested data and documentation describing how the data is organized spatially.\nAPI KEYS: To obtain API access, contact the x.509-authenticated server and request an ECDH-RSA TLS key...\n\nCaption: If you do things right, it can take people a while to realize that your \"API documentation\" is just instructions for how to look at your website.\n\n{{Title text: ACCESS LIMITS: Clients may maintain connections to the server for no more than 86,400 seconds per day. If you need additional time, you may contact IERS to file a request for up to one additional second.}}",
"alt": "ACCESS LIMITS: Clients may maintain connections to the server for no more than 86,400 seconds per day. If you need additional time, you may contact IERS to file a request for up to one additional second.",
"img": "https://imgs.xkcd.com/comics/api.png",
"title": "API",
"day": "2"
}
```
## notes
- you can also get the latest comic by sending a request to https://getxkcd.now.sh/, but the request header should have `Accept` as `application/json`
```bash
curl -H "Accept: application/json" "https://getxkcd.now.sh/""
```
- the API is [backwards compatible](https://xkcd.com/1172/) with the previous versions which used https://getxkcd.now.sh/api/comic?num=latest to get the latest comic and https://getxkcd.now.sh/api/comic?num=1172 to get a particular comic
- if you get an HTML response from the API, you have to set your API client to handle redirects. alternatively, replace `.now.sh` domains with `.vercel.app` to avoid this pitfall in places like `curl`
- `vercel.json` handles all the routing, so make sure you copy it verbatim if you want good things to happen
- in an effort to learn and use a new programming language, i have used go which is unnecessarily complicating things but *✨ performance ✨*
## closing thoughts
made by [khaleel](https://khaleelgibran.com) when he was feeling lonely