Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

shutterstock-api

Package Overview
Dependencies
Maintainers
1
Versions
68
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

shutterstock-api

The Shutterstock API provides access to Shutterstock's library of media as well as information about customers accounts and the contributors that provide the media

  • 1.0.30
  • npm
  • Socket score

Version published
Weekly downloads
3.7K
increased by68.98%
Maintainers
1
Weekly downloads
 
Created
Source

Official JavaScript SDK client for the Shutterstock API

The Shutterstock public API provides access to Shutterstock's library of media, as well as information about customers' accounts and the contributors that provide the media. This SDK provides classes for JavaScript and Node.js that you can use to access the API from your applications. These classes call the API in the same way that direct REST calls do. You can use this SDK to search for media, get information about media and about collections, and (if your subscription permits) license and download media. This is the official SDK provided by Shutterstock for its API.

  • API version: 1.0.30

References

  • For more information about the Shutterstock public API, see https://developers.shutterstock.com/documentation.
  • For reference information about the endpoints that this SDK calls, see the API reference.
  • To provide feedback or bug reports about the API and this SDK, see https://api-feedback.shutterstock.com.
  • For the status of the API, see API status.
  • For the source code, see https://github.com/shutterstock/public-api-javascript-sdk.

Subscriptions

To access the API and license media with the SDK, you need an API subscription or a free API account.

API subscriptions are separate from the subscriptions that are available on shutterstock.com. You can use an API subscription to license and download media only with the API; API subscriptions don't work on shutterstock.com. To buy an API subscription or set up a free account, see the pricing page. If you have a subscription from shutterstock.com and want to use it with the API, contact us.

Applications

To access the REST API you need an application, which represents the application, program, or computer commands that are accessing the API. To use the API, you need the application's consumer key and consumer secret, which are shown on the https://www.shutterstock.com/account/developers/apps page.

When you have the application's consumer key and consumer secret, you can use them to access the API directly or to request a token that you can use to access the API. For more information on these methods of authentication, see Authentication.

To create an application:

  1. Log in at shutterstock.com, go to your account page, and and click Developers.
  2. On the Developers page, click Create new app.
  3. On the Create New App popup, fill in these fields:
    • App name: Specify any name that describes your application.
    • Callback URL: Specify a comma-separated list of the host names (not full URLs) where your application is running. If you’ve got an application running on a server, use the host name of the server. Otherwise, leave the default host name localhost for testing purposes.
    • Referrer: If you are using referrer authentication, specify a comma-separated list of valid referrer domains. Each item in the list must match one of the callback host names. The API accepts only requests that have an HTTP Referrer header from this list. Otherwise, leave this field blank.
    • Included products: This list shows the API products that the application has access to. To get access to other products, contact your Shutterstock representative, visit the Pricing page or contact us.
    • Company name: The name of your company.
    • Website: Your company's web site.
    • Intended use: Select an option that describes how you will use the API.
    • Description: Describe in detail how the application will use the API.
    • Terms of service: Read an accept the Terms of Service.
  4. Click Save.

The new application appears on the My apps page. Each application has a consumer key and a consumer secret. You use this consumer key and consumer secret either to use the API directly with basic authentication or to request a token for OAuth authentication; see Authentication. Do not share your key and secret, because they can be used to access your account through the API.

Products

Each application has access to one or more API products. These products control the level of access that the application has to the API and the Shutterstock media library. These products are separate from the subscriptions that control how many assets you can license and download.

If you create an application without buying an API subscription first, the application uses the free API product, which is labeled as the "Self Serve" product. Applications that use this free API product can search and view media but not license or download media. If you have a paid API subscription, your applications use an API product with additional access to license and download media, within the limitations of the subscription. Other products include access to computer vision and editorial endpoints.

To tell which API products your application is using, open your applications, expand your application, and go to its Details tab.

Installation

npm or yarn

To install the SDK as a module with npm or yarn, run one of the following commands:

npm install shutterstock-api --save
yarn add shutterstock-api

Authentication

Authentication in the SDK works the same way as in the API:

All endpoints in the Shutterstock API require authentication. The API accepts HTTP basic authentication for some endpoints and OAuth authentication for all endpoints.

