Client Settings v2

Reference for the Client Settings v2 endpoints on Roblox.

Base URL: https://clientsettings.roblox.com

Endpoints

Method	Path	Name
GET	/v2/android-binaries/:version/channels/:channelName	getAndroidBinariesVersionChannelsChannelname
GET	/v2/client-version/:binaryType	getClientVersionBinarytype
GET	/v2/client-version/:binaryType/channel/:channelName	getClientVersionBinarytypeChannelChannelname
GET	/v2/compression-dictionaries	getCompressionDictionaries
GET	/v2/compression-dictionaries/:dictionarySha256	getCompressionDictionariesDictionarysha256
GET	/v2/ota-version/:binaryType	getOtaVersionBinarytype
GET	/v2/user-channel	getUserChannel

getAndroidBinariesVersionChannelsChannelname

GET /v2/android-binaries/:version/channels/:channelName

Retrieve the Android binary information for a given version and channel name.

Usage

import { fetchApi } from 'rozod';
import { getAndroidBinariesVersionChannelsChannelname } from 'rozod/endpoints/clientsettingsv2';

const data = await fetchApi(getAndroidBinariesVersionChannelsChannelname, {
  version: /* string */,
  channelName: /* string */
});

Parameters

Name	Type	Required	Description
version	string	Yes	The version string of the application. i.e. 2.660.392
channelName	string	Yes	The name of the channel. E.g. ZFlag, ZIntegration

Response

Field	Type	Description
moduleName	string
libraryNames	object	See below
supportsAndroidBinaries	boolean

libraryNames fields:

Field	Type	Description
engine	string

---

getClientVersionBinarytype

GET /v2/client-version/:binaryType

Get client version information for specific binary type

Usage

import { fetchApi } from 'rozod';
import { getClientVersionBinarytype } from 'rozod/endpoints/clientsettingsv2';

const data = await fetchApi(getClientVersionBinarytype, {
  binaryType: /* string */
});

Parameters

Name	Type	Required	Description
binaryType	string	Yes	Platform(WindowsPlayer, WindowsStudio, MacPlayer or MacStudio) for which we want the latest version

Response

Field	Type	Description
version	string
clientVersionUpload	string
bootstrapperVersion	string
nextClientVersionUpload	string
nextClientVersion	string
forceInstall	boolean

---

getClientVersionBinarytypeChannelChannelname

GET /v2/client-version/:binaryType/channel/:channelName

Get client version information for specific binary type

Usage

import { fetchApi } from 'rozod';
import { getClientVersionBinarytypeChannelChannelname } from 'rozod/endpoints/clientsettingsv2';

const data = await fetchApi(getClientVersionBinarytypeChannelChannelname, {
  binaryType: /* string */,
  channelName: /* string */
});

Parameters

Name	Type	Required	Description
binaryType	string	Yes	Platform(WindowsPlayer, WindowsStudio, MacPlayer or MacStudio) for which we want the latest version
channelName	string	Yes	Channel Name

Response

Field	Type	Description
version	string
clientVersionUpload	string
bootstrapperVersion	string
nextClientVersionUpload	string
nextClientVersion	string
forceInstall	boolean

Errors

Status	Description
401	5: Not authorized to perform this action.

---

getCompressionDictionaries

GET /v2/compression-dictionaries

Returns a listing of all known compression dictionaries, including their SHA256 and creation date.

Usage

import { fetchApi } from 'rozod';
import { getCompressionDictionaries } from 'rozod/endpoints/clientsettingsv2';

const data = await fetchApi(getCompressionDictionaries, undefined);

Response

Type: unknown

---

getCompressionDictionariesDictionarysha256

GET /v2/compression-dictionaries/:dictionarySha256

Returns the specified compression dictionary as a file download.

Usage

import { fetchApi } from 'rozod';
import { getCompressionDictionariesDictionarysha256 } from 'rozod/endpoints/clientsettingsv2';

const data = await fetchApi(getCompressionDictionariesDictionarysha256, {
  dictionarySha256: /* string */
});

Parameters

Name	Type	Required	Description
dictionarySha256	string	Yes	The SHA256 of the dictionary we wish to download.

Response

Type: unknown

---

getOtaVersionBinarytype

GET /v2/ota-version/:binaryType

Get OTA information for a specific binary type with a given version on some channel.

Usage

import { fetchApi } from 'rozod';
import { getOtaVersionBinarytype } from 'rozod/endpoints/clientsettingsv2';

const data = await fetchApi(getOtaVersionBinarytype, {
  binaryType: /* string */,
  channel: /* string? */,
  version: /* string? */,
  tag: /* string? */,
  name: /* string? */
});

Parameters

Name	Type	Required	Description
binaryType	string	Yes	Binary type of the application to get info for
channel	string?	No	Channel name. If not provided, production is assumed.
version	string?	No	Application version
tag	string?	No	Tag to filter results by. Only applicable to non-studio application types.
name	string?	No	Name to filter results by. Only applicable to non-studio application types.

Response

Array of objects:

Field	Type	Description
name	string
version	string
downloadUrl	string
isStandalone	boolean
assetId	string
assetVersion	string
maxAppVersion	string
tryoutName	string
localAssetURI	string
isForcedUpdate	boolean
appStorageResetId	string
isDevelopmentConfig	boolean
assetsManifest	string
versionV2	number

Errors

Status	Description
400	2: Invalid binaryType. 4: Invalid app version. 6: Missing or invalid channel. 7: Unsupported binaryType.
401	5: Not authorized to perform this action.
501	9: The requested tag is not implemented.

---

getUserChannel

GET /v2/user-channel

Get channel name for currently logged in user

Usage

import { fetchApi } from 'rozod';
import { getUserChannel } from 'rozod/endpoints/clientsettingsv2';

const data = await fetchApi(getUserChannel, {
  binaryType: /* string? */
});

Parameters

Name	Type	Required	Description
binaryType	string?	No

Response

Field	Type	Description
channelName	string
channelAssignmentType	`“None”	“PerMille”
token	string
program	object	See below
isFlagOnly	boolean

program fields:

Field	Type	Description
name	string
id	string

---