Selected field names (tracked through chaining for precise autocomplete)
Included relations (tracked through chaining with proper cardinality)
Protected OptionalapiPer-call API key override, set via apiKey.
ProtectedfiltersProtectedqueryProtectedselectedProtectedskipWhen true, this call bypasses the response cache. Set via skipCache.
ProtectedsubqueriesProtected Static ReadonlyMAX_Protected Static ReadonlyMAX_Protected Static ReadonlyMAX_Protected Static ReadonlyMAX_Protected Static ReadonlyMAX_Protected Static ReadonlyMAX_Protected Static ReadonlyQUERIES_Queries that return data directly without wrapping in a 'data' object. These queries follow a different GraphQL schema structure.
Use a specific API key for this call instead of the client's default key.
The Politics & War API key to authenticate this query with.
This query builder instance for method chaining.
ProtectedbuildBuild the final GraphQL query string with comprehensive validation.
Constructs a complete GraphQL query including:
Validation includes:
Whether to include pagination info in response
Complete GraphQL query string ready for execution
Execute the top trade info query and return results.
Return type changes based on withPaginator parameter:
execute() or execute(false) → Returns single top trade info objectexecute(true) → Returns object with data and paginatorInfoResults only include selected fields. All other fields are excluded from the response.
Single top trade info object, or object with data and paginatorInfo if withPaginator is true
// Returns single object directly
const tradeInfo = await query.execute();
// Type: { market_index: number, resources: TopTradeResourceInfo[] }
console.log(tradeInfo.market_index);
console.log(tradeInfo.resources[0].average_price);
// Returns object with pagination info
const result = await query.execute(true);
// Type: { data: {...}, paginatorInfo: {...} }
console.log(result.data); // Trade info object
console.log(result.paginatorInfo.total); // Total count
Execute the top trade info query and return results.
Return type changes based on withPaginator parameter:
execute() or execute(false) → Returns single top trade info objectexecute(true) → Returns object with data and paginatorInfoResults only include selected fields. All other fields are excluded from the response.
Single top trade info object, or object with data and paginatorInfo if withPaginator is true
// Returns single object directly
const tradeInfo = await query.execute();
// Type: { market_index: number, resources: TopTradeResourceInfo[] }
console.log(tradeInfo.market_index);
console.log(tradeInfo.resources[0].average_price);
// Returns object with pagination info
const result = await query.execute(true);
// Type: { data: {...}, paginatorInfo: {...} }
console.log(result.data); // Trade info object
console.log(result.paginatorInfo.total); // Total count
Include related data in the query results
New query instance with included relation
ProtectedsanitizeSanitize and escape a string value for safe GraphQL usage.
Validates input type and length, checks for null bytes, and escapes special characters including backslashes, quotes, newlines, carriage returns, tabs, form feeds, and backspaces.
The string to sanitize
Sanitized string with all special characters properly escaped
Select specific fields to retrieve from top trade info
Field names to select
New query instance with selected fields
ProtectedserializeSerialize an object to GraphQL format (enum values without quotes).
Validates object structure and prevents prototype pollution by:
Plain object to serialize (not arrays)
GraphQL-formatted object string in format {key:value, ...}
Bypass the response cache for this call.
Only meaningful when caching is enabled on the client (cache.enabled).
The result is fetched fresh from the API and is neither read from nor
written to the cache. No effect when caching is disabled.
This query builder instance for method chaining.
Query builder for fetching top trade information from the Politics & War API.
Create new instances using the factory method:
pnwkit.queries.topTradeInfo()Each call creates a fresh instance with no shared state, preventing filter pollution.Top trade info provides current market data including market index and resource-specific trade information with best buy/sell offers.
Features:
Return types:
execute()→ Returns top trade info objectexecute(true)→ Returns{ data: TopTradeInfo, paginatorInfo: {...} }Example