In the reference information for each SDK method (see Documentation for methods or the API reference, each endpoint is labeled with the types of authentication it accepts and the OAuth scopes it requires, if any. In general, HTTP basic authentication is sufficient for search queries and for getting information about pieces of media. The API requires OAuth authentication for actions that require customers to log in to shutterstock.com, such as licensing and downloading media.

For more information about authenticating to the API, see Authentication in the API reference.

Basic authentication

In HTTP basic authentication (also known as basic authentication), you pass your application's consumer key and secret key to the SDK along with the request. To get the consumer key and secret key for your application, go to https://developers.shutterstock.com/user/me/apps and open the information for your application. The following example uses the variables applicationClientId and applicationClientSecret for the application's consumer key and secret.

const sstk = require('shutterstock-api');

sstk.setBasicAuth(applicationClientId, applicationClientSecret);

const api = new sstk.ImagesApi();

OAuth authentication

In this type of authentication, you use an application and an individual user's login credentials to obtain a token. For instructions on how to get a token, see OAuth authentication on the Shutterstock developer portal.

When you have the token, use it to configure the API client as in the following example, which assumes that your token is in the environment variable SHUTTERSTOCK_API_TOKEN:

const sstk = require('shutterstock-api');

sstk.setAccessToken(process.env.SHUTTERSTOCK_API_TOKEN);

const api = new sstk.ImagesApi();

OAuth scopes

Most endpoints require an access token with one or more scopes, or permissions. You can see the scopes that each method requires in the reference information for each method.

The following list shows the available scopes.

  • licenses.create: Grant the ability to download and license media on behalf of the user.
  • purchases.view: Grant read-only access to a user's purchase history.
  • licenses.view: Grant read-only access to a user's licenses.
  • collections.edit: Grant the ability to create new collections, edit a collection, and modify the contents of a collection
  • collections.view: Grant read-only access to a collection and its contents.

Languages

You can provide search keywords in languages other than English by specifying the two-character language code in the language query parameter. If you set this parameter or header, you can also pass category names in that language. The response includes categories and keywords in that language.

For the list of languages that the API accepts, see the Language schema.

Licensing sandbox

To use the licensing sandbox API instead of the main API, use the setSandbox method. For more information on the sandbox API, see Licensing sandbox in the API reference.

const sstk = require('shutterstock-api');

sstk.setSandbox(true);

sstk.setAccessToken(process.env.SHUTTERSTOCK_API_TOKEN);

const api = new sstk.ImagesApi();

To go back to the main API, call the setSandbox method again and pass false.

sstk.setSandbox(false);

Examples

Follow the installation instructions and use the SDK in your JavaScript code as in these examples.

This example searches for images. The search parameters go in the queryParams variable. The API returns responses as JavaScript objects. The reference information for each method shows the class for the response. In this example, the callback function extracts the image ID, description, and preview link of each search result into an object.

const sstk = require('shutterstock-api');

sstk.setAccessToken(process.env.SHUTTERSTOCK_API_TOKEN);

const api = new sstk.ImagesApi();

const queryParams = {
  query: 'New York',
  sort: 'popular',
  orientation: 'horizontal'
};

api.searchImages(queryParams)
  .then(({data}) => {
    console.log(data);
  })
  .catch((error) => {
    console.error(error);
  });

The next example requests a license for an image.

For POST requests like this one, you create an object of the appropriate class to pass as the request body. In this case, the shutterstock-api.ImagesApi.licenseImages method accepts a body parameter of the class shutterstock-api.LicenseImageRequest. This parameter is an array of objects of the class shutterstock-api.LicenseImage, each of which has the ID of an image to license. The reference information for each method shows the class for the body parameter.

const sstk = require('shutterstock-api');

sstk.setAccessToken(process.env.SHUTTERSTOCK_API_TOKEN);

const api = new sstk.ImagesApi();

const imageId = '' // ID of image to license

const imageToLicense = new sstk.LicenseImage(imageId);

const body = new sstk.LicenseImageRequest([imageToLicense]);

const queryParams = {
  subscription_id: process.env.SUBSCRIPTION_ID,
  format: 'jpg',
  size: 'huge'
};

api.licenseImages(body, queryParams)
  .then(({data}) => {
    console.log(data);
  })
  .catch((error) => {
    console.error(error);
  });

Instead of using objects for the body, you can also pass a JavaScript object literal that has the data that the API expects in the body. For information about the body format, see the API reference for the related API endpoint. For example, this licensing request passes information about the images to license in a JavaScript object literal:

const sstk = require('shutterstock-api');

sstk.setAccessToken(process.env.SHUTTERSTOCK_API_TOKEN);

const imagesApi = new sstk.ImagesApi();

const body = {
  images: [
    {
      image_id: '419235589',
      price: 12.50,
      metadata: {
        customer_id: '12345'
      }
    }
  ]
};

const queryParams = {
  format: 'jpg',
  size: 'huge',
  subscription_id: process.env.SUBSCRIPTION_ID
};

imagesApi.licenseImages(body, queryParams)
  .then(({ data }) => {
    console.log(data);
  })
  .catch((error) => {
    console.error(error);
  });

Errors

The SDK returns the same errors as the API. For information about errors, see Errors in the API reference.

Handle errors in the catch() method following the SDK method. Each error includes a response object that includes an HTTP status field and a text field that has the description of the error.

For example, this example requests an image ID that does not exist. The API returns the HTTP status code 404:

const sstk = require("shutterstock-api");

sstk.setAccessToken(process.env.SHUTTERSTOCK_API_TOKEN);

const imagesApi = new sstk.ImagesApi();

imagesApi.getImage("123456789")
  .then((data) => {
    console.log(data);
  })
  .catch((error) => {
    console.error(error.response.status, error.response.text);
    // 404 '{"message":"Not Found"}'
  });

Contributing

Tests

To run the tests, you must authenticate with the Shutterstock API, get a token, and put the token in the SHUTTERSTOCK_API_TOKEN environment variable. See Authentication.

$ SHUTTERSTOCK_API_TOKEN="Your API Key"
$ yarn run test

Linting

$ yarn run lint

Documentation for methods

All URIs are relative to https://api.shutterstock.com

ClassMethodHTTP requestDescription
shutterstock-api.AudioApiaddSoundboxItemsPOST /v2/audio/collections/{id}/itemsAdd audio tracks to collections
shutterstock-api.AudioApicreateSoundboxPOST /v2/audio/collectionsCreate audio collections
shutterstock-api.AudioApideleteSoundboxDELETE /v2/audio/collections/{id}Delete audio collections
shutterstock-api.AudioApideleteSoundboxItemsDELETE /v2/audio/collections/{id}/itemsRemove audio tracks from collections
shutterstock-api.AudioApidownloadTracksPOST /v2/audio/licenses/{id}/downloadsDownload audio tracks
shutterstock-api.AudioApigetAudioLicenseListGET /v2/audio/licensesList audio licenses
shutterstock-api.AudioApigetGenresGET /v2/audio/genresList audio genres
shutterstock-api.AudioApigetInstrumentsGET /v2/audio/instrumentsList audio instruments
shutterstock-api.AudioApigetMoodsGET /v2/audio/moodsList audio moods
shutterstock-api.AudioApigetSoundboxGET /v2/audio/collections/{id}Get the details of audio collections
shutterstock-api.AudioApigetSoundboxItemsGET /v2/audio/collections/{id}/itemsGet the contents of audio collections
shutterstock-api.AudioApigetSoundboxListGET /v2/audio/collectionsList audio collections
shutterstock-api.AudioApigetTrackGET /v2/audio/{id}Get details about audio tracks
shutterstock-api.AudioApigetTrackListGET /v2/audioList audio tracks
shutterstock-api.AudioApilicenseTrackPOST /v2/audio/licensesLicense audio tracks
shutterstock-api.AudioApirenameSoundboxPOST /v2/audio/collections/{id}Rename audio collections
shutterstock-api.AudioApisearchAudioGET /v2/audio/searchSearch for tracks
shutterstock-api.ComputerVisionApigetKeywordsGET /v2/cv/keywordsList suggested keywords
shutterstock-api.ComputerVisionApigetSimilarImagesGET /v2/cv/similar/imagesList similar images
shutterstock-api.ComputerVisionApigetSimilarVideosGET /v2/cv/similar/videosList similar videos
shutterstock-api.ComputerVisionApiuploadEphemeralImagePOST /v2/imagesUpload ephemeral images
shutterstock-api.ComputerVisionApiuploadImagePOST /v2/cv/imagesUpload images
shutterstock-api.ContributorsApigetContributorGET /v2/contributors/{contributor_id}Get details about a single contributor
shutterstock-api.ContributorsApigetContributorCollectionItemsGET /v2/contributors/{contributor_id}/collections/{id}/itemsGet the items in contributors' collections
shutterstock-api.ContributorsApigetContributorCollectionsGET /v2/contributors/{contributor_id}/collections/{id}Get details about contributors' collections
shutterstock-api.ContributorsApigetContributorCollectionsListGET /v2/contributors/{contributor_id}/collectionsList contributors' collections
shutterstock-api.ContributorsApigetContributorListGET /v2/contributorsGet details about multiple contributors
shutterstock-api.EditorialImagesApigetEditorialCategoriesGET /v2/editorial/categories(Deprecated) List editorial categories
shutterstock-api.EditorialImagesApigetEditorialImageGET /v2/editorial/{id}(Deprecated) Get editorial content details
shutterstock-api.EditorialImagesApigetEditorialImageCategoriesGET /v2/editorial/images/categoriesList editorial categories
shutterstock-api.EditorialImagesApigetEditorialImageDetailsGET /v2/editorial/images/{id}Get editorial content details
shutterstock-api.EditorialImagesApigetEditorialImageLicenseListGET /v2/editorial/images/licensesList editorial image licenses
shutterstock-api.EditorialImagesApigetEditorialImageLivefeedGET /v2/editorial/images/livefeeds/{id}Get editorial livefeed
shutterstock-api.EditorialImagesApigetEditorialLivefeedGET /v2/editorial/livefeeds/{id}(Deprecated) Get editorial livefeed
shutterstock-api.EditorialImagesApigetEditorialLivefeedImageItemsGET /v2/editorial/images/livefeeds/{id}/itemsGet editorial livefeed items
shutterstock-api.EditorialImagesApigetEditorialLivefeedImagesListGET /v2/editorial/images/livefeedsGet editorial livefeed list
shutterstock-api.EditorialImagesApigetEditorialLivefeedItemsGET /v2/editorial/livefeeds/{id}/items(Deprecated) Get editorial livefeed items
shutterstock-api.EditorialImagesApigetEditorialLivefeedListGET /v2/editorial/livefeeds(Deprecated) Get editorial livefeed list
shutterstock-api.EditorialImagesApigetUpdatedImagesGET /v2/editorial/updated(Deprecated) List updated content
shutterstock-api.EditorialImagesApilicenseEditorialImagePOST /v2/editorial/licenses(Deprecated) License editorial content
shutterstock-api.EditorialImagesApilicenseEditorialImagesPOST /v2/editorial/images/licensesLicense editorial content
shutterstock-api.EditorialImagesApisearchEditorialGET /v2/editorial/search(Deprecated) Search editorial content
shutterstock-api.EditorialImagesApisearchEditorialImagesGET /v2/editorial/images/searchSearch editorial images
shutterstock-api.EditorialVideoApieditorialVideosDetailsGET /v2/editorial/videos/{id}Get editorial video content details
shutterstock-api.EditorialVideoApieditorialVideosSearchGET /v2/editorial/videos/searchSearch editorial video content
shutterstock-api.EditorialVideoApigetEditorialCategoriesGET /v2/editorial/videos/categoriesList editorial video categories
shutterstock-api.EditorialVideoApilicenseEditorialVideoPOST /v2/editorial/videos/licensesLicense editorial video content
shutterstock-api.ImagesApiaddLightboxItemsPOST /v2/images/collections/{id}/itemsAdd images to collections
shutterstock-api.ImagesApicreateLightboxPOST /v2/images/collectionsCreate image collections
shutterstock-api.ImagesApideleteLightboxDELETE /v2/images/collections/{id}Delete image collections
shutterstock-api.ImagesApideleteLightboxItemsDELETE /v2/images/collections/{id}/itemsRemove images from collections
shutterstock-api.ImagesApidownloadImagePOST /v2/images/licenses/{id}/downloadsDownload images
shutterstock-api.ImagesApigetFeaturedLightboxGET /v2/images/collections/featured/{id}Get the details of featured image collections
shutterstock-api.ImagesApigetFeaturedLightboxItemsGET /v2/images/collections/featured/{id}/itemsGet the contents of featured image collections
shutterstock-api.ImagesApigetFeaturedLightboxListGET /v2/images/collections/featuredList featured image collections
shutterstock-api.ImagesApigetImageGET /v2/images/{id}Get details about images
shutterstock-api.ImagesApigetImageCategoriesGET /v2/images/categoriesList image categories
shutterstock-api.ImagesApigetImageLicenseListGET /v2/images/licensesList image licenses
shutterstock-api.ImagesApigetImageListGET /v2/imagesList images
shutterstock-api.ImagesApigetImageRecommendationsGET /v2/images/recommendationsList recommended images
shutterstock-api.ImagesApigetImageSuggestionsGET /v2/images/search/suggestionsGet suggestions for a search term
shutterstock-api.ImagesApigetLightboxGET /v2/images/collections/{id}Get the details of image collections
shutterstock-api.ImagesApigetLightboxItemsGET /v2/images/collections/{id}/itemsGet the contents of image collections
shutterstock-api.ImagesApigetLightboxListGET /v2/images/collectionsList image collections
shutterstock-api.ImagesApigetSimilarImagesGET /v2/images/{id}/similarList similar images
shutterstock-api.ImagesApigetUpdatedImagesGET /v2/images/updatedList updated images
shutterstock-api.ImagesApilicenseImagesPOST /v2/images/licensesLicense images
shutterstock-api.ImagesApipostImageEntitiesPOST /v2/images/search/suggestionsGet keywords from text
shutterstock-api.ImagesApirenameLightboxPOST /v2/images/collections/{id}Rename image collections
shutterstock-api.ImagesApisearchImagesGET /v2/images/searchSearch for images
shutterstock-api.TestApiechoGET /v2/testEcho text
shutterstock-api.TestApivalidateGET /v2/test/validateValidate input
shutterstock-api.UsersApigetAccessTokenGET /v2/user/access_tokenGet access token details
shutterstock-api.UsersApigetUserGET /v2/userGet user details
shutterstock-api.UsersApigetUserSubsciptionListGET /v2/user/subscriptionsList user subscriptions
shutterstock-api.VideosApiaddClipboxItemsPOST /v2/videos/collections/{id}/itemsAdd videos to collections
shutterstock-api.VideosApicreateClipboxPOST /v2/videos/collectionsCreate video collections
shutterstock-api.VideosApideleteClipboxDELETE /v2/videos/collections/{id}Delete video collections
shutterstock-api.VideosApideleteClipboxItemsDELETE /v2/videos/collections/{id}/itemsRemove videos from collections
shutterstock-api.VideosApidownloadVideosPOST /v2/videos/licenses/{id}/downloadsDownload videos
shutterstock-api.VideosApigetClipboxGET /v2/videos/collections/{id}Get the details of video collections
shutterstock-api.VideosApigetClipboxItemsGET /v2/videos/collections/{id}/itemsGet the contents of video collections
shutterstock-api.VideosApigetClipboxListGET /v2/videos/collectionsList video collections
shutterstock-api.VideosApigetSimilarVideosGET /v2/videos/{id}/similarList similar videos
shutterstock-api.VideosApigetUpdatedVideosGET /v2/videos/updatedList updated videos
shutterstock-api.VideosApigetVideoGET /v2/videos/{id}Get details about videos
shutterstock-api.VideosApigetVideoCategoriesGET /v2/videos/categoriesList video categories
shutterstock-api.VideosApigetVideoLicenseListGET /v2/videos/licensesList video licenses
shutterstock-api.VideosApigetVideoListGET /v2/videosList videos
shutterstock-api.VideosApigetVideoSuggestionsGET /v2/videos/search/suggestionsGet suggestions for a search term
shutterstock-api.VideosApilicenseVideosPOST /v2/videos/licensesLicense videos
shutterstock-api.VideosApirenameClipboxPOST /v2/videos/collections/{id}Rename video collections
shutterstock-api.VideosApisearchVideosGET /v2/videos/searchSearch for videos

FAQs

Package last updated on 12 Jan 2021

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc