Frequencies

Frequencies are where communities live in The Local Universe — they are a collection of likeminded individuals. On this page, we'll dive into the different frequency endpoints you can use to manage frequencies programmatically. We'll look at how to query, create, update, and delete frequencies.

Frequency Object

Represents a frequency within a station within The Local Universe.

Properties

Name
id
Type
string
Description
unique id of the frequency
Name
station_id
Type
string
Description
id of the station which the frequency is on
Name
nsfw
Type
boolean
Description
whether this frequency is nsfw

POST/v1/frequencies

Create Frequency

`ADMIN ONLY`

Create a frequency. Returns a frequency object. Requires FrequenciesWrite permission. Fires a FREQUENCY_CREATE Portal event.

Required attributes

Name
id
Type
string
Description
id of this frequency
Name
nsfw
Type
boolean
Description
whether this frequency is nsfw
Name
path
Type
string
Description
pathname of the url of this frequency

Request

POST

/v1/frequencies

curl -G https://api.localuniverse.io/v1/frequencies \
  -H "Authorization: Bearer {token}" \
  -d id="12345" \
  -d path="/watch?v=Kdky9Hm1" \
  -d nsfw=false

Response

{
  "id": "af3dfef97293d250",
  "station_id": "8e58de057e633fb9",
  "nsfw": false,
  "created_at": 692233200,
  "updated_at": 692233200
}

GET/v1/frequencies

Get Frequencies

`ADMIN ONLY`

Retrieves frequencies. Returns a list of frequency object. Requires FrequenciesRead permission.

Optional attributes

Name
page
Type
integer
Description
the page of frequencies to return
Name
limit
Type
integer
Description
number of frequencies to return
Name
open
Type
boolean
Description
whether to filter by currently open frequencies

Request

GET

/v1/frequencies

curl -G https://api.localuniverse.io/v1/frequencies \
  -H "Authorization: Bearer {token}"

Response

{
  [
    {
      "id": "1b0fec477b026620",
      "station_id": "8e58de057e633fb9",
      "nsfw": false,
      "created_at": 692233200,
      "updated_at": 692233200
    },
    {
      "id": "c5027b5717d97178",
      // ..
    }
  ]
}

GET/v1/frequencies/{frequency.id}

Get Frequency

`ADMIN ONLY`

Get a frequency by ID. Returns a frequency object. Requires FrequenciesRead permission.

Request

GET

/v1/frequencies/{frequency.id}

curl -G https://api.localuniverse.io/v1/frequencies/1b0fec477b026620 \
  -H "Authorization: Bearer {token}"

Response

{
  "id": "1b0fec477b026620",
  "station_id": "8e58de057e633fb9",
  "nsfw": false,
  "created_at": 692233200,
  "updated_at": 692233200
}