@datafire/gettyimages NPM

@datafire/gettyimages

Client library for Getty Images

Installation and Usage

npm install --save @datafire/gettyimages

let gettyimages = require('@datafire/gettyimages').create({
  "Api-Key": "",
  access_token: "",
  refresh_token: "",
  client_id: "",
  client_secret: "",
  redirect_uri: ""
});

.then(data => {
  console.log(data);
});

Description

Build applications using the world's most powerful imagery

Actions

oauthCallback

Exchange the code passed to your redirect URI for an access_token

gettyimages.oauthCallback({
  "code": ""
}, context)

Input

input object
- code required string

Output

output object
- access_token string
- refresh_token string
- token_type string
- scope string
- expiration string

oauthRefresh

Exchange a refresh_token for an access_token

gettyimages.oauthRefresh(null, context)

Input

This action has no parameters

Output

output object
- access_token string
- refresh_token string
- token_type string
- scope string
- expiration string

v3.affiliates.search.images.get

gettyimages.v3.affiliates.search.images.get({}, context)

Input

input object
- Accept-Language string: Provide a header to specify the language of result values. Supported values: en-GB, de, nl, fr, en-US, it, ja, pt-PT, es, sv, ko (creative assets only), pl (creative assets only), pt-BR, zh-HK (creative assets only), zh-TW (creative assets only), ru (creative assets only), tr.
- phrase string
- style string (values: photography, vector)

Output

output AffiliateImageSearchResponse

v3.affiliates.search.videos.get

gettyimages.v3.affiliates.search.videos.get({}, context)

Input

input object
- Accept-Language string: Provide a header to specify the language of result values. Supported values: en-GB, de, nl, fr, en-US, it, ja, pt-PT, es, sv, ko (creative assets only), pl (creative assets only), pt-BR, zh-HK (creative assets only), zh-TW (creative assets only), ru (creative assets only), tr.
- phrase string

Output

output AffiliateVideoSearchResponse

v3.artists.images.get

Search for images by a photographer

gettyimages.v3.artists.images.get({}, context)

Input

input object
- Accept-Language string: Provide a header to specify the language of result values. Supported values: en-GB, de, nl, fr, en-US, it, ja, pt-PT, es, sv, ko (creative assets only), pl (creative assets only), pt-BR, zh-HK (creative assets only), zh-TW (creative assets only), ru (creative assets only), tr.
- artist_name string: Name of artist for desired images
- fields array: Comma separated list of fields. Allows restricting which fields are returned. If no fields are selected, the summary_set of fields are returned.
- page integer: Identifies page to return. Default page is 1.
- page_size integer: Specifies page size. Default page_size is 10, maximum page_size is 100.

Output

Output schema unknown

v3.artists.videos.get

Search for videos by a photographer

gettyimages.v3.artists.videos.get({}, context)

Input

input object
- Accept-Language string: Provide a header to specify the language of result values. Supported values: en-GB, de, nl, fr, en-US, it, ja, pt-PT, es, sv, ko (creative assets only), pl (creative assets only), pt-BR, zh-HK (creative assets only), zh-TW (creative assets only), ru (creative assets only), tr.
- artist_name string: Name of artist for desired images
- fields array: Comma separated list of fields. Allows restricting which fields are returned. If no fields are selected, the summary_set of fields are returned.
- page integer: Identifies page to return. Default page is 1.
- page_size integer: Specifies page size. Default page_size is 10, maximum page_size is 100.

Output

Output schema unknown

v3.asset_changes.change_sets.put

Asset Changes

Get notifications about new, updated or deleted assets.

Quickstart

You'll need an API key and an access token to use this resource.

Notifications older than 60 days will be removed from partner channels.

gettyimages.v3.asset_changes.change_sets.put({}, context)

Input

input object
- channel_id integer: Specifies the id of the channel for the asset data. Valid channel ids can be found in the results of the Get Partner Channel query.
- batch_size integer: Specifies the number of assets to return. The default is 10; maximum is 500.

Output

output AssetChanges

v3.asset_changes.change_sets.change_set_id.delete

Delete Asset Changes

Confirm asset changes acknowledges receipt of asset changes (from the PUT asset changes endpoint).

Quickstart

You'll need an API key and an access token to use this resource.

gettyimages.v3.asset_changes.change_sets.change_set_id.delete({
  "change-set-id": 0
}, context)

Input

input object
- change-set-id required integer: Specify the change-set-id associated with a transaction resource whose receipt you want to confirm.

Output

Output schema unknown

v3.asset_changes.channels.get

Get Partner Channels

Retrieves the channel data for the partner. This data can be used to populate the channel_id parameter in the Put Asset Changes query.

Quickstart

You'll need an API key and an access token to use this resource.

Partners who have a channel that has been removed should contact their sales representative to be set up again.

gettyimages.v3.asset_changes.channels.get(null, context)

Input

This action has no parameters

Output

output array
- items Channel

v3.asset_licensing.assetId.post

Endpoint for acquiring extended licenses with iStock credits for an asset.

gettyimages.v3.asset_licensing.assetId.post({
  "assetId": ""
}, context)

Input

input object
- Accept-Language string: Provide a header to specify the language of result values. Supported values: en-GB, de, nl, fr, en-US, it, ja, pt-PT, es, sv, ko (creative assets only), pl (creative assets only), pt-BR, zh-HK (creative assets only), zh-TW (creative assets only), ru (creative assets only), tr.
- assetId required string: Getty Images assetId - examples 520621493, 112301284
- body AcquireAssetLicensesRequest

Output

output AssetLicensingResponse

v3.boards.get

Get all boards that the user participates in

