Interface to 'typeform' Results

An R interface to the 'typeform' <> application program interface. Also provides functions for downloading your results.

Typeform is a company that specialises in online form building. This R package allows users to download their form results through the exposed API.

The package can be installed from CRAN


or you can install the development version via devtools


The package can then be loaded in the usual way


To use this package, you will need a data API key. With this key in position, you can then list your available forms

api = "XXXXX"
typeforms = get_all_typeforms(api)

If you don't pass your api key as an argument, it will attempt to read the variable Sys.getenv("typeform_api").

You can download data from a particular typeform via

get_results(uid, api)

There are a number of options for downloading the data. For example

## Only completed forms
get_results(uid, api, completed=TRUE)
## Results since the 1st Jan
get_results(uid, api, since=as.Date("2016-01-01"))

See the ?get_results help page for other options.

Imagine we only want to fetch only the last 10 completed responses.

  • We only want completed results, so we add the parameter completed=TRUE.
  • The results need to be ordered by newest results first, so we add the parameter order_by="date_submit_desc"
  • We only want 10 results maximum, so we add the parameter limit=10

This gives the function call

get_results(uid, api, completed=TRUE, order_by="date_submit_desc", limit=10)
  • If you have any suggestions or find bugs, please use the github issue tracker.
  • Feel free to submit pull requests.


Version 0.2.0

  • Adding user agent to API call.
  • Better error handling.
  • Export get_api function.

Version 0.1.1

  • Minor tweaks for CRAN.

Version 0.1.0

  • Initial release.

Reference manual

It appears you don't have a PDF plugin for this browser. You can click here to download the reference manual.


0.3.2 by Colin Gillespie, 2 months ago

Report a bug at

Browse source code at

Authors: Colin Gillespie [aut, cre]

Documentation:   PDF Manual  

GPL-2 | GPL-3 license

Imports jsonlite, httr, purrr, utils, tibble

Suggests testthat, curl, dplyr

See at CRAN