Corgi BankDocumentation
OpenAPI

Intraday position at the Federal Reserve against the net debit cap

GET/reports/fed-position

Returns

200 OK

as_ofstring · date-timeRequired
balance_amountintegerRequired
business_datestring · dateRequired

A business date, YYYY-MM-DD

cap_categorystringRequired

Zero, exempt_from_filing, de_minimis, average, above_average or high

cap_multiplestringRequired
capital_measure_amountintegerRequired
collateral_available_amountintegerRequired

The register's lendable value pledged to the Reserve Bank less discount window advances outstanding; zero while unknown

collateral_knownbooleanRequired

False when the collateral register could not answer

collateral_lendable_amountintegerRequired

The register's lendable value pledged to the Reserve Bank, before discount window advances

collateral_unavailablestringOptional

Why the collateral is unknown

discount_window_advances_amountintegerRequired
headroom_amountintegerRequired

Projected position plus the cap and the collateral: what more can go out

ledger_balance_amountintegerOptional
maintenance_periodobjectRequired

PeriodCharge is the two-week reserve maintenance period's bill with the $150 waiver applied.

7 child attributes
daysarray of objectsRequired
9 child attributes
average_uncollateralized_overdraft_amountintegerRequired
charge_amountintegerRequired
completebooleanRequired
minutes_coveredintegerRequired
minutes_unsampledintegerRequired
peak_uncollateralized_overdraft_amountintegerRequired
psr_daystring · dateRequired

A business date, YYYY-MM-DD

samplesintegerRequired
unsampled_priced_at_amountintegerRequired
endstring · dateRequired

A business date, YYYY-MM-DD

gross_charge_amountintegerRequired
net_charge_amountintegerRequired
notestringRequired
startstring · dateRequired

A business date, YYYY-MM-DD

waiver_amountintegerRequired
net_debit_cap_amountintegerRequired
overdraft_amountintegerRequired
pending_by_railobjectRequired
pending_itemsintegerRequired
pending_outbound_amountintegerRequired
pending_outbound_knownbooleanRequired
position_sourcestringOptional
projected_amountintegerRequired

Balance less pending outbound

psr_daystring · dateRequired

A business date, YYYY-MM-DD

sourcestringRequired
statusstringRequired

Within_cap, overdraft (inside the cap), cap_breached, or collateral_unavailable (an overdraft the register cannot split)

todayobjectRequired

FedPeak is the day's worst Fed position reading.

6 child attributes
cap_breachedbooleanRequired
lowest_atstring · date-time or nullOptional
lowest_projected_amountintegerRequired
peak_overdraft_amountintegerRequired
peak_uncollateralized_overdraft_amountintegerRequired
samplesintegerRequired
today_chargeobjectRequired

DayCharge is one 24-hour measurement day's daylight overdraft pricing: the time-weighted average uncollateralized overdraft over 1,440 minutes at 50 basis points a year (the Federal Reserve's PSR policy, section V of its guide). Elapsed minutes no sample describes are priced at the day's peak; complete is false until the samples cover the whole day.

9 child attributes
average_uncollateralized_overdraft_amountintegerRequired
charge_amountintegerRequired
completebooleanRequired
minutes_coveredintegerRequired
minutes_unsampledintegerRequired
peak_uncollateralized_overdraft_amountintegerRequired
psr_daystring · dateRequired

A business date, YYYY-MM-DD

samplesintegerRequired
unsampled_priced_at_amountintegerRequired
uncollateralized_overdraft_amountintegerRequired

What the cap limits and the fee prices

Errors

Every error is a problem document with a stable code. See Errors.

400401403404409412413422424429500503

to move to open esc to close