Get task price

GET /tasking/v1/price

You can get a price quotation for a proposed imaging task by invoking the getTaskPrice operation from the tasking API, providing the task parameters that you intend to submit when creating the task. You need a valid contractID when requesting a price quotation with the getTaskPrice operation, because the available tasking options depend on the details of your contract.

For more details about pricing, see Pricing model.

Required parameters

The required parameters for the tasking getTaskPrice operation are specified as query parameters.

Point of interest

The center-point over which the image will be acquired. The point of interest should be specified as a valid set of earth-centered coordinates, pointOfInterest[lat] and pointOfInterest[lon] (latitude and longitude), in WGS 84 coordinates.

Imaging mode

Imaging mode defines how a satellite collects the imaging data, which affects the azimuthal length, swath width, ground resolution, and image quality of the final image.

The imaging modes described in the ICEYE Product Specification are mapped to the string value of the imagingMode parameter as follows:

Product guide image mode API imagingMode

Strip

STRIPMAP

Spot

SPOTLIGHT

Spot Extended Area

SPOTLIGHT_EXTENDED_AREA

Spot Fine

SPOTLIGHT_FINE

Spot Fine 1-look

SPOTLIGHT_FINE_1L

Spot Fine 2-looks

SPOTLIGHT_FINE_2L

Spot Fine 3-looks

SPOTLIGHT_FINE_3L

Scan

SCAN

Scan Wide

SCAN_WIDE

Dwell

SPOTLIGHT_EXTENDED_DWELL

Dwell Fine

SPOTLIGHT_EXTENDED_DWELL_FINE

Dwell Precise

SPOTLIGHT_EXTENDED_DWELL_PRECISE

Spot 1-look

SPOTLIGHT_HIGH_1L

Spot 2-looks

SPOTLIGHT_HIGH_2L

Spot Precise 1-look

SPOTLIGHT_PRECISE_1L

Spot Precise 2-looks

SPOTLIGHT_PRECISE_2L

Spot Precise 3-looks

SPOTLIGHT_PRECISE_3L
The allowed imaging modes vary by contractID.

Exclusivity

Exclusivity indicates whether the task products should be released to the public catalog or remain within the customer’s private catalog for an agreed period of time (as reflected both in the pricing and the contractual agreement).

Task exclusivity can take one of the following string values:

Exclusivity Description

PUBLIC

The task products are initially private, but are ultimately transferred (anonymously) to the ICEYE public catalog after 7 days.

PRIVATE

The task products remain private for the time period agreed in your contract with ICEYE. After the agreed time period has elapsed, the image products can be transferred (anonymously) to the ICEYE public catalog.
The exclusivity parameter is constrained by the terms of your contract, which could restrict the API operation to allow only one of the options, or allow both options. For example, if you specify PUBLIC and it is not allowed by your contract, the API operation returns the not allowed error.

Priority

The task priority specifies the priority level that applies when the scheduler has to resolve a potential conflict. In the case of a conflict, a COMMERCIAL task will always take priority over a BACKGROUND task.

Task priority can take one of the following string values:

Priority Description

BACKGROUND

The task will be scheduled if there are no conflicts, but will be removed from the schedule if a higher priority task is created in the same time window.

COMMERCIAL

The task has a higher priority than BACKGROUND (90% probability of task fulfillment). See also Accuracy of imaging time.

Defaults to the contractually agreed priority from your contract.

SLA

The service level agreement (SLA) specifies a guaranteed availability time for tasked image products. The availability time is the time elapsed between the moment a satellite finishes acquiring the raw image, and the time when the image products become available for download from ICEYE.

Availability time does not include the time required to download the product data or deliver the data to an external location.

The sla parameter can take one of the following string values:

SLA Description

SLA_8H

Promises availability of standard image products within 8 hours of the satellite acquiring the image (normal delivery priority).

SLA_3H

(COMING SOON) Promises availability of standard image products within 3 hours of the satellite acquiring the image.

Defaults to SLA_8H.

EULA

The end user license agreement (EULA) defines the terms of use for purchased SAR products, also defining how widely products can be distributed. For full details of the EULA, see the relevant terms of your contract.

The eula parameter can take one of the following string values:

EULA Description

GOVERNMENT

This EULA option should be selected by a governmental organization that has contracted directly with ICEYE or by a reseller that plans to share products with a governmental organization. Government End Users shall use Products, Derivatives and Documentation solely under Government EULA.

STANDARD

This EULA option should be selected by a commercial organization that has contracted directly with ICEYE or by a reseller that plans to share products with a commercial organization. All other End Users than Government End Users shall use Products, Derivatives and Documentation solely under Standard EULA.

Example

Request

Enter the following curl command, remembering to replace the ${VARNAME} variables with the appropriate values:

curl -G "${API_BASE_URL}/api/tasking/v1/price" \
--header "Authorization: Basic ${API_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json, application/problem+json" \
--data-urlencode "contractID=${contractID}" \
--data-urlencode "reference=Customer reference" \
--data-urlencode "pointOfInterest[lat]=32", \
--data-urlencode "pointOfInterest[lon]=35", \
--data-urlencode "acquisitionWindow={'start': '2024-05-01T00:00:00Z', 'end': '2024-05-05T00:01:00Z'}" \
--data-urlencode "imagingMode=SPOTLIGHT_EXTENDED_DWELL" \
--data-urlencode "exclusivity=PUBLIC" \
--data-urlencode "priority=COMMERCIAL" \
--data-urlencode "sla=SLA_8H" \
--data-urlencode "eula=STANDARD" \
--data-urlencode "additionalProductTypes=['SIDD', 'SICD']" \
--data-urlencode "incidenceAngle={'min': 10, 'max': 45}" \
--data-urlencode "lookSide=ANY" \
--data-urlencode "passDirection=ANY"

Response

On success, returns a 200 status code and a JSON object containing the price quotation for the proposed task specified in the request (where the price amount is expressed in the currency’s minor currency unit — see Currency units).

{
    "amount": 529199,
    "currency": "USD"
}

Errors

This section describes some common error conditions.

400 - bad request

Indicates that the request was malformed.

For more details, see Error handling.

403 - forbidden

Indicates that the request is not allowed. This can be caused by:

  • The parameters you are querying for are not allowed in your contract

  • The contract does not have a pricing model attached

Example error when a combination of request parameters is not allowed by the contract:

{
    "code": "forbidden",
    "message": "Given parameters are not allowed for the contract"
}

Verify that the combination of parameters you are tasking is allowed in your contract and pricing model. The parameters required in the pricing model (region, priority, imaging mode, SLA, exclusivity) are all considered when fetching the price of your task.

Ensure you are:

  • Allowed to task in the region your point of interest lies in.

  • Allowed to task with this priority (in this region).

  • Allowed to task with this imaging mode (with this priority, and region).

  • Allowed to task with this exclusivity (with this imaging mode, priority, and region).

Example error when the contract does not have a pricing model attached:

{
    "code": "forbidden",
    "message": "Contract now allowed to query price quotation"
}

The contract you have selected does not have a pricing model attached and cannot be used to query price. If you wish to setup a new contract with pricing information available in the APIs, please reach out to your sales representative.