gettyimages.v3.boards.get({}, context)

Input

input object
- page integer: Request results starting at a page number (default is 1).
- board_relationship string (values: owned, invited): Search for boards the user owns or has been invited to as an editor.
- sort_order string (values: date_last_updated_descending, date_last_updated_ascending, name_ascending, name_decending): Sort the list of boards by last update date or name. Defaults to date_last_updated_descending.
- pageSize integer: Request number of boards to return in each page. (default is 30).

Output

output BoardList

v3.boards.post

Create a new board

gettyimages.v3.boards.post({}, context)

Input

input object
- body BoardInfo

Output

output BoardCreated

v3.boards.board_id.delete

Delete a board

gettyimages.v3.boards.board_id.delete({
  "board_id": ""
}, context)

Input

input object
- board_id required string: Specify the board to delete.

Output

Output schema unknown

v3.boards.board_id.get

Get assets and metadata for a specific board

gettyimages.v3.boards.board_id.get({
  "board_id": ""
}, context)

Input

input object
- board_id required string: Retrieve details for a specific board.

Output

output BoardDetail

v3.boards.board_id.put

Update a board

gettyimages.v3.boards.board_id.put({
  "board_id": ""
}, context)

Input

input object
- board_id required string: Specify the board to update.
- body BoardInfo

Output

Output schema unknown

v3.boards.board_id.assets.delete

Remove assets from a board

gettyimages.v3.boards.board_id.assets.delete({
  "board_id": ""
}, context)

Input

input object
- board_id required string: Specify the board to remove assets from.
- asset_ids array: List the assets to be removed from the board.

Output

Output schema unknown

v3.boards.board_id.assets.put

Add assets to a board

gettyimages.v3.boards.board_id.assets.put({
  "board_id": ""
}, context)

Input

input object
- board_id required string: Specify the board to add assets to.
- body array: List assets to add to the board.
  - items BoardAsset

Output

output AddBoardAssetsResult

v3.boards.board_id.assets.asset_id.delete

Remove an asset from a board

gettyimages.v3.boards.board_id.assets.asset_id.delete({
  "board_id": "",
  "asset_id": ""
}, context)

Input

input object
- board_id required string: Specify the board to remove an asset from.
- asset_id required string: Specify the asset to remove from the board.

Output

Output schema unknown

v3.boards.board_id.assets.asset_id.put

Add an asset to a board

gettyimages.v3.boards.board_id.assets.asset_id.put({
  "board_id": "",
  "asset_id": ""
}, context)

Input

input object
- board_id required string: Specify the board to add an asset to.
- asset_id required string: Specify the asset to add to the board. If it is already in the board's asset collection, no action is taken.

Output

Output schema unknown

v3.boards.board_id.comments.get

Get comments from a board

gettyimages.v3.boards.board_id.comments.get({
  "board_id": ""
}, context)

Input

input object
- board_id required string: Specify the board to retrieve comments from.

Output

output CommentsList

v3.boards.board_id.comments.post

Add a comment to a board

gettyimages.v3.boards.board_id.comments.post({
  "board_id": ""
}, context)

Input

input object
- board_id required string: Specify the board to add a comment to.
- body CommentRequest

Output

output CommentCreated

v3.boards.board_id.comments.comment_id.delete

Delete a comment from a board

gettyimages.v3.boards.board_id.comments.comment_id.delete({
  "board_id": "",
  "comment_id": ""
}, context)

Input

input object
- board_id required string: Specify the board containing the comment to delete.
- comment_id required string: Specify the comment to delete.

Output

Output schema unknown

v3.collections.get

Use this endpoint to retrieve collections associated with your Getty Images account. To browse available collections see our Image collections page.

You'll need an API key and access token to use this resource.

gettyimages.v3.collections.get({}, context)

Input

input object
- Accept-Language string: Provide a header to specify the language of result values. Supported values: en-GB, de, nl, fr, en-US, it, ja, pt-PT, es, sv, ko (creative assets only), pl (creative assets only), pt-BR, zh-HK (creative assets only), zh-TW (creative assets only), ru (creative assets only), tr.

Output

output CollectionsList

v3.countries.get

Returns a list of country objects that contains country name, two letter ISO abbreviation and three letter ISO abbreviation.

You'll need an API key and access token to use this resource.

gettyimages.v3.countries.get({}, context)

Input

input object
- Accept-Language string: Provide a header to specify the language of result values. Supported values: en-GB, de, nl, fr, en-US, it, ja, pt-PT, es, sv, ko (creative assets only), pl (creative assets only), pt-BR, zh-HK (creative assets only), zh-TW (creative assets only), ru (creative assets only), tr.

Output

output CountriesList

v3.customers.current.get

Returns the first, middle and last name of the authenticated user.

You'll need an API key and access token to use this resource.

Please consult our Authorization FAQ for more information on authorization tokens.

gettyimages.v3.customers.current.get({}, context)

Input

input object
- Accept-Language string: Provide a header to specify the language of result values. Supported values: en-GB, de, nl, fr, en-US, it, ja, pt-PT, es, sv, ko (creative assets only), pl (creative assets only), pt-BR, zh-HK (creative assets only), zh-TW (creative assets only), ru (creative assets only), tr.

Output

output CustomerInfoResponse

v3.downloads.get

Returns information about a customer's previously downloaded assets.

You'll need an API key and access token to use this resource.

This endpoint requires being a Getty Images customer to limit your results to only assets that you have a license to use, you need to also include an authorization token in the header of your request. Please consult our Authorization FAQ for more information on authorization tokens.

gettyimages.v3.downloads.get({}, context)

Input

