Getting Started

This is a REST API and it is here for you to access and use the compilation of all known board game data that is available. There are many things you can do with the REST API. Here are some examples.

  • Create a mobile app that can access and use the data.
  • Make a website that can show and use all the board game data from the API.
  • You can download and analyze the information in your own way.
  • Nearly any application language can access and use the API.

See the API in action in our own implementation of a powerful board game search web app. The 5 Color Combo Board Game Search is the most powerful board game search tool.

The API is still in Beta.

This API is new and we're learning how to best serve the community with it. Keep in mind that the resources, parameters, and objects may change during the beta. If you have suggestions on improvements or features we'd love to hear your feedback! Send us an email at contact@5colorcombo.com and we'll get back to you. We're planning to launch the production version in Fall 2018. If you're interested in using this for a production application before our scheduled launch date, please inform us and we'll talk about the timeline of the project with you.

Endpoint Details

The API is available at https://www.5colorcombo.com/api

All requests return data in JSON format. Currently all API calls do not require authentication and can be made by any application.

Search Example

To show the simplicity and power of the API, here's an example of the Search resource. This is an example where the search is narrowed by the name and in descending order by average rating.

GEThttps://www.5colorcombo.com/api/search?name=Last%20Stand&order-by=average-rating&ascending=false

HTTP 200 OK
Content-Type: application/json; charset=utf-8
 
{ "games": [
   {
      "id": "SVQRjsXrhj",
      "name": "Last Stand",
      "year_published": 2018,
      "min_players": 2,
      "max_players": 4,
      "min_playtime": 10,
      "max_playtime": 30,
      "min_age": 8,
      "description": "Last Stand - The Board Game Where Your Power Grows As You Lose
          Do you have someone who keeps telling you they don't want to 
          play games because they keep losing. This is the game for them! As you get 
          attacked you get more cards to use to fight back! This game has
          Easy for families to play together, Politics, Quick to learn,
          Tension building to the very end, Players can participate through the entire 
          game, Great for new board gamers, With art by cartoonist Chris McCoy 
          this game stands up and shouts to be played with!
          2-4 Players | Game Length: 15-30 minutes | Ages: 8 and older",
      "thumb_url":"https://images-na.ssl-images-amazon.com/images/G/01/apparel/rcxgs/tile._CB211431200_.gif",
      "image_url":"https://images-na.ssl-images-amazon.com/images/G/01/apparel/rcxgs/tile._CB211431200_.gif",
      "url": "https://www.5colorcombo.com/search/game/SVQRjsXrhj"
   },
   {
      ...
   }]
}