Public 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 that can be used in a workflow.

See public blocks

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

Request

GET /blocks HTTP/1.1
Host: api.up42.com
Authorization: Bearer {token}

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
}

Parameter	Overview
`data.id`	string The block ID.
`data.displayId`	string The block display ID.
`data.createdAt`	string The timestamp when the block was created.
`data.updatedAt`	string The timestamp when the block was last updated.
`data.createdBy`	object or null The ID and type of user that created the block.
`data.updatedBy`	object or null The ID and type of user that created the block.
`data.name`	string The block name.
`data.displayName`	string The block display name.
`data.description`	string The block description.
`data.provider`	string The block provider.
`data.type`	string The block type: `PROCESSING` `DATA`
`data.metadata`	object The block metadata.
`data.version`	string The block version.
`data.isPublic`	boolean Whether the block is public.
`data.isValid`	boolean Whether the block is valid.
`data.isRestricted`	boolean Whether the block is restricted.
`data.isAccessGranted`	boolean Whether you have access granted to this block.
`data.` `isCreditPurchaseRequired`	boolean Whether the block requires a credit purchase.
`data.tags`	array of strings A list of tags to categorize the block.
`data.isPublicVersion`	boolean Whether this is the public version of the block.
`data.manifestVersion`	integer The manifest version of the block.
	Parameters of the `data.createdBy` and `data.updatedBy` objects
`id`	string The ID of the user.
`type`	string The type of the user.
	Parameters of the `data.metadata` object
`blockThumbnailUrl`	string The URL of the block thumbnail.
`blockPricingStrategy`	object The block pricing strategy of the block.
	Parameters of the `data.metadata.blockPricingStrategy` object
`name`	string The block pricing strategy name.
`unit`	string The measurement unit for pricing: `DATA_POINT` `MEGABYTE` `MEGAPIXEL` `PIXEL` `QUANTITY` `SCENE` `SQUARE_KM` `TILE`
`direction`	string Where the block pricing is being applied: `INPUT` `OUTPUT`
`credits`	integer or float When `name=simple`. The credits charged per measurement unit.
`thresholdToCreditsMap`	object When `name=job_volume_tiered`. The credits charged per measurement unit at different job volume thresholds.

See a public block

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

Request

GET /blocks/{block_id} HTTP/1.1
Host: api.up42.com
Authorization: Bearer {token}

Response

See response example

{
  "data": {
    "id": "f73c60f6-3f3c-4120-96cf-62b8d3019346",
    "displayId": "f73c60f6",
    "createdAt": "2020-05-26T13:23:16.858Z",
    "updatedAt": "2023-07-27T11:19:53.186065Z",
    "createdBy": {
      "id": "eff16ad8-7fc3-46c7-b17b-952d7cb14afe",
      "type": "USER"
    },
    "updatedBy": {
      "id": "6bb63312-01dd-465d-976e-aabf457b27e4",
      "type": "ADMIN"
    },
    "name": "nextmapone-5m",
    "displayName": "NEXTMap 5 - Elevation Data (Streaming)",
    "description": "Provides NEXTMap 5 DSM and DTM at 5 meter resolution.",
    "containerUrl": "registry.up42.com/marketplace/nextmapone-5m:PlW95ZKM7HAEH4KZ5Vg5Z7P9Nsbb2lP7Y6GNQy2W",
    "inputCapabilities": [],
    "outputCapabilities": [],
    "provider": "Intermap",
    "providerWebsite": "https://www.intermap.com/nextmap",
    "providerLogoUrl": "https://metadata.up42.com/f73c60f6-3f3c-4120-96cf-62b8d3019346/Intermap_Logo_2019_-New_Blue1645462203646.png",
    "tags": ["Elevation"],
    "isPublic": true,
    "isPublicVersion": true,
    "isValid": true,
    "isRestricted": true,
    "isAccessGranted": true,
    "isCreditPurchaseRequired": true,
    "isLimitStreamingDataAccess": true,
    "parameters": {
      "bbox": {
        "type": "array",
        "default": null
      },
      "intersects": {
        "type": "geometry",
        "default": null
      },
      "clip_to_aoi": {
        "type": "boolean",
        "default": true
      }
    },
    "type": "DATA",
    "isDryRunSupported": true,
    "version": "2.0.5",
    "metadata": {
      "overview": "The NEXTMap 5 digital elevation model is a 3D terrain dataset by Intermap. It provides seamless data ...",
      "termsAndConditionsUrl": "https://metadata.up42.com/f73c60f6-3f3c-4120-96cf-62b8d3019346/EULA_Intermap_DATA_V51645462218668.pdf",
      "blockThumbnailUrl": "https://metadata.up42.com/f73c60f6-3f3c-4120-96cf-62b8d3019346/nextmap_thumbnail1645462208038.png",
      "pricingStrategy": {
        "id": "e668e27b-bc77-40f7-b8e8-11e6cd60fe9d",
        "displayId": "e668e27b",
        "createdAt": "2022-02-21T16:50:38.382735Z",
        "updatedAt": "2022-02-21T16:50:38.382735Z",
        "createdBy": {
          "id": "6bb63312-01dd-465d-976e-aabf457b27e4",
          "type": "ADMIN"
        },
        "updatedBy": {
          "id": "6bb63312-01dd-465d-976e-aabf457b27e4",
          "type": "ADMIN"
        },
        "type": "SQUARE_KM_OUTPUT",
        "credits": 280
      },
      "blockPricingStrategy": {
        "name": "job_volume_tiered",
        "unit": "SQUARE_KM",
        "direction": "OUTPUT",
        "thresholdToCreditsMap": {
          "0": {
            "credits": 280
          },
          "10000": {
            "credits": 250
          },
          "50000": {
            "credits": 220
          },
          "100000": {
            "credits": 200
          }
        }
      },
      "blockMarketplaceSampleData": [
        {
          "id": "c2e1ed48-a7da-439a-bd98-07dbcf059402",
          "displayId": "c2e1ed48",
          "createdAt": "2023-07-27T11:19:53.185667Z",
          "updatedAt": "2023-07-27T11:19:53.185667Z",
          "createdBy": {
            "id": "81a17df8-f9d5-4dc0-9918-8a4f28898ee3",
            "type": "ADMIN"
          },
          "updatedBy": {
            "id": "81a17df8-f9d5-4dc0-9918-8a4f28898ee3",
            "type": "ADMIN"
          },
          "value": "https://metadata.up42.com/f73c60f6-3f3c-4120-96cf-62b8d3019346/nextmap_screenshot1645462213406.png",
          "type": "IMAGE"
        }
      ]
    },
    "machineName": "XLARGE",
    "manifestVersion": 2,
    "capabilities": {
      "input": {},
      "output": {
        "raster": {
          "up42_standard": {
            "bands": ["dsm", "dtm"],
            "dtype": "float",
            "format": "GTiff",
            "resolution": 5
          }
        }
      }
    }
  },
  "error": null
}

