Skip to contents

Test connectivity and authentication to the API server.

Source: R/check_streetlight_api.R
check_streetlight_api.Rd

Test connectivity and authentication to the API server.

Usage

check_streetlight_api(key = NULL)

Arguments

key

character, StreetLight API key. Default is NULL.

Value

a PASS or FAIL message

Note

Take care of the rate limit on the API. For quick checks, a 1 second break (Sys.sleep(1)) is usually sufficient.