input object
- Accept-Language string: Provide a header to specify the language of result values. Supported values: en-GB, de, nl, fr, en-US, it, ja, pt-PT, es, sv, ko (creative assets only), pl (creative assets only), pt-BR, zh-HK (creative assets only), zh-TW (creative assets only), ru (creative assets only), tr.
- date_from string: If specified, selects assets downloaded on or after this date. Dates should be submitted in ISO 8601 format (i.e., YYYY-MM-DD).
- date_to string: If specified, selects assets downloaded on or before this date. Dates should be submitted in ISO 8601 format (i.e., YYYY-MM-DD)
- use_time boolean: If specified, time values provided with date_to or date_from will be used. Time values should be appended to the date value in ISO 8601 format
- page integer: Identifies page to return. Default is 1.
- page_size integer: Specifies page size. Default is 30, maximum page_size is 100.
- product_type string (values: easyaccess, editorialsubscription, imagepack, premiumaccess, royaltyfreesubscription)
- company_downloads boolean: If specified, returns the list of previously downloaded images for all users in your company. Your account must be enabled for this functionality. Contact your Getty Images account rep for more information. Default is false.

Output

output GetDownloadsResponse

v3.downloads.images.id.post

Use this endpoint to generate download URLs and related data for images you are authorized to download.

Most product offerings have enforced periodic download limits such as monthly, weekly, and daily. When this operation executes, the count of allowed downloads is decremented by one for the product offering. Once the download limit is reached for a given product offering, no further downloads may be requested for that product offering until the next download period.

The download limit for a given download period is covered in your product agreement established with Getty Images.

You'll need an API key and a Resource Owner Grant or Implicit Grant access token to use this resource.

Auto Downloads

The auto_download request query parameter specifies whether to automatically download the image.

If the auto_download request query parameter is set to true, the API will return an HTTP status code 303 See Other. Your client code will need to process this response and redirect to the URI specified in the Location header to enable you to automatically download the file. The redirection workflow follows the HTTP 1.1 protocol.

Client Request:

https://api.gettyimages.com/v3/downloads/images/[asset_id]?auto_download=true

Server Response:

HTTP/1.1 303 See Other
Location: https://delivery.gettyimages.com/...

If the auto_download request query parameter is set to false, the API will return a HTTP status code 200, along with the URI in the response body which can be used to download the image.

Client Request:

https://api.gettyimages.com/v3/downloads/images/[asset_id]?auto_download=false

Server Response:

HTTP/1.1 200 OK
{
	"uri": "https://delivery.gettyimages.com/..."
}

Downloading Via the Returned URI

The URI returned by this call should be considered opaque and the format could change at any time. In order to get the filename, length or file type, the response headers must be inspected. An example response follows:

content-length: 33959979
content-type: image/jpeg
content-disposition: attachment; filename=GettyImages-1167612765.jpg

The content-disposition header must be parsed to get a usable filename.

gettyimages.v3.downloads.images.id.post({
  "id": ""
}, context)

Input

input object
- Accept-Language string: Provide a header to specify the language of result values. Supported values: en-GB, de, nl, fr, en-US, it, ja, pt-PT, es, sv, ko (creative assets only), pl (creative assets only), pt-BR, zh-HK (creative assets only), zh-TW (creative assets only), ru (creative assets only), tr.
- id required string:
- auto_download boolean:
- file_type string (values: eps, jpg)
- height string:
- product_id integer:
- product_type string (values: easyaccess, editorialsubscription, imagepack, premiumaccess, royaltyfreesubscription)
- use_team_credits boolean: Specifies whether to download the image with iStock Team Credits. Only applicable to iStock API keys authenticated with a user that has Team Credits. Blank is the same as False.
- body PremiumAccessDownloadData

Output

Output schema unknown

v3.downloads.videos.id.post

Use this endpoint to generate download URLs and related data for videos you are authorized to download.

The download limit for a given download period is covered in your product agreement established with Getty Images.

You'll need an API key and a Resource Owner Grant or Implicit Grant access token to use this resource.

Auto Downloads

The auto_download request query parameter specifies whether to automatically download the video.

Client Request:

https://api.gettyimages.com/v3/downloads/videos/[asset_id]?auto_download=true

Server Response:

HTTP/1.1 303 See Other
Location: https://delivery.gettyimages.com/...

If the auto_download request query parameter is set to false, the API will return a HTTP status code 200, along with the URI in the response body which can be used to download the video.

Client Request:

https://api.gettyimages.com/v3/downloads/videos/[asset_id]?auto_download=false

Server Response:

HTTP/1.1 200 OK
{
	"uri": "https://delivery.gettyimages.com/..."
}

Downloading Via the Returned URI

content-length: 283925783
content-type: video/quicktime
content-disposition: attachment; filename=GettyImages-690773579.mov

The content-disposition header must be parsed to get a usable filename.

gettyimages.v3.downloads.videos.id.post({
  "id": ""
}, context)

Input

input object
- Accept-Language string: Provide a header to specify the language of result values. Supported values: en-GB, de, nl, fr, en-US, it, ja, pt-PT, es, sv, ko (creative assets only), pl (creative assets only), pt-BR, zh-HK (creative assets only), zh-TW (creative assets only), ru (creative assets only), tr.
- id required string:
- auto_download boolean:
- size string: Specifies the size to be downloaded.
- product_id integer:
- use_team_credits boolean: Specifies whether to download the image with iStock Team Credits. Only applicable to iStock API keys authenticated with a user that has Team Credits. Blank is the same as False.
- body PremiumAccessDownloadData

Output

Output schema unknown

v3.events.get

