Marketplace blocks

Get information about marketplace blocks.


Analytics platform discontinued after January 31, 2024

The current analytics platform will be discontinued after January 31, 2024, and will be replaced by new advanced processing functionalities. This change will affect projects, workflows, jobs, data blocks, processing blocks, and custom blocks. For more information, see the blog post.

Overview

Get information about data blocks or processing blocks on the marketplace.

See marketplace blocks

To see a list of all available marketplace blocks, call the /marketplace/blocks endpoint.

Request

GET /marketplace/blocks HTTP/1.1
Host: api.up42.com

Response


See response example
{
  "data": [
    {
      "id": "3e146dd6-2b67-4d6e-a422-bb3d973e32ff",
      "displayId": "3e146dd6",
      "createdAt": "2019-02-21T11:02:11.535Z",
      "updatedAt": "2023-05-31T14:02:29.816408Z",
      "createdBy": null,
      "updatedBy": null,
      "name": "tiling",
      "displayName": "Raster Tiling",
      "description": "Clips rasters into tiles for machine learning algorithms.",
      "provider": "UP42",
      "type": "PROCESSING",
      "metadata": {
        "blockThumbnailUrl": "https://metadata.up42.com/3e146dd6-2b67-4d6e-a422-bb3d973e32ff/Raster_Tiling_Thumbnail1608218469319.png",
        "pricingStrategy": {
          "type": "MEGABYTE_INPUT",
          "credits": 0
        },
        "blockPricingStrategy": {
          "name": "simple",
          "unit": "MEGABYTE",
          "direction": "INPUT",
          "credits": 0
        }
      },
      "version": "2.2.8",
      "isPublic": true,
      "isValid": true,
      "isRestricted": false,
      "isAccessGranted": true,
      "isCreditPurchaseRequired": false,
      "tags": [
        "Maritime",
        "Oil, Gas, Minerals, and Energy",
        "Transportation",
        "Real Estate",
        "Raster",
        "Infrastructure and Utilities",
        "Agriculture",
        "Insurance and Financial Services",
        "Environmental Protection",
        "Land Use and Management"
      ],
      "isPublicVersion": true,
      "manifestVersion": 2
    }
  ],
  "error": null
}

The response parameters are the same as for the See public blocks endpoint.

See a marketplace block

To see information about a specific marketplace block, call the /marketplace/blocks/{block_id} endpoint with the specific block ID as a path parameter.

Request

GET /marketplace/blocks/{block_id} HTTP/1.1
Host: api.up42.com

Response


