Skip to main content

PuzzleMe API

Objective

Get an overview of PuzzleMe's API capabilities and what you can do with them.

PuzzleMe APIs make it possible for you to build your own experiences and integrate PuzzleMe with other applications. For example, you could provide users with personal stats such as streaks and easily design how you present your puzzles.

API Types​

PuzzleMe offers two types of APIs:

Puzzles API​

Access metadata for puzzles you publish using PuzzleMe. This would be useful if you want to design your own games landing page. (See The Atlantic's Crossword and Caleb's Inferno)

Available puzzle metadata fields:

  • Title

  • Author

  • Unique identifier (Used to embed the puzzle)

  • Type of puzzle

  • Width of grid*

  • Height of grid*

  • Number of words*

  • Publication time

  • Thumbnail URL

    *Only available for Crossword, Sudoku, Kriss-Kross, Codeword, and Word Search

Plays API (Beta)​

Useful if you want raw data to produce personal stats for your users such as streaks and badges.

1. Leaderboard​

Retrieves a list of top plays* for a specific puzzle, sorted by score and time.

Available fields:

  • User ID
  • Score
  • Completion time

*Defaults to top 10 plays, maximum 100 plays

2. Aggregate metrics​

Retrieves series or single puzzle metrics for a specified period of time.*

Available fields:

  • Total loads
  • Verified loads
  • Average video pre-roll ad duration, if applicable

*Customizable to a maximum period of 4 weeks

3. Play metrics​

Retrieves play data for a user in a series or a single puzzle.

Available fields:

  • User ID
  • Play state (Started, Completed, Completed correctly)
  • Puzzle ID
  • Series
  • Puzzle type
  • Time taken
  • Score
  • Start and end time

Getting Started​

To use these APIs, you will need authentication credentials client_id and client_secret. You can obtain these by contacting us.

Developers' Guide​

For detailed technical API documentation, including authentication methods, endpoints, and examples, visit our API Documentation.

Metering​

We are in the process of introducing usage-based metering for this API suite. While metering is not currently active, we encourage you to design your integration with this in mind. Once metering is enabled, you may be subject to usage limits and billing based on your API consumption.

Table of contents