RoZod

RoZod is a TypeScript package designed to simplify fetching data from the Roblox API. It provides a set of utility functions that automatically validate request and response data using the Zod validation library.

Features

• Type-safe API requests and responses
• Automatic validation of request and response data
• Helper functions for paginated requests and splitting requests

Installation

To install the package, run the following command:

npm install rozod

Usage

First, import the necessary functions and an example endpoint from the RoZod package:

import { fetchApi, fetchApiSplit, fetchApiPages, fetchApiPagesGenerator } from 'rozod';
import { getV1tradesTradeStatusType } from 'rozod/lib/endpoints/tradesv1';

Simple API Request

To make a simple API request, use the fetchApi function, and any endpoint from our exports:

const response = await fetchApi(getV1tradesTradeStatusType, { tradeStatusType: 1 });
console.log(response);

Split API Request

To split a request into multiple requests based on specified parameters, use the fetchApiSplit function:

const data = await fetchApiSplit(getV1gamesicons, { universeIds: [1534453623, 65241, ...] }, { universeIds: 100 });
console.log(data);

Fetching All Pages

To fetch all pages of a paginated endpoint, use the fetchApiPages function:

const allPages = await fetchApiPages(getV2groupsGroupIdgames, { groupId: 11479637 });
console.log(allPages);

Fetching Pages with a Generator

To fetch pages one at a time using an async generator, use the fetchApiPagesGenerator function:

const allPages = await fetchApiPages(getV2groupsGroupIdgames, { groupId: 11479637 });
console.log(allPages);

Custom Endpoints To create a custom endpoint, define an EndpointSchema object and export it. Here's an example of an endpoint from tradesv1.ts:

import { z } from 'zod';

export const getV1tradesTradeStatusType = {
  method: 'get' as const,
  path: '/v1/trades/:tradeStatusType',
  baseUrl: 'https://trades.roblox.com',
  requestFormat: 'json' as const,
  parameters: {
    tradeStatusType: z.union([z.literal(1), z.literal(2), z.literal(3), z.literal(4)]),
    limit: z
      .union([z.literal(10), z.literal(25), z.literal(50), z.literal(100)])
      .optional()
      .default(10),
    cursor: z.string().optional(),
    sortOrder: z.enum(['Asc', 'Desc']).optional().default('Asc'),
  },
  response: ...,
  errors: [
    {
      status: 400,
      description: `1: Invalid trade status type.`,
      schema: z.void(),
    },
    {
      status: 401,
      description: `0: Authorization has been denied for this request.`,
      schema: z.void(),
    },
  ],
};

Replace the response with your own Zod schema to validate the response data.

Support

If you encounter any issues or have questions, feel free to open an issue on the GitHub repository. We'll do our best to assist you.

Disclaimer

RoZod is not affiliated with, maintained, authorized, endorsed, or sponsored by Roblox Corporation or any of its affiliates.