This endpoint returns the detailed event metadata for all specified events. Getty Images news, sports and entertainment photographers and videographers cover editorially relevant events occurring around the world. All images or video clips produced in association with an event, are assigned the same EventID. EventIDs are part of the meta-data returned in SearchForImages Results. Only content produced under a Getty Images brand name (Getty Images News, Getty Images Sports, Getty Images Entertainment, Film Magic, Wire Image) will be consistently assigned an EventID. The Event framework may also be used to group similar content, such as "Hats from the Royal Wedding" or "Odd-ballOffbeat images of the week".

You'll need an API key and access token to use this resource.

gettyimages.v3.events.get({}, context)

Input

input object
- Accept-Language string: Provide a header to specify the language of result values. Supported values: en-GB, de, nl, fr, en-US, it, ja, pt-PT, es, sv, ko (creative assets only), pl (creative assets only), pt-BR, zh-HK (creative assets only), zh-TW (creative assets only), ru (creative assets only), tr.
- ids array: A comma separated list of event ids.
- fields array: A comma separated list of fields to return in the response.

Output

Output schema unknown

v3.events.id.get

This endpoint returns the detailed event metadata for a specified event. Getty Images news, sports and entertainment photographers and videographers cover editorially relevant events occurring around the world.
All images or video clips produced in association with an event, are assigned the same EventID. EventIDs are part of the meta-data returned in SearchForImages Results. Only content produced under a Getty Images brand name (Getty Images News, Getty Images Sports, Getty Images Entertainment, Film Magic, Wire Image) will be consistently assigned an EventID. The Event framework may also be used to group similar content, such as "Hats from the Royal Wedding" or "Odd-ballOffbeat images of the week".

You'll need an API key and access token to use this resource.

gettyimages.v3.events.id.get({
  "id": 0
}, context)

Input

input object
- Accept-Language string: Provide a header to specify the language of result values. Supported values: en-GB, de, nl, fr, en-US, it, ja, pt-PT, es, sv, ko (creative assets only), pl (creative assets only), pt-BR, zh-HK (creative assets only), zh-TW (creative assets only), ru (creative assets only), tr.
- id required integer: An event id.
- fields array: A comma separated list of fields to return in the response.

Output

Output schema unknown

v3.images.get

This endpoint returns the detailed image metadata for all specified images.

You'll need an API key and access token to use this resource.

Working with Fields Sets

Fields sets are used in the fields request parameter to receive a suite of metadata fields. The following fields sets are available:

Summary Fields Set

The summary_set query string parameter fields value represents a small batch of metadata fields that are often used to build search response results. The following fields are provided for every image in your result set when you include summary_set in your request.

{
    "images":
    [
        "artist",
        "asset_family",
        "caption",
        "collection_code",
        "collection_id",
        "collection_name",
        "license_model",
        "max_dimensions",
        "title"
    ]
}

Detail Fields Set

The detail_set query string parameter fields value represents a large batch of metadata fields that are often used to build a detailed view of images. The following fields are provided for every image in your result set when you include detail_set in your request.

{
    "images":
    [
        "allowed_use",
        "artist", 
        "artist_title", 
        "asset_family",
        "call_for_image",
        "caption", 
        "city",
        "collection_code",
        "collection_id", 
        "collection_name",
        "color_type", 
        "copyright", 
        "country", 
        "credit_line", 
        "date_created", 
        "date_submitted",
        "download_sizes", 
        "editorial_segments",
        "event_ids",
        "graphical_style",
        "license_model",
        "max_dimensions",
        "orientation",
        "product_types",
        "quality_rank",
        "referral_destinations",
        "state_province", 
        "title"
    ]
}

Display Fields Set

The display_set query string parameter fields value represents the fields that provide you with URLs for the low resolution files that are most frequently used to build a UI displaying search results. The following fields are provided for every image in your result set when you include display_set in your request.

{
    "images":
    [
        "display_sizes": 
        [
            {
                "name": "comp"
            },
            {
                "name": "preview"
            },
            {
                "name": "thumb"
            }
        ]
    ]
}

Request Usage Considerations

Specifying the "entity_details" response field can have significant performance implications. The field should be used only when necessary.

gettyimages.v3.images.get({}, context)

Input

input object
- Accept-Language string: Provide a header to specify the language of result values. Supported values: en-GB, de, nl, fr, en-US, it, ja, pt-PT, es, sv, ko (creative assets only), pl (creative assets only), pt-BR, zh-HK (creative assets only), zh-TW (creative assets only), ru (creative assets only), tr.
- ids array: Specifies one or more image ids to return. Use comma delimiter when requesting multiple ids.
- fields array: Specifies fields to return. Defaults to 'summary_set'. NOTE: Bytes returned by 'download_sizes' field are estimates.

Output

output ImagesDetailResults

v3.images.id.get

This endpoint returns the detailed image metadata for a specified image.

You'll need an API key and access token to use this resource.

Working with Fields Sets

Fields sets are used in the fields request parameter to receive a suite of metadata fields. The following fields sets are available:

Summary Fields Set

{
    "images":
    [
        "artist",
        "asset_family",
        "caption",
        "collection_code",
        "collection_id",
        "collection_name",
        "license_model",
        "max_dimensions",
        "title"
    ]
}

Detail Fields Set

{
    "images":
    [
        "allowed_use",
        "artist", 
        "artist_title", 
        "asset_family",
        "call_for_image",
        "caption", 
        "city",
        "collection_code",
        "collection_id", 
        "collection_name",
        "color_type", 
        "copyright", 
        "country", 
        "credit_line", 
        "date_created", 
        "date_submitted",
        "download_sizes", 
        "editorial_segments",
        "event_ids",
        "graphical_style",
        "license_model",
        "max_dimensions",
        "orientation",
        "product_types",
        "quality_rank",
        "referral_destinations",
        "state_province", 
        "title"
    ]
}

