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.

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'

Headers

Query Parameters

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

Data Parameters

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:

1. 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.

2. 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.

3. Signature Validity Period:

   • Each data response includes crucial timestamp information:
     • signature_valid_after: Indicates when the current data became valid
     • signature_valid_before: Indicates when the current data will expire

4. Data Freshness:

   • To ensure you’re working with the most current data, always check the signature_valid_after and signature_valid_before fields.
   • It’s recommended to refresh your data if the current time falls outside of these validity periods.

5. 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.

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'

import fetch from 'node-fetch';
 
const API_URL = 'https://api.parabol.fi/notes';
const API_KEY = 'YOUR_API_KEY';
const CHAIN_ID = 324; // zkSync (optional)
 
async function fetchNotes() {
    try {
        const response = await fetch(`${API_URL}?chainid=${CHAIN_ID}`, {
        method: 'GET',
        headers: {
            'Content-Type': 'application/json',
            'x-api-key': API_KEY,
        },
    });
 
        if (!response.ok) {
            throw new Error(`HTTP error! status: ${response.status}`);
        }
 
        const data = await response.json();
        console.log('Notes:', JSON.stringify(data, null, 2));
    } catch (error) {
        console.error('Error fetching notes:', error.message);
    }
}
 
fetchNotes();

import requests
 
API_URL = "https://api.parabol.fi/notes"
API_KEY = "YOUR_API_KEY"
CHAIN_ID = 324  # zkSync (optional)
 
headers = {
    'Content-Type': 'application/json',
    'x-api-key': API_KEY,
}
 
try:
    response = requests.get(f"{API_URL}?chainid={CHAIN_ID}", headers=headers)
    response.raise_for_status()  # Raises an HTTPError for bad responses
    data = response.json()
    print('Notes:', data)
except requests.exceptions.RequestException as error:
    print('Error fetching notes:', error)

Error Codes