Skip to main content

​
List Orders

Retrieves a list of orders.

​
HTTP Request

GET https://api.cdr.fyi/v1/orders

​
Query Parameters

ParameterTypeDescription
entityFilterTypeStringFilter by entity (Supplier, Marketplace, Purchaser)
entityFilterIdStringFilter by entity ID

​
Custom Headers

  • x-page: The page number (default is 1)
  • x-limit: Number of items per page (max 100, default is 10)

​
Example Request

curl -H "Authorization: Bearer YOUR_ACCESS_TOKEN" "https://api.cdr.fyi/orders?entityFilterType=Supplier&entityFilterId=123"

​
Error Responses

If the request is not successful, you will receive a 400 Bad Request or 401 Unauthorized response along with an error message indicating the issue.

​
FAQ

How can I replicate the total order volume seen on CDR.fyi? To calculate total order volume, retrieve all orders and sum tons_purchased for orders where **type_of_agreement **is “Credit Sale” How can I replicate the total market size $ shown on CDR.fyi? The total market cap is calculated based the average price per tonne by method * total volume within that method. However, because CDR.fyi manages private pricing datapoints, this metric cannot be reconstructed with public data. We plan to release a /metrics endpoint, if you’re interested please reach out.
⌘I