Display Fields Set

{
    "images":
    [
        "display_sizes": 
        [
            {
                "name": "comp"
            },
            {
                "name": "preview"
            },
            {
                "name": "thumb"
            }
        ]
    ]
}

Request Usage Considerations

Specifying the "entity_details" response field can have significant performance implications. The field should be used only when necessary.

gettyimages.v3.images.id.get({
  "id": ""
}, context)

Input

input object
- Accept-Language string: Provide a header to specify the language of result values. Supported values: en-GB, de, nl, fr, en-US, it, ja, pt-PT, es, sv, ko (creative assets only), pl (creative assets only), pt-BR, zh-HK (creative assets only), zh-TW (creative assets only), ru (creative assets only), tr.
- id required string: An image id. For more than one image please use the /v3/images endpoint.
- fields array: Specifies fields to return. Defaults to 'summary_set'. NOTE: Bytes returned by 'download_sizes' field are estimates.

Output

output ImagesDetailResults

v3.images.id.downloadhistory.get

Returns information about a customer's download history for a specific asset

gettyimages.v3.images.id.downloadhistory.get({
  "id": ""
}, context)

Input

input object
- Accept-Language string: Provide a header to specify the language of result values. Supported values: en-GB, de, nl, fr, en-US, it, ja, pt-PT, es, sv, ko (creative assets only), pl (creative assets only), pt-BR, zh-HK (creative assets only), zh-TW (creative assets only), ru (creative assets only), tr.
- id required string: An image id.
- company_downloads boolean: If specified, returns the list of previously downloaded images for all users in your company.

Output

output AssetDownloadHistoryResults

v3.images.id.same_series.get

This endpoint will provide the list of images, if any exist, from the same series as the specified creative asset id. These images are typically from the same photo shoot. This functionality will not work for editorial assets.

You'll need an API key and access token to use this resource.

Working with Fields Sets

Fields sets are used in the fields request parameter to receive a suite of metadata fields. The following fields sets are available:

Summary Fields Set

{
    "images":
    [
        "asset_family",
        "caption",
        "collection_code",
        "collection_id",
        "collection_name",
        "display_sizes": 
        [
            {
                "name": "thumb"
            }
        ]
        "license_model",
        "max_dimensions",
        "title"
    ]
}

Detail Fields Set

{
    "images":
    [
        "allowed_use",
        "artist",
        "asset_family",
        "call_for_image",
        "caption",
        "collection_code",
        "collection_id",
        "collection_name",
        "copyright",
        "date_created",
        "display_sizes": 
        [
            {
                "name": "comp"
            },
            {
                "name": "preview"
            },
            {
                "name": "thumb"
            }
        ],
        "editorial_segments",
        "event_ids",
        "graphical_style",
        "license_model",
        "max_dimensions",
        "orientation",
        "product_types",
        "quality_rank",
        "referral_destinations",
        "title"
    ]
}

Display Fields Set

{
    "images":
    [
        "display_sizes": 
        [
            {
                "name": "comp"
            },
            {
                "name": "preview"
            },
            {
                "name": "thumb"
            }
        ]
    ]
}

gettyimages.v3.images.id.same_series.get({
  "id": ""
}, context)

Input

input object
- Accept-Language string: Provide a header to specify the language of result values. Supported values: en-GB, de, nl, fr, en-US, it, ja, pt-PT, es, sv, ko (creative assets only), pl (creative assets only), pt-BR, zh-HK (creative assets only), zh-TW (creative assets only), ru (creative assets only), tr.
- id required string: Identifies an existing image
- fields array: Specifies fields to return. Defaults to 'summary_set'.
- page integer: Identifies page to return. Default is 1.
- page_size integer: Specifies page size. Default is 30, maximum page_size is 100.

Output

output ImageSearchItemSearchResults

v3.images.id.similar.get

This endpoint will provide a list of images that are similar to the specified asset id.

You'll need an API key and access token to use this resource.

Working with Fields Sets

Fields sets are used in the fields request parameter to receive a suite of metadata fields. The following fields sets are available:

Summary Fields Set

{
    "images":
    [
        "asset_family",
        "caption",
        "collection_code",
        "collection_id",
        "collection_name",
        "display_sizes": 
        [
            {
                "name": "thumb"
            }
        ]
        "license_model",
        "max_dimensions",
        "title"
    ]
}

Detail Fields Set

{
    "images":
    [
        "allowed_use",
        "artist",
        "asset_family",
        "call_for_image",
        "caption",
        "collection_code",
        "collection_id",
        "collection_name",
        "copyright",
        "date_created",
        "display_sizes": 
        [
            {
                "name": "comp"
            },
            {
                "name": "preview"
            },
            {
                "name": "thumb"
            }
        ],
        "editorial_segments",
        "event_ids",
        "graphical_style",
        "license_model",
        "max_dimensions",
        "orientation",
        "product_types",
        "quality_rank",
        "referral_destinations",
        "title"
    ]
}

Display Fields Set

{
    "images":
    [
        "display_sizes": 
        [
            {
                "name": "comp"
            },
            {
                "name": "preview"
            },
            {
                "name": "thumb"
            }
        ]
    ]
}

gettyimages.v3.images.id.similar.get({
  "id": ""
}, context)

Input

