- Base URL: The base url for this API is
http://127.0.0.1:5000/orlocalhost:5000/ - Authentication: This API does not require any authentication.
Erros will be returned as a JSON object, formatted like:
{
"success": False,
"error": 404,
"message": "Resource not found"
}
There are three types of errors that can be returned for this API, they are:
- 405: Method not Aloowed
- 400: Bad Request
- 404: Resource Not Found
- 422: Unprocessable
- General:
- Returns a categories object.
- Sample:
curl http://127.0.0.1:5000/categories
{
"categories": {
"1": "Science",
"2": "Art",
"3": "Geography",
"4": "History",
"5": "Entertainment",
"6": "Sports"
}
}
- General:
- Returns a list of question objects, a total number of questions and a categories object.
- Returns a maximum of 10 questions per page. Page numbers start at 1
- Sample:
curl http://127.0.0.1:5000/questions?page=2
{
"categories": {
"1": "Science",
"2": "Art",
"3": "Geography",
"4": "History",
"5": "Entertainment",
"6": "Sports"
},
"current_category": "Geography",
"questions": [
{
"answer": "Agra",
"category": "3",
"difficulty": 2,
"id": 15,
"question": "The Taj Mahal is located in which Indian city?"
},
{
"answer": "Escher",
"category": "2",
"difficulty": 1,
"id": 16,
"question": "Which Dutch graphic artist\u2013initials M C was a creator of optical illusions?"
},
{
"answer": "Mona Lisa",
"category": "2",
"difficulty": 3,
"id": 17,
"question": "La Giaconda is better known as what?"
},
{
"answer": "One",
"category": "2",
"difficulty": 4,
"id": 18,
"question": "How many paintings did Van Gogh sell in his lifetime?"
},
{
"answer": "Jackson Pollock",
"category": "2",
"difficulty": 2,
"id": 19,
"question": "Which American artist was a pioneer of Abstract Expressionism, and a leading exponent of action painting?"
},
{
"answer": "The Liver",
"category": "1",
"difficulty": 4,
"id": 20,
"question": "What is the heaviest organ in the human body?"
},
{
"answer": "Alexander Fleming",
"category": "1",
"difficulty": 3,
"id": 21,
"question": "Who discovered penicillin?"
},
{
"answer": "Blood",
"category": "1",
"difficulty": 4,
"id": 22,
"question": "Hematology is a branch of medicine involving the study of what?"
},
{
"answer": "Scarab",
"category": "4",
"difficulty": 4,
"id": 23,
"question": "Which dung beetle was worshipped by the ancient Egyptians?"
}
],
"total_questions": 19
}
- General:
- Deletes a question of given question_id.
- Returns a success statement and the id of the deleted question
curl -X DELETE http://127.0.0.1:5000/questions/27?page=2
{
"deleted": 16,
"success": true
}
- Creates a new question using submitted question, answer, category and difficulty.
- Returns a success statement, a list of question objects and the number of total questions.
curl "http://127.0.0.1:5000/questions" -X POST -H "Content-Type: application/json" -d "{\"question\":\"How many colours are there in the rainbow\", \"answer\":\"Seven\", \"category\":\"1\", \"difficulty\":\"1\"}"
{
"questions": [
{
"answer": "Apollo 13",
"category": "5",
"difficulty": 4,
"id": 2,
"question": "What movie earned Tom Hanks his third straight Oscar nomination, in 1996?"
},
{
"answer": "Tom Cruise",
"category": "5",
"difficulty": 4,
"id": 4,
"question": "What actor did author Anne Rice first denounce, then praise in the role of her beloved Lestat?"
},
{
"answer": "Maya Angelou",
"category": "4",
"difficulty": 2,
"id": 5,
"question": "Whose autobiography is entitled 'I Know Why the Caged Bird Sings'?"
},
{
"answer": "Edward Scissorhands",
"category": "5",
"difficulty": 3,
"id": 6,
"question": "What was the title of the 1990 fantasy directed by Tim Burton about a young man with multi-bladed appendages?"
},
{
"answer": "Muhammad Ali",
"category": "4",
"difficulty": 1,
"id": 9,
"question": "What boxer's original name is Cassius Clay?"
},
{
"answer": "Brazil",
"category": "6",
"difficulty": 3,
"id": 10,
"question": "Which is the only team to play in every soccer World Cup tournament?"
},
{
"answer": "Uruguay",
"category": "6",
"difficulty": 4,
"id": 11,
"question": "Which country won the first ever soccer World Cup in 1930?"
},
{
"answer": "George Washington Carver",
"category": "4",
"difficulty": 2,
"id": 12,
"question": "Who invented Peanut Butter?"
},
{
"answer": "Lake Victoria",
"category": "3",
"difficulty": 2,
"id": 13,
"question": "What is the largest lake in Africa?"
},
{
"answer": "The Palace of Versailles",
"category": "3",
"difficulty": 3,
"id": 14,
"question": "In which royal palace would you find the Hall of Mirrors?"
}
],
"success": true,
"total_questions": 20
}
- Searches for a question/questions that contains the search term entered.
- Returns a list of question objects containing questions that contain the search term and the number of total questions.
curl "http://127.0.0.1:5000/search" -X POST -H "Content-Type: application/json" -d "{\"searchTerm\":\"the\"}"
{
"questions": [
{
"answer": "Maya Angelou",
"category": "4",
"difficulty": 2,
"id": 5,
"question": "Whose autobiography is entitled 'I Know Why the Caged Bird Sings'?"
},
{
"answer": "Tom Cruise",
"category": "5",
"difficulty": 4,
"id": 4,
"question": "What actor did author Anne Rice first denounce, then praise in the role of her beloved Lestat?"
},
{
"answer": "Edward Scissorhands",
"category": "5",
"difficulty": 3,
"id": 6,
"question": "What was the title of the 1990 fantasy directed by Tim Burton about a young man with multi-bladed appendages?"
},
{
"answer": "Brazil",
"category": "6",
"difficulty": 3,
"id": 10,
"question": "Which is the only team to play in every soccer World Cup tournament?"
},
{
"answer": "Uruguay",
"category": "6",
"difficulty": 4,
"id": 11,
"question": "Which country won the first ever soccer World Cup in 1930?"
},
{
"answer": "Lake Victoria",
"category": "3",
"difficulty": 2,
"id": 13,
"question": "What is the largest lake in Africa?"
},
{
"answer": "The Palace of Versailles",
"category": "3",
"difficulty": 3,
"id": 14,
"question": "In which royal palace would you find the Hall of Mirrors?"
},
{
"answer": "Agra",
"category": "3",
"difficulty": 2,
"id": 15,
"question": "The Taj Mahal is located in which Indian city?"
},
{
"answer": "The Liver",
"category": "1",
"difficulty": 4,
"id": 20,
"question": "What is the heaviest organ in the human body?"
},
{
"answer": "Blood",
"category": "1",
"difficulty": 4,
"id": 22,
"question": "Hematology is a branch of medicine involving the study of what?"
}
],
"total_questions": 10
}
- Filters questions based on the category they belong to.
- Returns a list of question objects that belong to given category id, a total number of questions and the name of the category belonging to the category id.
curl http://127.0.0.1:5000/categories/2/questions
{
"current_category": "Art",
"questions": [
{
"answer": "Escher",
"category": "2",
"difficulty": 1,
"id": 16,
"question": "Which Dutch graphic artist\u2013initials M C was a creator of optical illusions?"
},
{
"answer": "Mona Lisa",
"category": "2",
"difficulty": 3,
"id": 17,
"question": "La Giaconda is better known as what?"
},
{
"answer": "One",
"category": "2",
"difficulty": 4,
"id": 18,
"question": "How many paintings did Van Gogh sell in his lifetime?"
},
{
"answer": "Jackson Pollock",
"category": "2",
"difficulty": 2,
"id": 19,
"question": "Which American artist was a pioneer of Abstract Expressionism, and a leading exponent of action painting?"
}
],
"total_questions": 4
}
- Gives a question based on the category chosen.
- Returns a question that belongs to the category chosen, an array containing the id's of questions that have already been asked, the category which the questions belong to.
curl "http://127.0.0.1:5000/quizzes" -X POST -H "Content-Type: application/json" -d "{\"quiz_category\":\"4\", \"previous_questions\":[23]}"
{
"previous_questions": [
23
],
"question": {
"answer": "George Washington Carver",
"category": "4",
"difficulty": 2,
"id": 12,
"question": "Who invented Peanut Butter?"
},
"quiz_category": "4"
}