The factual-api package

[Tags: bsd3, library]

This is a driver for the Factual API. It provides a type-safe, easy way to generate queries, setup OAuth authentication and send queries to the API.

[Skip to ReadMe]


Versions0.1.0, 0.1.1, 0.1.2, 0.2.0, 0.3.0, 0.3.1, 0.3.2, 0.3.3, 0.4.0, 0.5.0, 0.5.1, 0.5.2, 0.6.0, 0.6.1
Change logNone available
Dependenciesaeson (>=, attoparsec (>=, base (==4.*), bytestring, containers, hoauth (>=0.3.0), HTTP, text (>=, unordered-containers (>=, vector (>=0.9.1) [details]
Copyright(c) 2012 Rudiger Lippert
AuthorRudiger Lippert <>
MaintainerRudiger Lippert <>
CategoryAPI, Web
Home page
Bug tracker
Source repositoryhead: git clone git://
UploadedWed Aug 8 18:50:38 UTC 2012 by RudigerLippert
Downloads2521 total (24 in last 30 days)
0 []
StatusDocs uploaded by user
Build status unknown [no reports yet]




Maintainers' corner

For package maintainers and hackage trustees

Readme for factual-api-0.5.0


This is a Haskell driver for Factual's public API.




This driver targets ghc 7.4.1 and The Haskell Platform 2012.2.0.0. Please follow the installation instructions for your specific platform to install ghc and The Haskell Platform.

Installation from cabal

$ cabal install factual-api

Installation from git

$ git clone
$ cabal install hoauth
$ cabal install aeson


Load the tests file into ghci to run the tests:

$ ghci test/Tests.hs

To run the integration tests you'll need an API key and secret, but you can always run the unit tests:

*Main> runUnitTests
Cases: 51  Tried: 51  Errors: 0  Failures: 0
Counts {cases = 51, tried = 51, errors = 0, failures = 0}
*Main> runIntegrationTests "mykey" "mysecret"
Cases: 10  Tried: 10  Errors: 0  Failures: 0
Counts {cases = 10, tried = 10, errors = 0, failures = 0}


You can read library documentation by opening docs/index.html in your browser or by visiting the Hackage page.

The github wiki also provides thorough documentation and examples for each feature.


See the examples directory for examples of each query type. To run an example go to the project root and execute these commands:

$ ghc -o example examples/ReadExample.hs --make
$ ./example mykey mysecret

In this example replace mykey with your key and mysecret with your secret. Note that compiling the source code generates .o and .hi files in the source directories.



Although there is code in the current version to support API writes, these features have not yet been implemented in the Factual API. Please refrain from attempting to use these features until they have been officially announced.

Crosswalk deprecation

The Crosswalk API endpoint has been migrated into a regular read table. For more information see the Factual V3 documentation.