Skip to content

Main content

API Cost Calculator Source Code

Browse the implementation files for API Cost Calculator.
@tool.io/tools/cost/api source ↗
tool.ts typescript
import {
	CURRENCY_OPTIONS,
	formatCostSummary,
	formatMoney,
	parseCurrency,
	parseNonnegative
} from '../calculation';
import { calculateApiCost } from '@tool.io/tools/cost/api';

export const apiCost = (
	currencyInput: unknown,
	requestsInput: unknown,
	includedInput: unknown,
	requestRateInput: unknown,
	transferInput: unknown,
	transferRateInput: unknown
): string => {
	const currency = parseCurrency(currencyInput);
	const requests = parseNonnegative(requestsInput);
	const included = parseNonnegative(includedInput);
	const requestRate = parseNonnegative(requestRateInput);
	const transfer = parseNonnegative(transferInput);
	const transferRate = parseNonnegative(transferRateInput);
	if (
		!currency ||
		requests === null ||
		included === null ||
		requestRate === null ||
		transfer === null ||
		transferRate === null
	)
		return '';
	const result = calculateApiCost(
		requests,
		included,
		requestRate,
		transfer,
		transferRate,
		currency
	);
	if (!result) return '';
	return formatCostSummary([
		[
			'Billable requests',
			result.billableRequests.toLocaleString('en-US')
		],
		['Request cost', formatMoney(result.requestCost, currency)],
		['Data transfer cost', formatMoney(result.transferCost, currency)],
		['Monthly total', formatMoney(result.monthlyTotal, currency)]
	]);
};

export const Tool: TypeTool = {
	name: 'API Cost Calculator',
	slug: 'cost/api',
	intro:
		'Estimate API request and data-transfer charges after applying an included monthly request allowance.',
	tool: apiCost,
	i: [
		{
			example: 'USD',
			label: 'Currency',
			options: CURRENCY_OPTIONS,
			placeholder: 'Select currency',
			type: 'select'
		},
		{
			example: '5000000',
			label: 'Monthly Requests',
			placeholder: 'Total API requests',
			type: 'number'
		},
		{
			example: '1000000',
			label: 'Included Requests',
			placeholder: 'Free or included requests',
			type: 'number'
		},
		{
			example: '1',
			label: 'Price per Million Requests',
			placeholder: 'Request rate',
			type: 'number'
		},
		{
			example: '100',
			label: 'Data Transfer (GB)',
			placeholder: 'Billable transfer',
			type: 'number'
		},
		{
			example: '0.09',
			label: 'Price per GB',
			placeholder: 'Transfer rate',
			type: 'number'
		}
	],
	o: [
		{
			example:
				'Billable requests: 4,000,000\nRequest cost: $4.00\nData transfer cost: $9.00\nMonthly total: $13.00',
			label: 'API Cost',
			placeholder: 'API costs will appear here...',
			render: 'textarea',
			type: 'text'
		}
	],
	alternative: [
		{
			title: 'Cloud Computing Cost Calculator',
			url: '/cost/cloud-computing'
		}
	],
	cite: [
		{
			title: 'Web API - Wikipedia',
			url: 'https://en.wikipedia.org/wiki/Web_API'
		}
	]
};
export default Tool;

Description

Browse the implementation files for API Cost Calculator.

References

  1. Tool.io on GitHub
  2. Tool.io TypeScript tools library

Similar or alternative tools