Endpoint Overview

📖 Table of Contents

note

The API is currently configured to support only GET requests and responses from the API are only in json format.

The current rate limit is set to 20 requests per hour.

• 📖 Table of Contents
  • 📄 General Endpoints
  • 🦖 Dinosaur Endpoints
  • 📷 Image Endpoints
  • OpenAPI Specification

📄 General Endpoints

• Get main API endpoint: Returns the home endpoint of the API.
• Get all dinosaur clades: Returns all dinosaur clades that exist within the API.
• Get all dinosaur diets: Returns all dinosaur diets that exist within the API.
• Get all dinosaur locomotions: Returns all dinosaur locomotions that exist within the API.
• Get all dinosaur names: Returns all dinosaur names that exist within the API.

🦖 Dinosaur Endpoints

• Get all dinosaurs: Returns all dinosaurs within the API, 50 dinosaurs per page.
• Get a dinosaur by ID: Returns a dinosaur matching a specific id, returns an error if not found.
• Get a dinosaur by name: Returns a dinosaur matching a specific name, returns an error if not found.
• Get dinosaurs by diet: Returns all dinosaurs matching a specific diet.
• Get dinosaurs by locomotion: Returns all dinosaurs matching a specific locomotion type.
• Get random dinosaurs: Returns a random number of dinosaurs. Minimum of 1 and maximum of 10.
• Get dinosaurs by query: Returns all dinosaurs matching a specific query.

📷 Image Endpoints

• Get all dinosaur images: Returns all dinosaur images within the API, 50 dinosaurs per page.
• Get a image by ID: Returns a dinosaur image matching a specific id, returns an error if not found.
• Get random number of dinosaur images: Returns a random number of dinosaur images. Minimum of 1 and maximum of 10.

OpenAPI Specification

To view more details about all endpoints such as the expected responses and status codes, please take a look at the OpenAPI Spec.