venue:read.
1
Read the month's number
GET /api/venues/{venueId}/usage answers with the count, the price and the total.null price or amount means the month isn’t priced, never a
zero bill. currency is always USD, the currency trdrs bills in, whatever the currency of your
paper accounts.2
Pull the accounts behind it
GET /api/venues/{venueId}/usage/accounts expands the same query into one row per account that
counted, ordered by account number.accountNumber, the count of real fills inside the month, and
firstFillAt and lastFillAt in UTC. Each account is named by its account number, and the rows
carry no trader’s identity.3
Watch the month as it runs
Both routes read the previous complete month, the one being invoiced, when you leave
month
out. Name the current month to read month-to-date, which keeps moving until the month closes.month is YYYY-MM, and months are UTC. A malformed month is refused with 400 invalid_month
rather than read as the default, so a typo in a reporting job fails loudly instead of reporting a
different month.Know what the meter counts
activeAccounts is the number of distinct accounts that took at least one real fill inside the
month. Three consequences follow from that.
Nothing is prorated and no account counts in part: an account either took a real fill inside the
UTC month or it didn’t.
Read basis before the number
basis says how the accounts were attributed to your venue, and it changes what the number means.
The meter counts real fills at Rithmic on accounts whose login is your Rithmic system, and nothing
else. A venue whose accounts are issued on the paper book takes no such fills, so it reads
basis: "unattributable", activeAccounts: 0 and amountCents: null, with an empty account list.
That’s the meter stating that it measures Rithmic fills alone, and it isn’t a bill of zero.
Reconcile an invoice
- Read the month’s number with
basisandactiveAccounts. Ifbasisisunattributable, stop: the count is a fixed zero, not a measurement, and the invoice question is a commercial one. - Pull the account list for the same month. It always sums to
activeAccounts, because it’s the same query expanded, so a difference from your expectation becomes account by account rather than one disputed total. - Compare it with your own records. An account on our list and not on yours traded when you thought it was dormant. An account on yours and not ours took no real fill that month: it was connected but idle, or traded simulated fills only.
- Check the arithmetic.
amountCentsisactiveAccountstimespriceCentsPerActiveAccount, in cents. Anullprice means no price is set on your venue, which is a contract question, not a data one.
Handle errors
Next steps
Venue accounts
See the accounts that can become billable, and the balance operations your finance team reads.
Register an account
Pre-register an account, the other way an account arrives.
Active traders
See how a Connect app is billed for its active traders.