advent-of-code-api: Advent of Code REST API bindings

[ bsd3, library, web ] [ Propose Tags ]

Haskell bindings for Advent of Code REST API. Please use responsibly! See README.md or Advent module for an introduction and tutorial.

Requires libcurl.


[Skip to Readme]
Versions 0.1.0.0, 0.1.1.0, 0.1.2.0, 0.1.2.1, 0.1.2.2, 0.1.2.3 (info)
Change log CHANGELOG.md
Dependencies attoparsec, base (>=4.9 && <5), containers, curl, deepseq, directory, filepath, finite-typelits, mtl, tagsoup, text, time, uri-encode [details]
License BSD-3-Clause
Copyright (c) Justin Le 2018
Author Justin Le
Maintainer justin@jle.im
Category Web
Home page https://github.com/mstksg/advent-of-code-api#readme
Bug tracker https://github.com/mstksg/advent-of-code-api/issues
Source repo head: git clone https://github.com/mstksg/advent-of-code-api
Uploaded by jle at Sun Dec 9 01:10:48 UTC 2018
Distributions NixOS:0.1.0.0, Stackage:0.1.2.3
Downloads 127 total (127 in the last 30 days)
Rating (no votes yet) [estimated by rule of succession]
Your Rating
  • λ
  • λ
  • λ
Status Docs available [build log]
Last success reported on 2018-12-09 [all 1 reports]
Hackage Matrix CI

Modules

[Index] [Quick Jump]

Downloads

Maintainer's Corner

For package maintainers and hackage trustees


Readme for advent-of-code-api-0.1.2.3

[back to package description]

advent-of-code-api

advent-of-code-api on Hackage Build Status

Haskell bindings for Advent of Code REST API. Caches and throttles requests automatically.

Specify your requests with AoC and AoCOpts, and run them with runAoC.

Examples:

-- Fetch prompts for day 5
runAoC myOpts $ AoCPrompt (mkDay_ 5)

-- Fetch input for day 8
runAoC myOpts $ AoCInput (mkDay_ 8)

-- Submit answer "hello" for Day 10, Part 1
runAoC myOpts $ AoCSubmit (mkDay_ 10) Part1 "hello"

Please use responsibly. All actions are rate-limited to a default of one request every three seconds, with ability to adjust up to as fast as a hard-coded limit of one request per second.

Note that leaderboard API is not yet supported.

Requires libcurl, with future plans to move to a "pure Haskell" networking backend.

Session Keys

Session keys are required for all commands, but if you enter a bogus key you should be able to get at least Part 1 from AoCPrompt.

The session key can be found by logging in on a web client and checking the cookies. You can usually check these with in-browser developer tools.