Skip to main content
GET
/
v1
/
charts
/
credits_by_transaction_date
/
{project_id}
Credit volumes by transaction date for a project
curl --request GET \
  --url https://vcm-fyi-api.fly.dev/v1/charts/credits_by_transaction_date/{project_id} \
  --header 'X-API-KEY: <api-key>'
{
  "pagination": {
    "total_entries": 123,
    "current_page": 123,
    "total_pages": 123,
    "next_page": "<string>"
  },
  "data": [
    {
      "start": "2023-12-25",
      "end": "2023-12-25",
      "value": 123
    }
  ]
}

Authorizations

​
X-API-KEY
string
header
required

Path Parameters

​
project_id
string
required

Query Parameters

​
freq
enum<string>
default:Y

Frequency of bins

Available options:
D,
W,
M,
Y
​
current_page
integer
default:1

Page number

Required range: x >= 1
​
per_page
integer
default:100

Items per page

Required range: 1 <= x <= 200
​
transaction_type
string[] | null

Transaction type

​
vintage
integer[] | null

Vintage

​
transaction_date_from

Format: YYYY-MM-DD

​
transaction_date_to

Format: YYYY-MM-DD

​
quantity_min
integer | null

Minimum transaction quantity

​
quantity_max
integer | null

Maximum transaction quantity

​
beneficiary_search
string | null

Case insensitive search string. Currently searches on specified beneficiary_search_fields only.

​
beneficiary_search_fields
string[]

Beneficiary fields to search in. Valid fields are: retirement_beneficiary_harmonized, retirement_beneficiary, retirement_beneficiary_account, retirement_beneficiary_note, retirement_beneficiary_reason

Response

Time-binned credit totals for a single project

​
pagination
Pagination · object
required
​
data
ProjectCreditTotals · object
required