Skip to content
Last updated

Data Dictionary

Exchange Market Data

FieldTypeDescription
BalanceDouble"The number of credits remaining in an order. If balance is zero, the order has been fully transacted."
CcyStringCurrency
CountryStringDenotes the country where the credits associated with the voluntary project is based.
Date InStringThe date on which the order was placed. Orders may be live for multiple consecutive days
Date(UTC)ISO 8601 dateYYYY-MM-DDThh:mm:ss.sss
InstrumentStringCBL Instrument Code which Describes the instrument the order is placed for
Instrument Mkt NameStringThe combination of the instrument and the market in which the instrument trades.
Instrument NameStringThe full instrument name
MarketStringDescribes the CBL Market in which the instruments trade.
Order RefStringOrder Ref is the current unique order identifier of the order. When an order is edited, the Order Ref is updated. The Order Ref field will always be the most recent unique order identifier.
OriginalStringUnique Order ID of the Original Order. When an order is edited, it will have a new Order Reference. If the Original Order and Reference are identical, the order has not been amended.
PriceDoublePrice at which the order was placed
Project IDStringThe unique identifier of the project associated with the registry-based instruments. Note that the same project ID could occur on different registries, and will be unrelated projects.
Project TypeStringProject type as provided by the registry.
QuantityDoubleThe quantity bid for or offered.
SideStringDenotes whether the order is a bid or an offer.
SylveraRatingStringThe Sylvera Carbon Rating, which range from AAA to D
Time InStringThe time at which the offer was placed.
TimeZone(MD-S)StringTimezone: UTC
TypeStringOrder Type defines quantity, price, and or function.

AON = All or Nothing, If an order is marked AON, it must be filled completely to transact.
For example, an offer of 1,000 GEOs will not transact when a bid for 999 GEOs is placed at the same price.

Limit or Market: Limit describes an order to buy or sell a credit at a certain price. Market describes an order that will be executed at the nearest opposite order but does not guarantee the execution price.

FOK: Fill or Kill, An order that must be filled entirely within a certain time frame, or it will automatically cancel.

REPORT: An order part of a reported trade (aka negotiated). Orders with Type = REPORT are not visible to the wider market in real time.
ValueTaxDoubleTax added to transactions in certain countries.
VintageString"The vintage associated with Voluntary credits. Describes the start date of the issuance of the credits."

Source: CBL Markets

Broker Pricing Data

FieldTypeDescription
MarketDataIdStringUnique identifier for this data record
BusinessDateDateyyyy-mm-dd
ProductStringProduct name
TermStringProduct Term
Term2StringIn case two-legged instrument (ex. Calendar spread), this field will be populated with the second term
BidDoublePrice level of indicative bid
AskDoublePrice level of indicative ask
MidDoublePrice level of indicative mid

Source: Evolution Markets

Registry Data

FieldTypeDescription
CountryStringCountry the project is located in
Project IDIntegerThe unique identifier of the project associated with the registry-based instruments.

Note that the same project ID could occur on different registries and will be unrelated projects.
Project TypeStringProject type as provided by the registry.
RegistryStringRegistry in which the
VintageIntegerThe vintage associated with Voluntary credits. Describes the start date of the issuance of the credits.
Date(UTC)String (ISO 8601 date)YYYY-MM-DDThh:mm:ss.sss
Methodology(S)StringMethodology adhered to by corresponding registry
Project Name(S)StringName of the registered project
Source Project Type(S)StringStandardized definition of project type
Volume IssuedIntegerAmount of volume issued in Tons
Volume RetiredIntegerAmount of volume retired in Tons