R/OpenMindat.R

Defines functions mindat_connection

Documented in mindat_connection

############ Initializing API Call ############
#library(httr)
#library(jsonlite)
#' Initializing Mindat API
#' @description Initializing API Call. Setup the base_url, token and format.
#' @usage mindat_connection(token, base_url = "https://api.mindat.org/v1",page_size = 800)
#' @param token  string. You can apply a token from Mindat.org.
#' @param base_url  string.The base url of mindat API, default is "https://api.mindat.org/v1".
#' @param page_size interger, setting the page size of responsed data from the API server.
#' @examples
#' mindat_connection("9ce67655d74bcd981e937be80dcea9cb",page_size = 1500)
#' @export
mindat_connection <- function(token, base_url = "https://api.mindat.org/v1",page_size = 800){
  set_api_token(token)
  mindat_setup(base_url,page_size = page_size)
}
############ Initializing API Call ############

Try the OpenMindat package in your browser

Any scripts or data that you put into this service are public.

OpenMindat documentation built on June 8, 2025, 1:47 p.m.