Providing a valid User-Agent helps your requests appear legitimate and avoid being blocked by security measures. Please use it as a header when consuming the API endpoints. All browser and postman User-Agent's are valid - examples can be found here.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"11369966","collectionId":"cae06a8b-aafd-4f94-bc6c-88887c027466","publishedId":"TzsfoRbF","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2022-02-26T00:21:16.000Z"},"item":[{"name":"Private API","item":[{"name":"Market","item":[{"name":"Get all active offers on the market","id":"3bc53b33-dc3b-42a2-b455-7dfa595c0c31","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Api-Key","value":"{{apiKey}}","type":"text"},{"key":"Api-Secret","value":"{{apiSecret}}","type":"text"}],"url":"{{apiURL}}/api/market/offers","description":"Returns the live offers in the market. Ordered from the lowest price
\nlimit: Maximum number of elements per request.
offset: Number of elements skipped (Used mostly for pagination).
Returns the live bids in the market. Ordered from the highest price.
\nlimit: Maximum number of elements per request.
offset: Number of elements skipped (Used mostly for pagination).
Returns the most recent trades in the last 7 days.
\nCan be filtered by commodities, seasons, ports, grades and delivery periods. These filters are a list of strings, comma separated
\ncommodity_names: List of commodities
season_names: List of seasons
port_names: List of ports
grade_names: List of grades
delivery_period_names: List of delivery periods
Returns all sales associated with the organisation that owns the API credentials.
\nFor agent organisations, it will return the sales of its authorised growers, from the authorisation date onwards.
\nNote: Different results may be available depending on the market type and status of a sale.
\nlimit: Maximum number of elements per request.
offset: Number of elements skipped (Used mostly for pagination).
Returns all purchases associated with the organisation that owns the API credentials.
\nNote: Different results may be available depending on the market type and status of a purchase.
\nlimit: Maximum number of elements per request.
offset: Number of elements skipped (Used mostly for pagination).
Returns all active offers owned by the organisation associated with the API credentials.
\nFor agent organisations, it will return all active offers of authorised clients/growers.
\nlimit: Maximum number of elements per request.
offset: Number of elements skipped (Used mostly for pagination).
Returns all active bids owned by the organisation associated with the API credentials.
\nlimit: Maximum number of elements per request.
offset: Number of elements skipped (Used mostly for pagination).
Introduction
\nTo access our private endpoints, you will need to request API credentials from a CGX administrator within your organisation. Once you have received your credentials via email, which consist of an Api-Key and Api-Secret, you will need to include them as headers in each request. With these organisation-specific API credentials, you will have access to all active offers, active bids, sales, and purchases associated with your organisation.
\nAdditionally, you can request access (at a site or port level) to all active offers and active bids in the market, as well as recent trades from the last 7 days. All live market endpoints can be found in the \"market\" folder.
\nUsage
\nAll endpoints in the private API can be filtered by the updated_at parameter in ISO-8601 format. This format includes the date in the format YYYY-MM-DD, followed by the letter T to indicate the start of the time section, and the time in the format HH:MM:SS.mmm, where mmm is the milliseconds. For example, updated_at=2023-01-24T16:46:40.770
To ensure fair usage of our API and to prevent overloading our systems, there is a user rate limit of 30 requests per 5 seconds for all requests.
\nFor endpoints that allow pagination with the params limit and offset:
when no limit param is set it will return a maximum 20 records by default.
there is a maximum limit of 100 records per request (see pagination section)
Pagination
\nWhen requesting more than 100 records you will be required to use a combination of the limit and offset parameters. For example: to return 300 records there will be 3 separate requests sent with the following parameters:
1st request (first page with 100 records): limit: 100, offset: 0
\n2nd request (second page with 100 records): limit: 100, offset: 100
\n3rd request (third page with remaining records): limit: 100, offset: 200
\n