Helpers, Builders, And Constants

This page covers the package-root helper exports that are not resource methods but still form part of the public SDK surface.

Buy-Order Helpers

Constants

Builder Class

Builder methods:

• addRule(field, operator, value) Add a numeric or boolean rule.
• addStickerRule(stickerId, options?) Add a sticker has rule with optional qty or slot.
• addGroup(condition, build) Add a nested and or or group.
• build() Validate and return the final expression AST.

Request Helpers

Example:

import {
  buildSingleSkinBuyOrderExpression,
  buildSingleSkinBuyOrderRequest,
} from "csfloat-node-sdk";
 
const expression = buildSingleSkinBuyOrderExpression(7, 72, {
  stattrak: false,
  min_float: 0.01,
  max_float: 0.07,
});
 
const request = buildSingleSkinBuyOrderRequest(7, 72, {
  max_price: 3,
  quantity: 1,
  stattrak: false,
});

Relevant types: CsfloatSingleSkinBuyOrderExpressionOptions, CsfloatSingleSkinBuyOrderRequestOptions, CsfloatBuyOrderComparableField

Market And Search Helpers

Presets And Constants

Preset Functions

Filter And Range Builders

Example:

import {
  buildPriceRange,
  buildStickerFilters,
  getHomepageFeedParams,
  withWearPreset,
} from "csfloat-node-sdk";
 
const params = {
  ...getHomepageFeedParams("newest"),
  ...withWearPreset({}, "MW"),
  ...buildPriceRange({ min_price: 500, max_price: 5_000 }),
  ...buildStickerFilters([{ sticker_id: 85, slot: 1 }]),
};
 
const listings = await sdk.listings.getListings(params);

Relevant types: CsfloatCategoryPreset, CsfloatHomepageFeedPreset, CsfloatPriceRangeParams, CsfloatFadeRangeParams, CsfloatBlueRangeParams, CsfloatReferenceQuantityParams, CsfloatCollectionFilterParams, CsfloatRarityFilterParams, CsfloatPaintSeedFilterParams, CsfloatMusicKitFilterParams, CsfloatKeychainPatternRangeParams

Reference Price Helpers

Listings, watchlist entries, stall listings, and some inventory items can include a reference object that powers the marketplace-style price widget:

• base price
• item factor
• final/predicted price
• global listing count
• deal percentage versus the current listing price

The SDK already exposes the raw field as listing.reference / inventoryItem.reference. These helpers make it easier to work with it directly.

Notes:

• finalPrice in buildReferenceInsight() maps to the API field predicted_price
• globalListings maps to the API field quantity
• all values stay in the same integer price units used by listing.price and the API payloads

Example:

import {
  buildReferenceInsight,
  getReferenceDiscountPercent,
} from "csfloat-node-sdk";
 
const [listing] = (await sdk.listings.getListings()).data;
 
const insight = buildReferenceInsight(listing);
 
console.log(insight?.basePrice);
console.log(insight?.itemFactorAmount);
console.log(insight?.finalPrice);
console.log(insight?.globalListings);
console.log(getReferenceDiscountPercent(listing));

Relevant types: CsfloatReferencePrice, CsfloatReferenceInsight, CsfloatReferenceTarget

Loadout Helpers

Constants

Builder Functions

Example:

import {
  buildSingleSkinRecommendationRequest,
  getDiscoverLoadoutParams,
} from "csfloat-node-sdk";
 
const discover = await sdk.loadout.getLoadouts(
  getDiscoverLoadoutParams({ limit: 20, months: 1 }),
);
 
const request = buildSingleSkinRecommendationRequest(7, 72, {
  count: 5,
  def_whitelist: [7, 9, 13],
});

Relevant types: CsfloatLoadoutSkinSearchParams, CsfloatSingleSkinRecommendationOptions, CsfloatSingleSkinStickerRecommendationOptions

Schema And Media Helpers

These helpers operate on payloads from sdk.meta.getSchema() or sdk.meta.getItemExampleScreenshot().

Example:

import {
  findSchemaPaintsByIndex,
  getCsfloatScreenshotUrls,
} from "csfloat-node-sdk";
 
const schema = await sdk.meta.getSchema();
const screenshot = await sdk.meta.getItemExampleScreenshot({
  def_index: 7,
  paint_index: 490,
});
 
console.log(findSchemaPaintsByIndex(schema, 490));
console.log(getCsfloatScreenshotUrls(screenshot));

Relevant types: CsfloatSchemaRecordEntry, CsfloatSchemaPaintMatch, CsfloatScreenshotUrls

Wear Helpers

Example:

import { getWearParams } from "csfloat-node-sdk";
 
const factoryNew = getWearParams("FN");

Relevant types: CsfloatWearPreset, CsfloatWearParams

Pagination Helper

Most users should prefer the built-in iterators:

• sdk.listings.iterateListings()
• sdk.account.iterateWatchlist()
• sdk.stall.iterateStall()

Use paginateCursor() directly when you are composing your own cursor-driven wrapper:

import { paginateCursor } from "csfloat-node-sdk";
 
for await (const item of paginateCursor({
  loadPage: (cursor) => sdk.account.getNotifications({ cursor }),
  getItems: (page) => page.data,
})) {
  console.log(item.id);
}