Superfluid Accounting API

Streams move value every second, but accounting tools don’t record value transfer on a real-time basis (typically it’s monthly). The Stream Accounting API can be used to represent your streams in a manner that’s consumable by your traditional accounting tools.

More info about using the Accounting API can be found here

Running locally

1. Install node modules:

yarn install

2. Run netlify

yarn dev

3. Local server will start at

http://localhost:8888

NOTE: The swagger is hard-coded to the production URL.

API endpoints

Virtualized stream periods

URL https://accounting.superfluid.dev/v1/stream-periods

Query params: chains - string (chain ID-s separated by comma)
addresses - string (addresses separated by comma)
start - number (unix timestamp)
end - number (unix timestamp)
priceGranularity - VirtualizationPeriod hour, day, week, month or year period
virtualization - VirtualizationPeriod hour, day, week, month or year period
currency - CurrencyCode (ISO 3-Letter Currency Code)
counterparties - string (addresses separated by comma). This field is optional. If no counterparties are provided, everyone will be selected

Example request

https://accounting.superfluid.dev/v1/stream-periods?addresses=0xe38ffDD2B0B8bb7E93D409f4A282714b18B77980&chains=100%2C137%2C10%2C42161%2C42220%2C43114%2C56&start=1638309600&end=1669845599&priceGranularity=day&virtualization=month&currency=USD&counterparties=0x7BDa037dFdf9CD9Ad261D27f489924aebbcE71Ac%2C0x7269B0c7C831598465a9EB17F6c5a03331353dAF

VirtualizationPeriod

hour (Use at risk! This can fail due to too large response. Try using smaller timeframe or single address.)
day
week
month
year

Supported currencies:

USD
EUR
AUD
BRL
CAD
CHF
CNY
GBP
HKD
INR
JPY
KRW
MXN
NOK
RUB
SEK

Swagger Documentation

URL https://accounting.superfluid.dev/v1/swagger

OpenAPI Configuration

URL https://accounting.superfluid.dev/static/api-docs.yaml