Parabol Notes - /notes
The /notes
endpoint provides daily access to Parabol’s on-chain treasury note information.
This includes:
- Coupon, Maturity, and Smart contract signatures for treasury bills (Parabol Notes)
This endpoint is crucial for accessing the most up-to-date treasury bill data provided by Parabol.
You can easily fetch the treasury bill data using the Parabol SDK.
HTTP Method
GET
Endpoint URL
https://api.parabol.fi/notes
curl -X GET 'https://api.parabol.fi/notes' \
-H 'Content-Type: application/json' \
-H 'x-api-key: YOUR_API_KEY'
The chainid
parameter is optional. If not provided, the API will return data
for all supported chains.
Headers
Name | Type | Description |
---|---|---|
Content-Type | string | application/json |
x-api-key | string | Your API key |
Query Parameters
Name | Type | Description |
---|---|---|
chainid | number | (Optional) Specifies the network. Supported values: 324 for zkSync |
Response
{
message: string;
data: [
{
maturity_timestamp: string;
coupon: string;
note_started_at: string;
signature_valid_after: string;
signature_valid_before: string;
signature: {
r: string;
s: string;
v: number;
};
chainid: string;
}
]
availableMaturities?: [number];
}
Response Parameters
Name | Type | Description |
---|---|---|
message | string | Message from the API |
data | array | Array of treasury bills |
availableMaturities | array | Array of available maturities |
Data Parameters
Name | Type | Description |
---|---|---|
maturity_timestamp | string | Maturity timestamp |
coupon | string | Coupon |
note_started_at | string | Note started at |
signature_valid_after | string | Signature valid after |
signature_valid_before | string | Signature valid before |
signature | object | Signature (v, r, s) |
chainid | string | Chain ID |
This structure allows users to easily access and verify the latest treasury bill information, including rates, maturity dates, and cryptographic proofs of authenticity.
Time-Sensitive Data Handling in Parabol
The /notes
endpoint implements a sophisticated time-based mechanism for handling treasury bill data, aligned with the US New York timezone. This approach ensures that the data reflects Parabol’s most current offerings while accounting for different time periods. Here are the key points to understand:
-
Timezone Alignment: All treasury bill data, including coupon rates, are synchronized with the US New York timezone. This alignment is crucial for maintaining consistency with Parabol’s operational schedule.
-
Coupon Rate Variations:
- Parabol’s system distinguishes between two daily periods:
- Coupons active between 00:00 AM and 6:00 PM (New York time)
- Coupons active between 6:00 PM and 00:00 AM (New York time)
- Users may observe differences in coupon rates between these two periods, reflecting Parabol’s dynamic t-bill strategy.
- Parabol’s system distinguishes between two daily periods:
-
Signature Validity Period:
- Each data response includes crucial timestamp information:
signature_valid_after
: Indicates when the current data became validsignature_valid_before
: Indicates when the current data will expire
- Each data response includes crucial timestamp information:
-
Data Freshness:
- To ensure you’re working with the most current data, always check the
signature_valid_after
andsignature_valid_before
fields. - It’s recommended to refresh your data if the current time falls outside of these validity periods.
- To ensure you’re working with the most current data, always check the
-
Automatic Updates:
- Parabol’s system automatically updates the treasury bill data at the transition points (6:00 PM and 00:00 AM New York time).
- These updates may include changes in coupon rates, reflecting Parabol’s latest financial offerings.
For optimal use of Parabol’s treasury bill data, implement a system to regularly check and refresh your data based on the signature validity periods. This ensures you’re always working with the most up-to-date information provided by Parabol.
By implementing this time-sensitive approach, Parabol ensures that users always have access to the most relevant and current treasury bill data. This system allows Parabol to offer dynamic pricing and up-to-date financial products while providing users with clear indicators of data validity and freshness.
Example Usage
curl -X GET 'https://api.parabol.fi/notes' \
-H 'Content-Type: application/json' \
-H 'x-api-key: YOUR_API_KEY'
Error Codes
If you encounter any issues with the API, please check the error codes below.
Code | Description |
---|---|
400 | Bad Request - Invalid chainid |
403 | Forbidden - Missing or invalid API key |
500 | Internal Server Error - Problem fetching data |