The response parameters are the same as for the See public blocks endpoint, except for the parameters described below.

Parameter	Overview
`data.containerUrl`	string The URL of the block container.
`data.providerWebsite`	string The website of the block provider.
`data.providerLogoUrl`	string The URL of the logo of the block provider.
`data.` `isLimitStreamingDataAccess`	boolean Whether the block limits streaming data access.
`data.parameters`	object The block parameters.
`data.isDryRunSupported`	boolean Whether the block supports test queries.
`data.metadata`	object The metadata of the block.
`data.metadata.` `overview`	string The detailed overview of the block.
`data.metadata.` `termsAndConditionsUrl`	string The URL of the block terms and conditions.
`data.machineName`	string The machine type the block will use.
`data.capabilities`	object The input and output capabilities of the block.

See spatial coverage of a block

To see the spatial coverage of a specific public data block, call the /blocks/{block_id}/coverage endpoint with the specific block ID as a path parameter.

Request

GET /blocks/{block_id}/coverage HTTP/1.1
Host: api.up42.com
Authorization: Bearer {token}

Response

See response example

{
  "data": {
    "url": "https://storage.googleapis.com/coverage-area-interstellar-prod/f73c60f6-3f3c-4120-96cf-62b8d3019346/coverage.json?GoogleAccessId=backend-core@interstellar-prod-env.iam.gserviceaccount.com&Expires=1694597747&Signature=ln5iCV8hvLdbT8Upp0D4YxQ3gZSxYvlEC3qPxKiNqaiyfqTqui8iZMnadaRZOxNx9d5wan34jeglozbfQdLfMnC8gfhk%2F8g8y5KYRjw9KnaEAqHDn9NOMIQM%2BzqNxz1oJRY%2FZdCinumos0Jk1DbLKCZfdphgCFi2vMh96r2eIEAwQogW2kzZbgM%2BMItEYHI6WQBrzhucO%2F5tjna6cUnppbAjwr%2BXblPA1Ita47o32FM0USXKmLyZ0mCIvCv%2BwcwIrf0WongM%2FRizFox2VGU8M%2F72z1h72NgooAHVuMZjXOsTqmITG%2Fb5v%2BMh%2FLwvYbkuR3YDWvwHNqNsCpkRc0HMxQ%3D%3D"
  },
  "error": null
}

Parameter	Overview
`data.url`	string The URL of the block spatial coverage as a link to a GeoJSON FeatureCollection type.