See response example
{
  "data": {
    "id": "ee058d6b-a62c-4fc4-aaca-a1cbe2cf7d1a",
    "displayId": "ee058d6b",
    "name": "ecognition_mrs",
    "displayName": "eCognition Multi-resolution segmentation and object export",
    "description": "The multiresolution segmentation algorithm consecutively merges pixels. Thus it is a bottom-up segmentation algorithm based on a pairwise region merging technique. Multiresolution segmentation is an optimization procedure which, for a given number of image objects, minimizes the average heterogeneity and maximizes their respective homogeneity. This homogeneity criterion is defined as a combination of spectral homogeneity and shape homogeneity.",
    "inputCapabilities": [],
    "outputCapabilities": [],
    "provider": "Trimble eCognition",
    "providerWebsite": "https://www.ecognition.com",
    "providerLogoUrl": "https://metadata.up42.com/ee058d6b-a62c-4fc4-aaca-a1cbe2cf7d1a/Avatar16617867947471662970806282.gif",
    "tags": [
      "Segmentation",
      "Vegetation",
      "Land Use and Management"
    ],
    "parameters": {
      "VAR_SP": {
        "type": "string",
        "default": "42"
      },
      "VAR_SIMP": {
        "type": "string",
        "default": "1"
      },
      "VAR_Shape": {
        "type": "string",
        "default": "0.1"
      },
      "VAR_Compactness": {
        "type": "string",
        "default": "0.5"
      }
    },
    "type": "PROCESSING",
    "isRestricted": false,
    "isCreditPurchaseRequired": false,
    "limitStreamingDataAccess": false,
    "metadata": {
      "overview": "The Multiresolution Segmentation algorithm locally minimizes the average heterogeneity of image objects for a given resolution of image objects. This processing block, segments images with provided scale (homogeneity threshold) and exports segmented polygons as .shp file.\n\n**Use Cases**: This block can be used as an initial step in landcover, vegetation, water, urban area analysis, and change detection workflows\n\n**Supported workflows:**\n- Any projected aerial or satellite image\n\n**Input:**\n- Projected image (non-geographic coordinate system)\n- Format : GeoTiff\n- Image band : 3-5 bands (RGB+)\n  \n**Parameters:**\n- **VAR_SP - Scale parameter (default: 42):** The Scale Parameter is an abstract term that determines the maximum allowed heterogeneity for the resulting image objects. For heterogeneous data, the resulting objects for a given scale parameter will be smaller than in more homogeneous data. By modifying the value in the Scale Parameter value you can vary the size of image objects.\n- **VAR_Shape (default: 0.1, range: 0..1):** The value of the Shape field modifies the relationship between shape and color criteria. \n- **VAR_Compactness (default: 0.5, range: 0..1):** The compactness criterion is used to optimize image objects with regard to compactness. \n- **VAR_SIMP (default: 1, possible values: 0 or 1):** Flag to control how segmented image objects are exported. 0 - means polygon will follow pixel outline of the image object, 1 - means simplified/smoothed shape.\n\n**Output**:\n- The output will be a Shapefile (.shp) with 2D polygons",
      "termsAndConditionsUrl": "https://metadata.up42.com/ee058d6b-a62c-4fc4-aaca-a1cbe2cf7d1a/EULA_Trimble_MRS_final2.08.221661786879504.pdf",
      "blockThumbnailUrl": "https://metadata.up42.com/ee058d6b-a62c-4fc4-aaca-a1cbe2cf7d1a/image16617863425681662970809223.png",
      "pricingStrategy": {
        "id": "e5a29f4a-0bb8-44e3-b285-093dc2232a10",
        "displayId": "e5a29f4a",
        "createdAt": "2022-09-12T08:20:25.523405Z",
        "updatedAt": "2022-09-12T08:20:25.523405Z",
        "createdBy": {
          "id": "de807c20-faa1-4064-afe3-7aaf7c49830d",
          "type": "ADMIN"
        },
        "updatedBy": {
          "id": "de807c20-faa1-4064-afe3-7aaf7c49830d",
          "type": "ADMIN"
        },
        "type": "SQUARE_KM_INPUT",
        "credits": 200
      },
      "blockPricingStrategy": {
        "name": "simple",
        "unit": "SQUARE_KM",
        "direction": "INPUT",
        "credits": 200
      },
      "blockMarketplaceSampleData": [
        {
          "id": "ef79f20d-44f9-4a15-a639-0aff7679a691",
          "displayId": "ef79f20d",
          "createdAt": "2022-10-12T11:58:24.351036Z",
          "updatedAt": "2022-10-12T11:58:24.351036Z",
          "createdBy": {
            "id": "81a17df8-f9d5-4dc0-9918-8a4f28898ee3",
            "type": "ADMIN"
          },
          "updatedBy": {
            "id": "81a17df8-f9d5-4dc0-9918-8a4f28898ee3",
            "type": "ADMIN"
          },
          "value": "https://metadata.up42.com/ee058d6b-a62c-4fc4-aaca-a1cbe2cf7d1a/Trimble_UP4216617863538181662970817899.gif",
          "type": "IMAGE"
        },
        {
          "id": "ab6c73ae-079d-4c4f-adc7-d90143f2dbcb",
          "displayId": "ab6c73ae",
          "createdAt": "2022-10-12T11:58:24.351289Z",
          "updatedAt": "2022-10-12T11:58:24.351289Z",
          "createdBy": {
            "id": "81a17df8-f9d5-4dc0-9918-8a4f28898ee3",
            "type": "ADMIN"
          },
          "updatedBy": {
            "id": "81a17df8-f9d5-4dc0-9918-8a4f28898ee3",
            "type": "ADMIN"
          },
          "value": "https://metadata.up42.com/ee058d6b-a62c-4fc4-aaca-a1cbe2cf7d1a/Trimble_UP4216617863538181662970817899.png",
          "type": "IMAGE"
        }
      ]
    },
    "version": "1.0.3",
    "updatedAt": "2022-10-12T11:58:24.351660Z",
    "manifestVersion": 2,
    "capabilities": {
      "input": {
        "raster": {
          "up42_standard": {
            "bands": {
              "or": [
                [
                  "red",
                  "green",
                  "blue"
                ],
                [
                  "red",
                  "green",
                  "blue",
                  "nir"
                ],
                [
                  "red",
                  "green",
                  "blue",
                  "nir",
                  "pan"
                ]
              ]
            },
            "dtype": {
              "or": [
                "uint16",
                "uint8"
              ]
            },
            "format": "GTiff",
            "sensor": {
              "or": [
                "Pleiades",
                "SPOT",
                "Sentinel2",
                "Landsat8",
                "Hexagon"
              ]
            },
            "resolution": {
              "or": [
                0.15,
                0.3,
                0.5,
                1,
                1.5,
                10,
                15
              ]
            },
            "processing_level": {
              "or": [
                "l2",
                "l3"
              ]
            }
          }
        }
      },
      "output": {
        "vector": {
          "up42_standard": {
            "format": "Shapefile",
            "geometry_type": "Polygon"
          }
        }
      }
    },
    "machineTypeName": "XLARGE"
  },
  "error": null
}

The response parameters are the same as for the See a public block endpoint.