Your AI team, working in RedCircle API

RedCircle API is the real-time Target product data API for accessing Target product catalog, reviews, and category data.

Start your company

What your team can do in RedCircle API

32 tools to work with, connected with an API key.

Add Zipcodes

Tool to add zipcodes to your RedCircle API account for geolocation targeting. Use when you need to localize product searches by specific postal codes. New zipcodes take approximately 2 minutes to become available after being added.

Clear Collection Requests

Tool to remove all requests from a specified collection. Collections can only be cleared when not actively running. Use when you need to empty a collection of all its requests.

Create Collection

Tool to create a new collection for running up to 15,000 requests on a schedule. Use when you need to organize and schedule batch requests with various scheduling patterns, priority levels, and notification methods.

Create Destination

Tool to create a new destination for uploading Collection Result Sets to cloud storage. Use when you need to configure a storage destination for result sets with providers like S3, GCS, Azure, OSS, or S3-compatible storage.

Create Requests

Tool to add up to 1,000 requests to an existing collection. Use when you need to populate a collection with product requests. Collections have a maximum of 15,000 requests (100 if include_html=true). Sequential calls required; parallel requests trigger HTTP 429 errors.

Delete Collection

Tool to remove a collection from the system by ID. Use when you need to delete a collection that is not currently running.

Delete Destination

Tool to remove a destination from your RedCircle API account. Use when you need to permanently delete a specific destination by its ID.

Delete Request from Collection

Tool to remove an individual request from a collection. Use when you need to delete a specific request from a collection by providing both collection_id and request_id. Collections must not be running during deletion.

Delete Requests In Bulk

Tool to delete multiple requests from a collection in bulk. Use when you need to remove multiple requests efficiently. Note: Requests can only be deleted when the collection is not running.

Delete Zipcodes

Tool to remove zipcodes from your RedCircle API account. Use when you need to delete specific zipcode/domain pairs from your account.

Get Account InformationReads only

Tool to retrieve account information, usage metrics, and platform status. Use when you need to check account credits, limits, plan details, or platform component status.

Get CollectionReads only

Tool to retrieve complete information about a specific collection. Use when you need detailed collection metadata including status, schedule, and configuration.

Get Requests CSV LinksReads only

Tool to retrieve CSV download links for all requests in a collection. Use when you need to export request data in CSV format. Each CSV file contains up to 1000 requests.

Get Requests JSON LinksReads only

Tool to retrieve download links for all requests in a collection in JSON format. Use when you need to access request data from a specific collection. Returns paginated URLs for downloading request information.

Get Result Set CSVReads only

Retrieve a collection result set's details and CSV download links, with optional field selection using dot notation for nested fields.

Get Result Set JSONReads only

Tool to retrieve a result set in JSON format with download links. Use when you need to access processed results from a specific collection and result set. Returns detailed result information including download URLs for data files.

Get Result Set JSON LinesReads only

Tool to retrieve a result set in JSON Lines format with download links. Use when you need to access processed results as newline-delimited JSON files. JSON Lines format provides one valid JSON object per line, ideal for streaming and processing large datasets.

Get Target Product DataReads only

Request real-time Target search, product, review, or category data. The returned response models search and product details, but does not include review or category listing results.

List CategoriesReads only

Tool to retrieve all top-level (root) categories or filter results using optional parameters. Use when you need to browse the category hierarchy, search for specific categories, or retrieve category details. Parameters id, parent_id, and search_term are mutually exclusive.

List CollectionsReads only

Tool to retrieve all collections configured on your RedCircle API account with filtering and pagination. Use when you need to browse collections, filter by status or search term, or manage collection metadata.

List DestinationsReads only

Tool to retrieve all destinations configured on your RedCircle API account with pagination and filtering. Use when you need to browse or manage destination configurations. Returns 10 destinations per page.

List Error LogsReads only

Tool to list all error logs on your RedCircle API account. Use when you need to retrieve failed API request logs with error details. Results are paginated with 10 error logs per page. Supports filtering by search term and sorting by date or count.

List Requests by PageReads only

Retrieve a page of requests for a collection, with up to 1,000 requests per page. Returned request details are limited to type, TCIN, custom ID, and request ID.

List Result SetsReads only

Tool to list all result sets for a collection. Use when you need to retrieve execution history and results for a specific collection. Note: result sets have 14-day retention.

List ZipcodesReads only

Tool to retrieve all zipcodes associated with your account with optional filtering. Use when you need to list zipcodes, optionally filtered by search term or domain. Supports pagination with max 10 results per page.

Resend Webhook

Tool to resend a previously configured webhook POST request for a result set. Use when you need to debug webhook connectivity issues without re-executing the collection.

Start Collection

Tool to initiate execution of a RedCircle API collection. Use when you need to start processing requests for a collection. Requires sufficient request credits and the collection must not be currently running.

Stop All Collections

Tool to halt all currently active collections on your account. Use when you need to terminate all collection operations across your account. Collections in queued or running states are affected, resetting status to idle. Note: Queued collections receive credit refunds; running collections stop without reimbursement.

Stop Collection

Tool to halt an active collection in queued or running state. Use when you need to stop a collection that is currently processing. Collections in queued status receive full credit refunds, while running collections are stopped without refunds.

Update Collection

Tool to update an existing collection's configuration and settings. Use when you need to modify collection settings including name, schedule, priority, and destination assignments. Note: A collection can only be updated when it is not running.

Update Destination

Tool to modify an existing destination configuration on your RedCircle API account. Use when you need to update destination settings such as name, credentials, storage paths, or enable/disable status. When enabling a previously disabled destination or updating credentials, a connectivity test will be performed automatically.

Update Request

Tool to modify a request within a collection. Use only when the collection is not running. Updates request parameters like type, tcin, or other Target Product Data API fields.

More in Developer tools

See them all β†’

Your company, run by an AI team

Start your company

BRAINER

Continue to B.R.A.I.N.E.R.

Continue with Google or your email.

or