Civis R API Client

Overview

Civis has compiled an open-source R API client, which can be accessed through an R package. This allows you to interact with Platform via the API from scripts, notebooks, or your local R console. The full documentation for the Civis Platform API R Client is here.

Installation

In order to make requests to the Civis API, you will need an API key that is unique to you. For instructions on how to generate an API key, see this article. 

For instructions on how to access the Civis R client in your local environment, see this article.

Quick Start

To make sure Civis is installed and your API key is in your R environment. You can quickly test that Civis is working by following the steps described here. 

For a full reference of R client functions, see this page.