https://github.com/jlgingrich/nytgames
An F# API for various NYT word games
https://github.com/jlgingrich/nytgames
api fsharp nytimes
Last synced: 10 months ago
JSON representation
An F# API for various NYT word games
- Host: GitHub
- URL: https://github.com/jlgingrich/nytgames
- Owner: jlgingrich
- Created: 2024-12-18T18:52:57.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-05-29T20:08:00.000Z (about 1 year ago)
- Last Synced: 2025-06-08T22:01:45.359Z (about 1 year ago)
- Topics: api, fsharp, nytimes
- Language: F#
- Homepage: https://www.nytimes.com/crosswords
- Size: 52.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# NYTGames
An F# API for various NYT word games. Comes with a script that generates a Markdown report with the current day's solutions.
## Example
[Sample.fsx](Sample.fsx)
```fsharp
#r @"NYTGames\bin\Debug\net9.0\NYTGames.dll"
open NYTGames
open System
let printGame (res: Result) =
let game = res |> Result.assertOk
printfn
"Wordle %s\nBy %s\nSolution: '%s'\n"
(game.Info.PrintDate.ToShortDateString())
(game.Info.EditedBy |> Option.get)
game.Solution
// Run on 12/31/2024
Game.Wordle.getCurrentGame () |> Async.RunSynchronously |> printGame
DateTime.Parse "12/30/2024"
|> Game.Wordle.getGame
|> Async.RunSynchronously
|> printGame
```
```text
Wordle 12/31/2024
By Tracy Bennett
Solution: 'lemur'
Wordle 12/30/2024
By Tracy Bennett
Solution: 'stare'
```
## How to use
Each supported game is represented as a module under `Game`.
All games provide these methods:
- `parse`: Transforms raw JSON into a strongly-typed F# object.
- `getCurrentRaw`: Gets a raw unparsed JSON string description of the current puzzle from NYT. Contains unneccessary data that are ignored when parsed.
- `getCurrentGame`: Gets a description of the puzzle for the current date, as determined by the New York Times website. All games provide this.
Only certain games provide these methods, depending on whether the API provides access to archived games:
- `getRaw`: Gets a raw unparsed JSON string description of the specified puzzle from NYT. Contains unneccessary data that are ignored when parsed.
- `getGame`: Gets a description of the puzzle on a specific date. Not all games currently provide this due to technical limitations.
## Supported Games
- **Connections**
- **Connections: Sports Edition**
- **Letter Boxed**
- Only current
- **Spelling Bee**
- Only current
- **Strands**
- **Sudoko**
- Only current
- **The Crossword**
- Only current
- **The Mini**
- Only current
- **Wordle**
## Unsupported Games
- **Tiles**
- Not word-based.
- Appears to generate puzzles on demand rather than fetch premade puzzles.
## Future plans
- Figure out how to access archived games for the following:
- Letter Boxed
- Spelling Bee
- The Crossword
- The Mini
- Sudoku (if it has them)