Skip to main content

Squillify development is paused indefinitely. Read why, and discover what this experiment achieved. Read the story

Squillify
MicroSkills Reference

Calculate a Weighted-Average FX Rate

finance.fx_weighted_average_rate

ProductionBounded custom (Class B)Deterministicstrictinstantv1.0.0
No network

Overview

Perform bounded exact-decimal fx weighted average rate with every directed rate and convention explicit. Closed input, fixed precision, typed failures, and no ambient market data apply.

You receive bounded directed FX arithmetic with explicit trace evidence for finance.fx_weighted_average_rate.

Reliability

DECIMAL_INVALID means a decimal is malformed or over limit; correct it. FX_RATE_NON_POSITIVE means a required rate or factor is not positive; correct it. FX_ORIENTATION_INVALID means currencies or edge orientation are inconsistent; correct them. FX_POINT_SCALE_INVALID means point scale is outside 1..1,000,000; correct it. FX_SPREAD_INVALID means the supplied ask is lower than the supplied bid; correct the quote. FX_RATE_TABLE_INVALID or FX_RATE_DUPLICATE_PAIR means an edge table is malformed; correct it. FX_PATH_NOT_FOUND or FX_PATH_POLICY_INVALID means no bounded directed path satisfies policy; correct the graph or policy. FX_WEIGHTS_INVALID or ZERO_DENOMINATOR means aligned weights are invalid; correct them. FX_RATE_MISSING means a direct reporting-currency rate is absent; supply it. FX_LIMIT_EXCEEDED or ITEM_LIMIT_EXCEEDED means a count bound was exceeded; reduce input. This guidance applies specifically to finance.fx_weighted_average_rate.

Context footprint

The compact result replaces repeated prompt FX arithmetic for finance.fx_weighted_average_rate. A successful call costs 1 execution credit.

When to use it

When several directed rates with aligned weights must be blended into one average quote.

When the observations are unweighted, or the weights are not aligned to the rate list.

Scope

Note
Perform bounded exact-decimal fx weighted average rate with every directed rate and convention explicit

Non-goals

  • Does not fetch rates, infer reciprocals, infer paths, or select market data for finance.fx_weighted_average_rate.
  • Does not apply accounting, tax, hedge, settlement, or rounding policy for finance.fx_weighted_average_rate.

Properties

IdempotentRetry safeStreaming supportedFile input supportedRequires external service

Capabilities

math

Cost & billing

Flat rate per invocation

MetercallsBillable onsuccessCost per call1 credit

File handling

Accepts file_refProduces file_refMax input64 KB

How we handle your data

Sensitive input, safe output
What this means

This skill may receive sensitive content, but it does not target sensitive data and returns only a structured non-sensitive result.

Squillify guarantees
  • Runs inside Squillify
  • This skill runs inside Squillify.
  • Payloads are not sent to an external service by this skill.
  • Squillify does not permanently store submitted payloads.
  • Telemetry records metadata only, not submitted content.
  • Submitted payloads are not used for training.
  • Submitted payloads are not reviewed by humans.
  • This skill does not target sensitive data.
  • The response does not contain submitted content.
Your responsibility

Squillify does not determine whether submitted content is sensitive. Your application is responsible for deciding what data it is allowed to submit. Your application is responsible for securing the response.

Read the Microskill Data Handling Policy

Input schema

FieldTypeRequiredDescription
ratesarrayYesOrdered array of one through 10,000 positive plain-decimal rate strings aligned by index with weights.
weightsarrayYesAligned non-negative plain-decimal strings with positive sum.

Output schema

FieldTypeRequiredDescription
averageRatestringYesWeighted-average rate. Returned as a normalized plain-decimal string.
weightSumstringYesSum of supplied weights. Returned as a normalized plain-decimal string.
countintegerYesAligned value count.

API contract

POST /v1/execute
curl
curl -sS -X POST "$BASE/v1/execute" -H "Authorization: Bearer $KEY" -H 'Content-Type: application/json' -d '{"skillKey":"finance.fx_weighted_average_rate","input":{"rates":["1","2"],"weights":["1","3"]}}'
Integrations
TypeScript SDK
import { Squillify } from "@squillify/sdk";

const sq = new Squillify({ apiKey: process.env.SQUILLIFY_API_KEY });

const { output } = await sq.execute("finance.fx_weighted_average_rate", {"rates":["1","2"],"weights":["1","3"]});

Errors

CodeHTTPRetryableDescription
VALIDATION_ERROR400NoThe request payload failed schema validation.
UNAUTHORIZED401NoMissing or invalid API key.
SKILL_NOT_ACCESSIBLE403NoThe API key is not granted access to this skill.
SKILL_NOT_AVAILABLE_FOR_PLAN403NoThis skill is not included in your current plan.
PLAN_ELIGIBILITY_UNAVAILABLE503YesPlan eligibility could not be decided. Retry after backoff.
SKILL_NOT_FOUND404NoThe requested skill or version does not exist.
TENANT_RATE_LIMITED429YesRequest rate limit exceeded. Retry after backoff.
QUOTA_EXCEEDED429YesPlan quota exhausted. Retryable once the quota period resets.
EXECUTION_TIMEOUT504YesExecution exceeded the allowed time budget.
DECIMAL_INVALID400NoThe request payload failed this skill's input validation.
FX_RATE_NON_POSITIVE400NoThe request payload failed this skill's input validation.
FX_WEIGHTS_INVALID400NoThe request payload failed this skill's input validation.
ZERO_DENOMINATOR400NoThe request payload failed this skill's input validation.
ITEM_LIMIT_EXCEEDED429NoA size, quota, rate, or time limit was exceeded.

Other limits

LimitValue
Recommended inline bytes32 KiB

Limitations

  • Does not fetch rates, infer reciprocals, infer paths, or select market data for finance.fx_weighted_average_rate.
  • Does not apply accounting, tax, hedge, settlement, or rounding policy for finance.fx_weighted_average_rate.
  • Market-rate lookup or inferred currency orientation
  • Inputs beyond the published edge, item, value, or hop limits.

How to call

POST /v1/execute (requires authentication)

Request bodyjson
{
  "skillKey": "finance.fx_weighted_average_rate",
  "input": {
    "rates": [
      "1",
      "2"
    ],
    "weights": [
      "1",
      "3"
    ]
  }
}

Examples

Verified calculation

Inputjson
{
  "rates": [
    "1",
    "2"
  ],
  "weights": [
    "1",
    "3"
  ]
}
Expected outputjson
{
  "weightSum": "4",
  "averageRate": "1.75",
  "count": 2
}
Tip
Returns the primary independently recomputed W06 vector.

Alternative calculation

Inputjson
{
  "rates": [
    "1.2"
  ],
  "weights": [
    "5"
  ]
}
Expected outputjson
{
  "weightSum": "5",
  "averageRate": "1.2",
  "count": 1
}
Tip
Returns a materially different independently recomputed W06 vector.

Recommended use cases

  • Auditable exact-decimal directed FX algebra for finance.fx_weighted_average_rate.
  • Bounded conversion and orientation checks with every rate supplied explicitly.

Avoid for

  • Market-rate lookup or inferred currency orientation
  • Inputs beyond the published edge, item, value, or hop limits.

Related skills

finance.multi_currency_sum

Composable with

finance.multi_currency_sum

Safety & privacy

  • Runs without calling any external service.
  • Your payloads are never stored permanently.
  • Telemetry captures metadata only — never your payload contents.
  • We never train models on your payloads.
  • No human reviews your payloads.

Tags

mathfinancefx
Back to MicroSkills Reference