input object
- Accept-Language string: Provide a header to specify the language of result values. Supported values: en-GB, de, nl, fr, en-US, it, ja, pt-PT, es, sv, ko (creative assets only), pl (creative assets only), pt-BR, zh-HK (creative assets only), zh-TW (creative assets only), ru (creative assets only), tr.
- id required string: Identifies an existing image
- fields array: Specifies fields to return. Defaults to 'summary_set'.
- page integer: Identifies page to return. Default is 1.
- page_size integer: Specifies page size. Default is 30, maximum page_size is 100.

Output

output ImageSearchItemSearchResults

v3.orders.id.get

This endpoint returns detailed order metadata for a specified order. Use of this endpoint requires configuration changes to your API key.

You'll need an API key and access token to use this resource.

gettyimages.v3.orders.id.get({
  "id": 0
}, context)

Input

input object
- Accept-Language string: Provide a header to specify the language of result values. Supported values: en-GB, de, nl, fr, en-US, it, ja, pt-PT, es, sv, ko (creative assets only), pl (creative assets only), pt-BR, zh-HK (creative assets only), zh-TW (creative assets only), ru (creative assets only), tr.
- id required integer: An order id.

Output

output OrderDetail

v3.products.get

This endpoint returns all products available to the username used during authentication. As such, this endpoint requires the use of a fully authorized access_token. The product data can then be used as search filters, restricting results to images from a specific product.

You'll need an API key and access token to use this resource.

gettyimages.v3.products.get({}, context)

Input

input object
- Accept-Language string: Provide a header to specify the language of result values. Supported values: en-GB, de, nl, fr, en-US, it, ja, pt-PT, es, sv, ko (creative assets only), pl (creative assets only), pt-BR, zh-HK (creative assets only), zh-TW (creative assets only), ru (creative assets only), tr.
- fields array: Comma separated list of fields. Allows product download requirements to be returned.

Output

output ProductsResult

v3.purchased_assets.get

This endpoint returns a list of all assets purchased on gettyimages.com by the username used for authentication. Use of this endpoint requires configuration changes to your API key. Please contact your sales representative to learn more.

You'll need an API key and access token to use this resource.

gettyimages.v3.purchased_assets.get({}, context)

Input

input object
- Accept-Language string: Provide a header to specify the language of result values. Supported values: en-GB, de, nl, fr, en-US, it, ja, pt-PT, es, sv, ko (creative assets only), pl (creative assets only), pt-BR, zh-HK (creative assets only), zh-TW (creative assets only), ru (creative assets only), tr.
- date_to string: If specified, retrieves previous purchases on or before this date. Dates should be submitted in ISO 8601 format (i.e., YYYY-MM-DD).
- page integer: Identifies page to return. Default is 1.
- page_size integer: Specifies page size. Default is 75, maximum page_size is 100.
- date_from string: If specified, retrieves previous purchases on or after this date. Dates should be submitted in ISO 8601 format (i.e., YYYY-MM-DD).
- company_purchases boolean: If specified, returns the list of previously purchased assets for all users in your company. Your account must be enabled for this functionality. Contact your Getty Images account rep for more information. Default is false.

Output

output PreviousAssetPurchases

v3.search.events.get

Use this endpoint to search Getty Images news, sports and entertainment events. Getty Images photographers and videographers cover editorially relevant events occurring around the world. All images or video clips produced in association with an event, are assigned the same EventID. EventIDs are part of the meta-data returned in Search Results. Only content produced under a Getty Images brand name (Getty Images News, Getty Images Sports, Getty Images Entertainment, Film Magic, Wire Image) will be consistently assigned an EventID. The Event framework may also be used to group similar content, such as "Hats from the Royal Wedding" or "Odd-ballOffbeat images of the week".

You'll need an API key and access token to use this resource.

You can show different information in the response by specifying values on the "fields" parameter (see details below). You can search with only an API key, and that will give you search results that are equivalent to doing a search on the GettyImages.com site without being logged in (anonymous search). If you are a Getty Images API customer and would like to ensure that your API searches return only assets that you have a license to use, you need to also include an authorization token in the header of your request. Please consult our Authorization FAQ for more information on authorization tokens, and our Authorization Workflows for code examples of getting a token.

gettyimages.v3.search.events.get({}, context)

Input

input object
- Accept-Language string: Provide a header to specify the language of result values. Supported values: en-GB, de, nl, fr, en-US, it, ja, pt-PT, es, sv, ko (creative assets only), pl (creative assets only), pt-BR, zh-HK (creative assets only), zh-TW (creative assets only), ru (creative assets only), tr.
- editorial_segment string (values: archival, entertainment, news, publicity, royalty, sport)
- date_from string: Filters to events that start on or after this date. Use ISO 8601 format (e.g., 1999-12-31). Defaults to UTC unless otherwise specified.
- date_to string: Filters to events that start on or before this date. Use ISO 8601 format (e.g., 1999-12-31). Defaults to UTC unless otherwise specified.
- fields array: Specifies fields to return. Default set is 'id','name','start_date'.
- page integer: Request results starting at a page number (default is 1, maximum is 50).
- page_size integer: Request number of images to return in each page.
- phrase string: Filters to events related to this phrase

Output

output EventsSearchResult

v3.search.images.get

Use this endpoint to search over a blend of our contemporary stock photos, illustrations, archival images, editorial photos, illustrations and archival images. Because this draws from such a large diversity of content, the results will not be as relevant as when the more specific Creative or Editorial endpoints are used. Additionally, the response time for this endpoint is slower compared to that for Creative and Editorial-specific endpoints. For these reasons, it is highly recommended that those endpoints are used instead of this blended endpoint.

You'll need an API key and access token to use this resource.

-H "Authorization: Bearer <your-token>"

Working with Fields Sets

