lemmy_get_federated_instances: Fetch federated instances.

View source: R/http-methods.R

lemmy_get_federated_instancesR Documentation

Fetch federated instances.

Description

HTTP.Get /federated_instances

Usage

lemmy_get_federated_instances(
  auth = NULL,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)

Arguments

auth

(Optional) A character value.

.lemmy_instance

Default: "https://lemmy.world". Change the default instance by setting the lemmy_instance options().

Value

A list of length 1:

<list>
`-federated_instances: <list>
  |-linked: <list>
  | `-[Each element]: <list>
  |   |-id: A numeric value
  |   |-domain: A character value
  |   |-published: A character value
  |   |-updated: (Optional) A character value
  |   |-software: (Optional) A character value
  |   `-version: (Optional) A character value
  |-allowed: <list>
  | `-[Each element]: <list>
  |   |-id: A numeric value
  |   |-domain: A character value
  |   |-published: A character value
  |   |-updated: (Optional) A character value
  |   |-software: (Optional) A character value
  |   `-version: (Optional) A character value
  `-blocked: <list>
    `-[Each element]: <list>
      |-id: A numeric value
      |-domain: A character value
      |-published: A character value
      |-updated: (Optional) A character value
      |-software: (Optional) A character value
      `-version: (Optional) A character value

Examples


instances <- lemmy_get_federated_instances()

length(instances$federated_instances$linked)

some_instance <- instances$federated_instances$linked[[732]]

some_instance$domain

some_instance$published


remmy documentation built on July 26, 2023, 5:37 p.m.