get_page_data {finnishgrid}

Returns one page of JSON data

Description

This private function helps with JSON API pagination by returning a single page of observations at once.

Usage

get_page_data(
  page_num,
  page_size,
  api_number,
  start_time_utc,
  end_time_utc,
  api_key
)

Arguments

page_num

Integer which page to retrieve from API.

page_size

Integer how many observations per page are collected.

api_number

Integer related to the Fingrid Open Data API

start_time_utc

Start time in UTC. Character array YYYY-MM-ddTHH:mm:ss.sssZ

end_time_utc

End time in UTC. Character array YYYY-MM-ddTHH:mm:ss.sssZ

api_key

Character array holding API-key. Free from https://data.fingrid.fi/en.

Value

A data frame object that contains a single page from API.