Fields sets are used in the fields request parameter to receive a suite of metadata fields. The following fields sets are available:

Summary Fields Set

{
    "images": 
    [
        "asset_family",
        "caption",
        "collection_code",
        "collection_id",
        "collection_name",
        "display_sizes": 
        [
            {
                "name": "thumb"
            }
        ],
        "license_model",
        "max_dimensions",
        "title"
    ]
}

Detail Fields Set

{
    "images": 
    [
        "allowed_use",
        "artist",
        "asset_family",
        "call_for_image",
        "caption",
        "collection_code",
        "collection_id",
        "collection_name",
        "copyright",
        "date_created",
        "display_sizes": 
        [
            {
                "name": "comp"
            },
            {
                "name": "preview"
            },
            {
                "name": "thumb"
            }
        ],
        "editorial_segments",
        "event_ids",
        "graphical_style",
        "license_model",
        "max_dimensions",
        "orientation",
        "product_types",
        "quality_rank",
        "referral_destinations",
        "title"
    ]
]

Display Fields Set

{
    "images": 
    [
        "display_sizes": 
        [
            {
                "name": "comp"
            },
            {
                "name": "preview"
            },
            {
                "name": "thumb"
            }
        ]
    ]
}

Request Usage Considerations

Specifying the "entity_details" response field can have significant performance implications. The field should be used only when necessary.

gettyimages.v3.search.images.get({}, context)

Input

