the-office-api
the-office-api copied to clipboard
๐ค Simple JSON API for "The Office U.S." series.
The Office API
A free restful API serving quotes (and seasons information) from "The Office U.S." series.
Explore the api ยป
Contributing
ยท
Bug report
ยท
Feature request
API Contract ๐ซฑ๐ปโ๐ซฒ๐ผ
Base URL - https://officeapi.akashrajpurohit.com
Quotes
Get random Quote
Request Path - /quote/random
Response -
{
"id": 45,
"character": "Michael Scott",
"quote": "I am running away from my responsibilities. And it feels good.",
"character_avatar_url": "https://miro.medium.com/v2/resize:fit:500/1*xDIevNE7HEMiJQVTYg0qDQ.png"
}
Get Quote by ID
Request Path - /quote/:id
Response -
{
"id": 255,
"character": "Dwight Schrute",
"quote": "Jim is my enemy. But it turns out that Jim is also his own worst enemy. And the enemy of my enemy is my friend. So, Jim is actually my friend. But because he is his own worst enemy, the enemy of my friend is my enemy so, actually, Jim is my enemy.",
"character_avatar_url": "https://i.redd.it/hrieyrl117891.jpg"
}
[!NOTE]
Quotes API support both JSON and SVG responses. To get SVG responses, add aresponseType
query parameter tosvg
. For example,https://officeapi.akashrajpurohit.com/quote/255?responseType=svg
.Other supported query parameters are:
mode
-> can belight
ordark
width
-> the SVG card's width.
height
-> the SVG card's height.
Example of SVG can be seen below:
Get Season by ID
Request Path - /season/:id
Response -
[
{
"season": 1,
"episode": 1,
"title": "Pilot",
"description": "The premiere episode introduces the boss and staff of the Dunder-Mifflin Paper Company in Scranton, Pennsylvania in a documentary about the workplace.",
"airDate": "2005-03-24",
"imdbRating": 7.4,
"totalVotes": 7006,
"directedBy": "Ken Kwapis",
"writtenBy": "Ricky Gervais & Stephen Merchant and Greg Daniels"
},
{
"season": 1,
"episode": 2,
"title": "Diversity Day",
"description": "Michael's off color remark puts a sensitivity trainer in the office for a presentation, which prompts Michael to create his own.",
"airDate": "2005-03-29",
"imdbRating": 8.3,
"totalVotes": 6902,
"directedBy": "Ken Kwapis",
"writtenBy": "B. J. Novak"
},
{
"season": 1,
"episode": 3,
"title": "Health Care",
"description": "Michael leaves Dwight in charge of picking the new healthcare plan for the staff, with disastrous results ahead.",
"airDate": "2005-04-05",
"imdbRating": 7.7,
"totalVotes": 5756,
"directedBy": "Ken Whittingham",
"writtenBy": "Paul Lieberstein"
},
{
"season": 1,
"episode": 4,
"title": "The Alliance",
"description": "Just for a laugh, Jim agrees to an alliance with Dwight regarding the downsizing rumors.",
"airDate": "2005-04-12",
"imdbRating": 8,
"totalVotes": 5579,
"directedBy": "Bryan Gordon",
"writtenBy": "Michael Schur"
},
{
"season": 1,
"episode": 5,
"title": "Basketball",
"description": "Michael and his staff challenge the warehouse workers to a basketball game with a bet looming over both parties.",
"airDate": "2005-04-19",
"imdbRating": 8.4,
"totalVotes": 6183,
"directedBy": "Greg Daniels",
"writtenBy": "Greg Daniels"
},
{
"season": 1,
"episode": 6,
"title": "Hot Girl",
"description": "Michael is just one of the many male staff who start vying for the attention of an attractive saleswoman in the office.",
"airDate": "2005-04-26",
"imdbRating": 7.7,
"totalVotes": 5495,
"directedBy": "Amy Heckerling",
"writtenBy": "Mindy Kaling"
}
]
Get Episode by ID
Request Path - /season/:id/episode/:id
Response -
{
"season": 1,
"episode": 1,
"title": "Pilot",
"description": "The premiere episode introduces the boss and staff of the Dunder-Mifflin Paper Company in Scranton, Pennsylvania in a documentary about the workplace.",
"airDate": "2005-03-24",
"imdbRating": 7.4,
"totalVotes": 7006,
"directedBy": "Ken Kwapis",
"writtenBy": "Ricky Gervais & Stephen Merchant and Greg Daniels"
}
Technology Stack ๐ป
- Framework - Hono
- Deployment - Cloudflare Workers
Bugs or Requests ๐
If you encounter any problems feel free to open an issue. If you feel the project is missing a feature, please raise a ticket on GitHub and I'll look into it. Pull requests are also welcome.
Contributions ๐ค
Please check the guide to learn more about contributing to this project