R/utils_post_generator.R

Defines functions .make_post_function

Documented in .make_post_function

#' Create a POST request function from an API spec
#'
#' Converts a single entry from \code{.api_POST_specs} into a function that sends
#' a POST request to the OKX API and returns the parsed response using the provided schema.
#'
#' @param api A list containing the POST API spec. Must include:
#'   \code{okx_path}, \code{schema}, and optional \code{mode}.
#'
#' @return A function with signature \code{(body_list, tz, config)} that:
#' \itemize{
#'   \item Converts the body list to JSON,
#'   \item Signs and sends the POST request,
#'   \item Parses and returns the response using the schema-aware parser.
#' }
#' @keywords internal
.make_post_function <- function(api) {
  parser <- .make_parser(api$parser_schema, mode = api$parser_mode %||% "named")

  function(body_list, tz, config, raw_data = getOption("okxr.raw_data", FALSE)) {
    res <- .execute_post_action(api$okx_path, body_list, config)
    if (is.null(res)) {
      return(NULL)
    }

    parsed_res <- parser(res = res, tz = tz)
    .okx_extract_result(parsed_res, raw_data = raw_data)
  }
}

#' @title POST request function list
#' @description A list of POST endpoint functions generated from \code{.api_POST_specs}.
#' Each function has the form \code{(body_list, tz, config)} and returns a parsed result.
#' @keywords internal
.posts <- lapply(.api_POST_specs, .make_post_function)

Try the okxr package in your browser

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

okxr documentation built on May 8, 2026, 5:09 p.m.