input object
- Accept-Language string: Provide a header to specify the language of result values. Supported values: en-GB, de, nl, fr, en-US, it, ja, pt-PT, es, sv, ko (creative assets only), pl (creative assets only), pt-BR, zh-HK (creative assets only), zh-TW (creative assets only), ru (creative assets only), tr.
- age_of_people array: Filter based on the age of individuals in an image.
- artists string: Search for images by specific artists (free-text, comma-separated list of artists).
- collection_codes array: Filter by collection codes (comma-separated list). Include or exclude based on collections_filter_type.
- collections_filter_type string (values: include, exclude)
- color string: Filter based on predominant color in an image. Use 6 character hexidecimal format (e.g., #002244). Note: when specified, results will not contain editorial images.
- compositions array: Filter based on image composition.
- download_product string: Filters based on which product the asset will download against.
- embed_content_only boolean: Restrict search results to embeddable images. The default is false.
- event_ids array: Filter based on specific events
- ethnicity array: Filter search results based on the ethnicity of individuals in an image.
- exclude_nudity boolean: Excludes images containing nudity. The default is false.
- fields array: Specifies fields to return. Defaults to 'summary_set'.
- file_types array: Return only images having a specific file type.
- graphical_styles array: Filter based on graphical style of the image.
- graphical_styles_filter_type string (values: include, exclude)
- include_related_searches boolean: Specifies whether or not to include related searches in the response. The default is false.
- keyword_ids array: Return only images tagged with specific keyword(s). Specify using a comma-separated list of keyword Ids. If keyword Ids and phrase are both specified, only those images matching the query phrase which also contain the requested keyword(s) are returned.
- minimum_size string (values: x_small, small, medium, large, x_large, xx_large, vector)
- number_of_people array: Filter based on the number of people in the image.
- orientations array: Return only images with selected aspect ratios.
- page integer: Request results starting at a page number (default is 1).
- page_size integer: Request number of images to return in each page.
- phrase string: Search images using a search phrase.
- sort_order string (values: best_match, most_popular, newest, random)
- specific_people array: Return only images associated with specific people (using a comma-delimited list).

Output

output ImageSearchItemSearchResults

v3.search.images.creative.get

Use this endpoint to search our contemporary stock photos, illustrations and archival images.

You'll need an API key and access token to use this resource.

Working with Fields Sets

Fields sets are used in the fields request parameter to receive a suite of metadata fields. The following fields sets are available:

Summary Fields Set

{
    "images": 
    [
        "asset_family",
        "caption",
        "collection_code",
        "collection_id",
        "collection_name",
        "display_sizes": 
        [
            {
                "name": "thumb"
            }
        ],
        "license_model",
        "max_dimensions",
        "title"
    ]
}

Detail Fields Set

{
    "images": 
    [
        "allowed_use",
        "artist",
        "asset_family",
        "call_for_image",
        "caption",
        "collection_code",
        "collection_id",
        "collection_name",
        "copyright",
        "date_created",
        "display_sizes": 
        [
            {
                "name": "comp"
            },
            {
                "name": "preview"
            },
            {
                "name": "thumb"
            }
        ],
        "editorial_segments",
        "event_ids",
        "graphical_style",
        "license_model",
        "max_dimensions",
        "orientation",
        "product_types",
        "quality_rank",
        "referral_destinations",
        "title"
    ]
]

Display Fields Set

{
    "images": 
    [
        "display_sizes": 
        [
            {
                "name": "comp"
            },
            {
                "name": "preview"
            },
            {
                "name": "thumb"
            }
        ]
    ]
}

gettyimages.v3.search.images.creative.get({}, context)

Input

input object
- Accept-Language string: Provide a header to specify the language of result values. Supported values: en-GB, de, nl, fr, en-US, it, ja, pt-PT, es, sv, ko (creative assets only), pl (creative assets only), pt-BR, zh-HK (creative assets only), zh-TW (creative assets only), ru (creative assets only), tr.
- age_of_people array: Filter based on the age of individuals in an image.
- artists string: Search for images by specific artists (free-text, comma-separated list of artists).
- collection_codes array: Filter by collection codes (comma-separated list). Include or exclude based on collections_filter_type.
- collections_filter_type string (values: include, exclude)
- color string: Filter based on predominant color in an image. Use 6 character hexidecimal format (e.g., #002244).
- compositions array: Filter based on image composition.
- download_product string: Filters based on which product the asset will download against.
- embed_content_only boolean: Restrict search results to embeddable images. The default is false.
- ethnicity array: Filter search results based on the ethnicity of individuals in an image.
- exclude_nudity boolean: Excludes images containing nudity. The default is false.
- exclude_editorial_use_only boolean: Exclude images that are only available for editorial (non-commercial) use. Default value is false.
- fields array: Specifies fields to return. Defaults to 'summary_set'.
- file_types array: Return only images having a specific file type.
- graphical_styles array: Filter based on graphical style of the image.
- graphical_styles_filter_type string (values: include, exclude)
- include_related_searches boolean: Specifies whether or not to include related searches in the response. The default is false.
- keyword_ids array: Return only images tagged with specific keyword(s). Specify using a comma-separated list of keyword Ids. If keyword Ids and phrase are both specified, only those images matching the query phrase which also contain the requested keyword(s) are returned.
- minimum_size string (values: x_small, small, medium, large, x_large, xx_large, vector)
- number_of_people array: Filter based on the number of people in the image.
- orientations array: Return only images with selected aspect ratios.
- page integer: Request results starting at a page number (default is 1).
- page_size integer: Request number of images to return in each page.
- phrase string: Search images using a search phrase.
- sort_order string (values: best_match, most_popular, newest, random)
- facet_fields array: Specifies the facets to return in the response. Facets provide additional search parameters to refine your results.
- include_facets boolean: Specifies whether or not to include facets in the result set. Default is "false".
- facet_max_count integer: Specifies the maximum number of facets to return per type. Default is 300.

Output

output CreativeImageSearchResults

v3.search.images.creative.by_image.get

Allows searching for similar creative images by passing the URL to an existing image.

Before calling the search by image endpoint, an image must be uploaded to a specific AWS S3 bucket. The bucket name is search-by-image.s3.amazonaws.com. For example, using cURL:

curl -i -X PUT https://search-by-image.s3.amazonaws.com/my-test-image.jpg -H "Content-Type: image/jpeg" --data-binary "@testimage.jpg"

Uploads can be overwritten if the names are the same, so using a prefix like the API Key, application name or company name is recommended. Uploads will expire from the bucket after 24 hours.

Once the image has been uploaded, use the full URL in the image_url parameter, e.g. image_url=https://search-by-image.s3.amazonaws.com/my-test-image.jpg.

gettyimages.v3.search.images.creative.by_image.get({}, context)

Input

input object
- Accept-Language string: Provide a header to specify the language of result values. Supported values: en-GB, de, nl, fr, en-US, it, ja, pt-PT, es, sv, ko (creative assets only), pl (creative assets only), pt-BR, zh-HK (creative assets only), zh-TW (creative assets only), ru (creative assets only), tr.
- image_url string: Specifies the location of the image to use in the search.
- image_fingerprint string: CURRENTLY HAS NO EFFECT
- fields array: Specifies fields to return. Defaults to 'summary_set'.
- product_types array: Filter images to those from one of your product types.
- page integer: Request results starting at a page number (default is 1).
- page_size integer: Request number of images to return in each page.
- facet_fields array: Specifies the facets to return in the response. Facets provide additional search parameters to refine your results.
- facet_max_count integer: Specifies the maximum number of facets to return per type. Default is 300.
- include_facets boolean: Specifies whether or not to include facets in the result set. Default is "false".

Output

output SearchByImageResourceResults

v3.search.images.editorial.get

Use this endpoint to search our editorial stock photos, illustrations and archival images. Editorial images represent newsworthy events or illustrate matters of general interest, such as news, sport and entertainment and are generally intended for editorial use.

You'll need an API key and access token to use this resource.

-H "Authorization: Bearer <your-token>"

Working with Fields Sets

Fields sets are used in the fields request parameter to receive a suite of metadata fields. The following fields sets are available:

Summary Fields Set

{
    "images": 
    [
        "asset_family",
        "caption",
        "collection_code",
        "collection_id",
        "collection_name",
        "display_sizes": 
        [
            {
                "name": "thumb"
            }
        ],
        "license_model",
        "max_dimensions",
        "title"
    ]
}

Detail Fields Set

{
    "images": 
    [
        "allowed_use",
        "artist",
        "asset_family",
        "call_for_image",
        "caption",
        "collection_code",
        "collection_id",
        "collection_name",
        "copyright",
        "date_created",
        "display_sizes": 
        [
            {
                "name": "comp"
            },
            {
                "name": "preview"
            },
            {
                "name": "thumb"
            }
        ],
        "editorial_segments",
        "event_ids",
        "graphical_style",
        "license_model",
        "max_dimensions",
        "orientation",
        "product_types",
        "quality_rank",
        "referral_destinations",
        "title"
    ]
]

Display Fields Set

{
    "images": 
    [
        "display_sizes": 
        [
            {
                "name": "comp"
            },
            {
                "name": "preview"
            },
            {
                "name": "thumb"
            }
        ]
    ]
}

Request Usage Considerations

Specifying the "entity_details" response field can have significant performance implications. The field should be used only when necessary.

gettyimages.v3.search.images.editorial.get({}, context)

Input

input object
- Accept-Language string: Provide a header to specify the language of result values. Supported values: en-GB, de, nl,

datafire

@infinitebrahmanuniverse/nolb-_datafire_g @everything-registry/sub-chunk-221 @zalastax/nolb-_datafire_g

5 years ago

7 years ago

7 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

9 years ago

9 years ago