https://github.com/pgdr/flockfish
Stockfish Flask API
https://github.com/pgdr/flockfish
Last synced: 10 months ago
JSON representation
Stockfish Flask API
- Host: GitHub
- URL: https://github.com/pgdr/flockfish
- Owner: pgdr
- License: agpl-3.0
- Created: 2018-09-30T17:56:23.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2018-10-02T07:49:31.000Z (over 7 years ago)
- Last Synced: 2025-03-27T21:18:31.504Z (about 1 year ago)
- Language: Python
- Size: 22.5 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# flockfish
A [Flask](https://github.com/pallets/flask) server that boots up
[Stockfish](https://github.com/official-stockfish/Stockfish) and returns best
moves.
For this project, you need to download and install `stockfish` and either have
it in `$PATH` or give the path to `stockfish` as an argument.
Four endpoints:
* `/` (which returns all of the below)
* `/bestmove`
* `/fen`
* `/board`
They all take arguments `?fen=&moves=`
## The gist of it: the `/` endpoint
Calling the main endpoint, the `/` endpoint with a list of moves,
`http://127.0.0.1:6464/?moves=e2e4 c7c5 c2c3 d7d5 e4d5 d8d5 d2d4 g8f6 b1a3 c5d4 a3b5 b8a6 d1d4 e7e5 d4d5`
yields
```json
{
"bestmove": "f6d5",
"board": ["+---+---+---+---+---+---+---+---+",
"| r | | b | | k | b | | r |",
"+---+---+---+---+---+---+---+---+",
"| p | p | | | | p | p | p |",
"+---+---+---+---+---+---+---+---+",
"| n | | | | | n | | |",
"+---+---+---+---+---+---+---+---+",
"| | N | | Q | p | | | |",
"+---+---+---+---+---+---+---+---+",
"| | | | | | | | |",
"+---+---+---+---+---+---+---+---+",
"| | | P | | | | | |",
"+---+---+---+---+---+---+---+---+",
"| P | P | | | | P | P | P |",
"+---+---+---+---+---+---+---+---+",
"| R | | B | | K | B | N | R |",
"+---+---+---+---+---+---+---+---+"],
"fen": "r1b1kb1r/pp3ppp/n4n2/1N1Qp3/8/2P5/PP3PPP/R1B1KBNR b KQkq - 0 8"
}
```
## Examples
examples:
* `bestmove?moves=e2e4 c7c5 c2c3 d7d5 e4d5 d8d5` -> `d2d4` (according to Deep Blue)
* `fen?moves=e2e4 c7c5 c2c3 d7d5 e4d5 d8d5` -> `"rnb1kbnr/pp2pppp/8/2pq4/8/2P5/PP1P1PPP/RNBQKBNR w KQkq - 0 4"`
* `board?fen=rnb1kbnr/pp2pppp/8/2pq4/8/2P5/PP1P1PPP/RNBQKBNR w KQkq - 0 4` ->
```
["+---+---+---+---+---+---+---+---+",
"| r | n | b | | k | b | n | r |",
"+---+---+---+---+---+---+---+---+",
"| p | p | | | p | p | p | p |",
"+---+---+---+---+---+---+---+---+",
"| | | | | | | | |",
"+---+---+---+---+---+---+---+---+",
"| | | p | q | | | | |",
"+---+---+---+---+---+---+---+---+",
"| | | | | | | | |",
"+---+---+---+---+---+---+---+---+",
"| | | P | | | | | |",
"+---+---+---+---+---+---+---+---+",
"| P | P | | P | | P | P | P |",
"+---+---+---+---+---+---+---+---+",
"| R | N | B | Q | K | B | N | R |",
"+---+---+---+---+---+---+---+---+"]
```
Starting the server, `python flock.py` and then visiting
`http://127.0.0.1:6464/bestmove/?fen=rnbqkbnr/pp1ppppp/8/2p5/4P3/5N2/PPPP1PPP/RNBQKB1R%20b%20KQkq%20-%201%202`
yields
a json string containing only `b8c6`.
The `board` endpoint returns the board:
`http://127.0.0.1:6464/board/?fen=rnbqkbnr/pp1ppppp/8/2p5/4P3/5N2/PPPP1PPP/RNBQKB1R%20b%20KQkq%20-%201%202`
yields a json list
```json
["+---+---+---+---+---+---+---+---+",
"| r | n | b | q | k | b | n | r |",
"+---+---+---+---+---+---+---+---+",
"| p | p | | p | p | p | p | p |",
"+---+---+---+---+---+---+---+---+",
"| | | | | | | | |",
"+---+---+---+---+---+---+---+---+",
"| | | p | | | | | |",
"+---+---+---+---+---+---+---+---+",
"| | | | | P | | | |",
"+---+---+---+---+---+---+---+---+",
"| | | | | | N | | |",
"+---+---+---+---+---+---+---+---+",
"| P | P | P | P | | P | P | P |",
"+---+---+---+---+---+---+---+---+",
"| R | N | B | Q | K | B | | R |",
"+---+---+---+---+---+---+---+---+"]
```
The `fen` endpoint
`http://127.0.0.1:6464/fen/?moves=e2e4%20c7c5%20c2c3%20d7d5%20e4d5%20d8d5`
yields
```json
"rnb1kbnr/pp2pppp/8/2pq4/8/2P5/PP1P1PPP/RNBQKBNR w KQkq - 0 4"
```