latestOpenAPI 3.0.12026-08-20112309904.6 KB

466169815b78

Collections - Network

Get commodity graph for a collection

⚠️ DEPRECATED - This endpoint is deprecated and will be removed at the end of December 2026.

Note: Responses include a Sunset HTTP header (RFC 8594) indicating the removal date.


Migration Required

This endpoint has been replaced by the v2 Network API. Please migrate to the new endpoint:

Replacement Endpoint

Old EndpointNew EndpointPurpose
GET /public/v1/network/{collectionId}/commodity-graphGET /public/v2/network/{collectionId}/commodity-graphGet commodity graph for a collection

Why Migrate?

The v2 Network API provides improvements:

1. Enhanced Response Structure

  • v1: Returns PublicTreeTargetV1 structure
  • v2: Returns PublicTreeTargetV2 structure with additional metadata
  • v2: Better organized response format

2. Improved Consistency

  • v2: Aligned with other v2 API endpoints
  • v2: Consistent response structures across network endpoints

3. Better Documentation

  • Comprehensive examples for all endpoints
  • Detailed error response documentation
  • Clear parameter descriptions

Quick Migration Guide

Step 1: Update Endpoint URL

Before:

GET /public/v1/network/123/commodity-graph

After:

GET /public/v2/network/123/commodity-graph

Step 2: Update Response Parsing

Before: Parse PublicTreeTargetV1 structure

After: Parse PublicTreeTargetV2 structure (may have additional fields)


Breaking Changes

  1. Endpoint Path: Changed from /public/v1/network/{collectionId}/commodity-graph to /public/v2/network/{collectionId}/commodity-graph
  2. Response Structure: Returns PublicTreeTargetV2 instead of PublicTreeTargetV1 (may have additional fields)

Required Permissions: ACCESS_PUBLIC_COMMODITY_GRAPH and READ on the collection

Performance Impact: High

get/public/v1/network/{collectionId}/commodity-graph

Path parameters

collectionIdinteger required

Response

OK