Skip to main content

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

MicroSkills Reference

Calculate Current Yield

fixed_income.current_yield

ProductionBounded custom (Class B)Deterministicstrictfastv1.0.0
No network

Overview

Perform bounded current yield with explicit fixed-income inputs. All prices, cash flows, conventions, schedules, and factors are explicit.

Exact bounded fixed-income evidence avoids hidden market assumptions in fixed_income.current_yield.

Reliability

For fixed_income.current_yield, DECIMAL_INVALID means a decimal is malformed. FIXED_INCOME_INPUT_INVALID means shape, ordering, profile, or domain is invalid. ZERO_DENOMINATOR means a required divisor is zero. ITEM_LIMIT_EXCEEDED means a collection exceeds its published bound.

Context footprint

The compact receipt replaces repeated prompt arithmetic. A successful call costs 1 execution credit.

When to use it

When annual coupon divided by market price must become current yield.

When you need yield to maturity or a discounted cash-flow price rather than coupon over price.

Scope

Note
Perform bounded current yield with explicit fixed-income inputs

Non-goals

  • Does not source curves, rates, prices, schedules, or market data.
  • Does not infer settlement, accounting, tax, or regulatory policy.

Properties

IdempotentRetry safeStreaming supportedFile input supportedRequires external service

Capabilities

analysismath

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
annualCouponstringYesClosed bounded annualCoupon field documented by the canonical contract.
marketPricestringYesClosed bounded marketPrice field documented by the canonical contract.

Output schema

FieldTypeRequiredDescription
currentYieldstringYesOutput receipt field currentYield produced under the canonical bounded fixed-income contract.

API contract

POST /v1/execute
curl
curl -sS -X POST "$BASE/v1/execute" -H "Authorization: Bearer $KEY" -H 'Content-Type: application/json' -d '{"skillKey":"fixed_income.current_yield","input":{"annualCoupon":"5","marketPrice":"100"}}'
Integrations
TypeScript SDK
import { Squillify } from "@squillify/sdk";

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

const { output } = await sq.execute("fixed_income.current_yield", {"marketPrice":"100","annualCoupon":"5"});

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.
FIXED_INCOME_INPUT_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 source curves, rates, prices, schedules, or market data.
  • Does not infer settlement, accounting, tax, or regulatory policy.
  • Market-data sourcing or convention inference.

How to call

POST /v1/execute (requires authentication)

Request bodyjson
{
  "skillKey": "fixed_income.current_yield",
  "input": {
    "marketPrice": "100",
    "annualCoupon": "5"
  }
}

Examples

Verified contract vector

Inputjson
{
  "marketPrice": "100",
  "annualCoupon": "5"
}
Expected outputjson
{
  "currentYield": "0.05"
}
Tip
Deterministic W17/W19 vector.

Repeated deterministic vector

Inputjson
{
  "marketPrice": "100",
  "annualCoupon": "5"
}
Expected outputjson
{
  "currentYield": "0.05"
}
Tip
Same input yields the same output.
  • Auditable bounded fixed-income arithmetic.
  • Independent fixed-income reperformance.

Avoid for

  • Market-data sourcing or convention inference.

Composable with

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

mathfinancefixed-income