Figshare item search API
Use the Figshare item search API to retrieve research-output metadata, persistent identifiers and linked materials. Search public research items with bibliographic, category, institution and date filters, then compare the returned DOI and item links; searches page through the first 5,000 results. Inspect a research output’s metadata and linked materials, retain persistent identifiers, or connect supporting files to a publication. Record metadata and file manifests identify research materials, while linked files remain separate resources with their own access conditions. The detail page provides request and response examples, supported parameters, and usage pricing.
- Selected price
- $0.002 / billing creditPublished pricing
- Sellers / implementations
- 1 / 1
- Requests · 30d
- —Loading...
- Success rate · 30d
- —Loading...
| Seller | Pricing | Requests · 30d | Performance | Access |
|---|---|---|---|---|
apishCurrent Figshare item search API · GET · View API reference | $0.002 / billing credit | — | —successP50— |
Run sends a real API request. Charges follow the published API contract.
Response structure
applied_filtersobjectsearch_forstring
cachedbooleancountintegercredits_usedintegeritems(object | string)[]api_urlstringcreated_datestringdoinull | stringgroup_idintegerhandlestring | nullidintegermodified_datestringonline_datenullposted_datestringproject_idnullpublished_datestringresource_doinullresource_titlenullthumbnailstring | nulltitlestringtypestringtype_idintegerurlstring
next_pageintegerpageintegerquerystring
// Inferred from response examples. Fields are optional and other fields may be returned.
export type ApiResponse = {
applied_filters?: {
search_for?: string;
};
cached?: boolean;
count?: number;
credits_used?: number;
items?: Array<{
api_url?: string;
created_date?: string;
doi?: null | string;
group_id?: number;
handle?: string | null;
id?: number;
modified_date?: string;
online_date?: null;
posted_date?: string;
project_id?: null;
published_date?: string;
resource_doi?: null;
resource_title?: null;
thumbnail?: string | null;
title?: string;
type?: string;
type_id?: number;
url?: string;
} | string>;
next_page?: number;
page?: number;
query?: string;
};- Method
- GET
- Endpoint
https://api.openany.si/v1/agent-apis/apish/figshare/v1/search- Content type
- application/json
- Authentication
Authorization: Bearer $OPENANY_API_KEY
curl \
'https://api.openany.si/v1/agent-apis/apish/figshare/v1/search?output=json&q=climate' \
-X GET \
-H "Authorization: Bearer $OPENANY_API_KEY" \
-H 'Content-Type: application/json'Input parameters
Fields in this listing; additional options and input encoding can vary by provider.
| Parameter | Location | Type | Required | Description |
|---|---|---|---|---|
q | URL query parametersquery | string | No | Search words. |
type | URL query parametersquery | string | No | Item type: figure, media, dataset, poster, journal_contribution, presentation, thesis, code, online_resource, preprint, book, conference_contribution. |
title | URL query parametersquery | string | No | Words in the title. |
author | URL query parametersquery | string | No | Author name, e.g. `Antonio Trabucco`. |
tag | URL query parametersquery | string | No | Tag/keyword. |
description | URL query parametersquery | string | No | Words in the description. |
category | URL query parametersquery | string | No | Category name, e.g. `Ecology` (see `/figshare/v1/vocabulary?type=categories`). |
doi | URL query parametersquery | string | No | Exact DOI. |
institution | URL query parametersquery | integer | No | Figshare institution id. |
group | URL query parametersquery | integer | No | Figshare group id. |
published_since | URL query parametersquery | string | No | Published on or after (YYYY-MM-DD). |
modified_since | URL query parametersquery | string | No | Modified on or after (YYYY-MM-DD). |
sort | URL query parametersquery | string | No | Order field (default relevance). enum: "published_date", "modified_date", "created_date", "views", "downloads", "shares", "cites" |
order | URL query parametersquery | string | No | Order direction with `sort`. enum: "desc", "asc" |
limit | URL query parametersquery | integer | No | Results per page (default 20, max 100). |
page | URL query parametersquery | integer | No | Page number, from 1. |
resource_doi | URL query parametersquery | string | No | DOI of the paper the items belong to. |
raw | URL query parametersquery | string | No | 0 leaves out the bulky `raw` source blocks (often 10-30x smaller). enum: "0", "1" |
fields | URL query parametersquery | string | No | Comma-separated fields to return, e.g. `posts.id,posts.title`. Call metadata is always included. |
fresh | URL query parametersquery | string | No | 1 skips the 24-hour cache and fetches live. enum: "1" |
output | URL query parametersquery | string | No | JSON only for this OpenAny product. Omit output or use json; CSV and NDJSON exports are not exposed. enum: "json" |
records | URL query parametersquery | string | No | Native CSV/NDJSON record selector; it has no effect on this JSON-only product. |
Required markers inside a nested object or variant apply when that object or variant is used.
Sample response
Sample response · Documented HTTP 200 Example from the provider's documentation. Field values in your results will differ.
{
"applied_filters": {
"search_for": "climate"
},
"cached": false,
"count": 20,
"credits_used": 1,
"items": [
{
"api_url": "https://api.figshare.com/v2/articles/34913091",
"created_date": "2026-11-06T09:08:29Z",
"doi": null,
"group_id": 49157,
"handle": "10779/uos.34913091.v1",
"id": 34913091,
"modified_date": "2026-11-06T09:08:29Z",
"online_date": null,
"posted_date": "2026-11-06T09:08:29",
"project_id": null,
"published_date": "2026-11-06T09:08:29Z",
"resource_doi": null,
"resource_title": null,
"thumbnail": "https://s3-eu-west-1.amazonaws.com/ppreviews-sussex-2810539038573/71081025/thumb.png",
"title": "Utility of sub-seasonal to seasonal onset forecasts in agricultural decision making",
"type": "thesis",
"type_id": 8,
"url": "https://sussex.figshare.com/articles/thesis/Utility_of_sub-seasonal_to_seasonal_onset_forecasts_in_agricultural_decision_making/34913091"
},
{
"api_url": "https://api.figshare.com/v2/articles/34935948",
"created_date": "2026-11-06T08:14:02Z",
"doi": "10.6084/m9.figshare.34935948.v1",
"group_id": 0,
"handle": null,
"id": 34935948,
"modified_date": "2026-11-06T08:14:03Z",
"online_date": null,
"posted_date": "2026-11-06T08:14:02",
"project_id": null,
"published_date": "2026-11-06T08:14:02Z",
"resource_doi": null,
"resource_title": null,
"thumbnail": null,
"title": "Replication Data for <i>Financing the Capacity to Qualify: Project Preparation and Investment Awards in African Climate Finance</i>",
"type": "dataset",
"type_id": 3,
"url": "https://figshare.com/articles/dataset/Replication_Data_for_i_Financing_the_Capacity_to_Qualify_Project_Preparation_and_Investment_Awards_in_…"
},
"… 18 more"
],
"next_page": 2,
"page": 1,
"query": "climate"
}Composite rule pricing
Calculated from input parameters and actual returned quantities. Estimate the maximum cost before calling.
Base fee: $0.000000. One matching variant replaces the base fee. Matching add-ons and quantity charges are added.
| Fee item | Price | Metering source | When | Quantity limit |
|---|---|---|---|---|
| Actual API.SH credits consumed | $0.002000 / billing credit | Response · /credits_used · Numeric value | Always | 1 billing credit · Decimal places: 0 |
Each quantity charge is rounded before summing: ceil. Requests exceeding this cost limit are rejected; it is not a price cap: $0.002000.
Response quantities settle after the response. Before execution, the maximum quantity determines the reservation; unused reservation is released. Missing or invalid quantities are not treated as zero.
Pricing parameters and defaults
[]
Agent integration
Copy the resource contract without sharing an API key.
View API Markdown
# Figshare item search API
Use the Figshare item search API to retrieve research-output metadata, persistent identifiers and linked materials. Search public research items with bibliographic, category, institution and date filters, then compare the returned DOI and item links; searches page through the first 5,000 results. Inspect a research output’s metadata and linked materials, retain persistent identifiers, or connect supporting files to a publication. Record metadata and file manifests identify research materials, while linked files remain separate resources with their own access conditions. The detail page provides request and response examples, supported parameters, and usage pricing.
Documentation: https://openany.si/apis/77a3e86c-2bc7-4cc3-9357-3067549ee9b7
Method: GET
Endpoint: https://api.openany.si/v1/agent-apis/apish/figshare/v1/search
Price: $0.002 / billing credit
Provider: apish
Contract revision: 2
Price source: OpenAny public API contract and documented provider unit rates. Price update time: not supplied.
Use OPENANY_API_KEY from the environment. API Key calls use your shared balance.
## Prepared request
```bash
curl \
'https://api.openany.si/v1/agent-apis/apish/figshare/v1/search?output=json&q=climate' \
-X GET \
-H "Authorization: Bearer $OPENANY_API_KEY" \
-H 'Content-Type: application/json'
```
## API contract
```json
{
"resource_type": "api",
"name": "Figshare item search API",
"endpoint": "https://api.openany.si/v1/agent-apis/apish/figshare/v1/search",
"method": "GET",
"content_type": "none",
"execution_mode": "sync",
"authentication": {
"type": "bearer",
"environment_variable": "OPENANY_API_KEY"
},
"inputs": [
{
"description": "Search words.",
"location": "query",
"name": "q",
"nullable": false,
"required": false,
"type": "string"
},
{
"description": "Item type: figure, media, dataset, poster, journal_contribution, presentation, thesis, code, online_resource, preprint, book, conference_contribution.",
"location": "query",
"name": "type",
"nullable": false,
"required": false,
"type": "string"
},
{
"description": "Words in the title.",
"location": "query",
"name": "title",
"nullable": false,
"required": false,
"type": "string"
},
{
"description": "Author name, e.g. `Antonio Trabucco`.",
"location": "query",
"name": "author",
"nullable": false,
"required": false,
"type": "string"
},
{
"description": "Tag/keyword.",
"location": "query",
"name": "tag",
"nullable": false,
"required": false,
"type": "string"
},
{
"description": "Words in the description.",
"location": "query",
"name": "description",
"nullable": false,
"required": false,
"type": "string"
},
{
"description": "Category name, e.g. `Ecology` (see `/figshare/v1/vocabulary?type=categories`).",
"location": "query",
"name": "category",
"nullable": false,
"required": false,
"type": "string"
},
{
"description": "Exact DOI.",
"location": "query",
"name": "doi",
"nullable": false,
"required": false,
"type": "string"
},
{
"description": "Figshare institution id.",
"location": "query",
"name": "institution",
"nullable": false,
"required": false,
"type": "integer"
},
{
"description": "Figshare group id.",
"location": "query",
"name": "group",
"nullable": false,
"required": false,
"type": "integer"
},
{
"description": "Published on or after (YYYY-MM-DD).",
"location": "query",
"name": "published_since",
"nullable": false,
"required": false,
"type": "string"
},
{
"description": "Modified on or after (YYYY-MM-DD).",
"location": "query",
"name": "modified_since",
"nullable": false,
"required": false,
"type": "string"
},
{
"description": "Order field (default relevance).",
"enum_values": [
"published_date",
"modified_date",
"created_date",
"views",
"downloads",
"shares",
"cites"
],
"location": "query",
"name": "sort",
"nullable": false,
"required": false,
"type": "string"
},
{
"description": "Order direction with `sort`.",
"enum_values": [
"desc",
"asc"
],
"location": "query",
"name": "order",
"nullable": false,
"required": false,
"type": "string"
},
{
"description": "Results per page (default 20, max 100).",
"location": "query",
"name": "limit",
"nullable": false,
"required": false,
"type": "integer"
},
{
"description": "Page number, from 1.",
"location": "query",
"name": "page",
"nullable": false,
"required": false,
"type": "integer"
},
{
"description": "DOI of the paper the items belong to.",
"location": "query",
"name": "resource_doi",
"nullable": false,
"required": false,
"type": "string"
},
{
"description": "0 leaves out the bulky `raw` source blocks (often 10-30x smaller).",
"enum_values": [
"0",
"1"
],
"location": "query",
"name": "raw",
"nullable": false,
"required": false,
"type": "string"
},
{
"description": "Comma-separated fields to return, e.g. `posts.id,posts.title`. Call metadata is always included.",
"location": "query",
"name": "fields",
"nullable": false,
"required": false,
"type": "string"
},
{
"description": "1 skips the 24-hour cache and fetches live.",
"enum_values": [
"1"
],
"location": "query",
"name": "fresh",
"nullable": false,
"required": false,
"type": "string"
},
{
"description": "JSON only for this OpenAny product. Omit output or use json; CSV and NDJSON exports are not exposed.",
"enum_values": [
"json"
],
"location": "query",
"name": "output",
"nullable": false,
"required": false,
"type": "string"
},
{
"description": "Native CSV/NDJSON record selector; it has no effect on this JSON-only product.",
"location": "query",
"name": "records",
"nullable": false,
"required": false,
"type": "string"
}
],
"billing": {
"currency": "USD",
"mode": "rules",
"parameters": [],
"policy_version": 2,
"sale": {
"addons": [],
"base_price_micro_usd": "0",
"max_cost_micro_usd": "2000",
"quantities": [
{
"id": "upstream_credits",
"label": "Actual API.SH credits consumed",
"max_quantity": "1",
"measure": "value",
"pointer": "/credits_used",
"price_micro_usd": "2000",
"quantity_scale": 0,
"source": "response",
"unit": "credit",
"unit_quantity": "1"
}
],
"rounding": "ceil",
"variants": []
}
},
"examples": [
{
"http_status": 200,
"name": "Official example · Official documentation response · Supplier-tr",
"request": {
"body": null,
"headers": {},
"path": {},
"query": {
"output": "json",
"q": "climate"
}
},
"response_body": {
"applied_filters": {
"search_for": "climate"
},
"cached": false,
"count": 20,
"credits_used": 1,
"items": [
{
"api_url": "https://api.figshare.com/v2/articles/34913091",
"created_date": "2026-11-06T09:08:29Z",
"doi": null,
"group_id": 49157,
"handle": "10779/uos.34913091.v1",
"id": 34913091,
"modified_date": "2026-11-06T09:08:29Z",
"online_date": null,
"posted_date": "2026-11-06T09:08:29",
"project_id": null,
"published_date": "2026-11-06T09:08:29Z",
"resource_doi": null,
"resource_title": null,
"thumbnail": "https://s3-eu-west-1.amazonaws.com/ppreviews-sussex-2810539038573/71081025/thumb.png",
"title": "Utility of sub-seasonal to seasonal onset forecasts in agricultural decision making",
"type": "thesis",
"type_id": 8,
"url": "https://sussex.figshare.com/articles/thesis/Utility_of_sub-seasonal_to_seasonal_onset_forecasts_in_agricultural_decision_making/34913091"
},
{
"api_url": "https://api.figshare.com/v2/articles/34935948",
"created_date": "2026-11-06T08:14:02Z",
"doi": "10.6084/m9.figshare.34935948.v1",
"group_id": 0,
"handle": null,
"id": 34935948,
"modified_date": "2026-11-06T08:14:03Z",
"online_date": null,
"posted_date": "2026-11-06T08:14:02",
"project_id": null,
"published_date": "2026-11-06T08:14:02Z",
"resource_doi": null,
"resource_title": null,
"thumbnail": null,
"title": "Replication Data for <i>Financing the Capacity to Qualify: Project Preparation and Investment Awards in African Climate Finance</i>",
"type": "dataset",
"type_id": 3,
"url": "https://figshare.com/articles/dataset/Replication_Data_for_i_Financing_the_Capacity_to_Qualify_Project_Preparation_and_Investment_Awards_in_…"
},
"… 18 more"
],
"next_page": 2,
"page": 1,
"query": "climate"
}
}
]
}
```Error handling
| Status | Next step |
|---|---|
400 | Check the offering and request fields. |
401 / 403 | Verify your credentials and access permissions. |
402 | Inspect the selected access mode and returned payment requirements. |
429 | Respect the returned rate limit and retry guidance. |
5xx | Inspect the error and usage record before retrying a paid operation. |
Official example · Official documentation response · Supplier-tr
Example from the provider's documentation. Field values in your results will differ.
Prepare your environment
Use a terminal with cURL installed.
Use an OpenAny API key with shared-balance access. Confirm availability and price before running; a call may charge your balance.
Set the key in your terminal using the hidden prompt below. Keep its value out of source files and logs.
Terminal · macOS / Linuxprintf 'OpenAny API key: ' read -r -s OPENANY_API_KEY export OPENANY_API_KEY printf '\n'Run the request
Paste the complete command below into your terminal.
Values to replace before running 22
Review these request fields before running. Keep the published provider and request method unchanged.
q- Search words.
type- Item type: figure, media, dataset, poster, journal_contribution, presentation, thesis, code, online_resource, preprint, book, conference_contribution.
title- Words in the title.
author- Author name, e.g. `Antonio Trabucco`.
tag- Tag/keyword.
description- Words in the description.
category- Category name, e.g. `Ecology` (see `/figshare/v1/vocabulary?type=categories`).
doi- Exact DOI.
institution- Figshare institution id.
group- Figshare group id.
published_since- Published on or after (YYYY-MM-DD).
modified_since- Modified on or after (YYYY-MM-DD).
sort- Order field (default relevance).
order- Order direction with `sort`.
limit- Results per page (default 20, max 100).
page- Page number, from 1.
resource_doi- DOI of the paper the items belong to.
raw- 0 leaves out the bulky `raw` source blocks (often 10-30x smaller).
fields- Comma-separated fields to return, e.g. `posts.id,posts.title`. Call metadata is always included.
fresh- 1 skips the 24-hour cache and fetches live.
output- JSON only for this OpenAny product. Omit output or use json; CSV and NDJSON exports are not exposed.
records- Native CSV/NDJSON record selector; it has no effect on this JSON-only product.
Terminal · cURLcurl \ 'https://api.openany.si/v1/agent-apis/apish/figshare/v1/search?output=json&q=climate' \ -X GET \ -H "Authorization: Bearer $OPENANY_API_KEY" \ -H 'Content-Type: application/json'Check the response
Sample response · Documented HTTP 200
Sample response{ "applied_filters": { "search_for": "climate" }, "cached": false, "count": 20, "credits_used": 1, "items": [ { "api_url": "https://api.figshare.com/v2/articles/34913091", "created_date": "2026-11-06T09:08:29Z", "doi": null, "group_id": 49157, "handle": "10779/uos.34913091.v1", "id": 34913091, "modified_date": "2026-11-06T09:08:29Z", "online_date": null, "posted_date": "2026-11-06T09:08:29", "project_id": null, "published_date": "2026-11-06T09:08:29Z", "resource_doi": null, "resource_title": null, "thumbnail": "https://s3-eu-west-1.amazonaws.com/ppreviews-sussex-2810539038573/71081025/thumb.png", "title": "Utility of sub-seasonal to seasonal onset forecasts in agricultural decision making", "type": "thesis", "type_id": 8, "url": "https://sussex.figshare.com/articles/thesis/Utility_of_sub-seasonal_to_seasonal_onset_forecasts_in_agricultural_decision_making/34913091" }, { "api_url": "https://api.figshare.com/v2/articles/34935948", "created_date": "2026-11-06T08:14:02Z", "doi": "10.6084/m9.figshare.34935948.v1", "group_id": 0, "handle": null, "id": 34935948, "modified_date": "2026-11-06T08:14:03Z", "online_date": null, "posted_date": "2026-11-06T08:14:02", "project_id": null, "published_date": "2026-11-06T08:14:02Z", "resource_doi": null, "resource_title": null, "thumbnail": null, "title": "Replication Data for <i>Financing the Capacity to Qualify: Project Preparation and Investment Awards in African Climate Finance</i>", "type": "dataset", "type_id": 3, "url": "https://figshare.com/articles/dataset/Replication_Data_for_i_Financing_the_Capacity_to_Qualify_Project_Preparation_and_Investment_Awards_in_…" }, "… 18 more" ], "next_page": 2, "page": 1, "query": "climate" }
Loading related APIs…
Common questions
Do I need a separate key for every provider?
Use your OpenAny API key for standard API access. Read it from OPENANY_API_KEY in your environment and keep it out of prompts, source code and logs.
Are these providers interchangeable?
No. Each offering has its own inputs, pricing and response contract. Selecting a catalog offering does not establish automatic routing or fallback. Confirm the service contract before calling.
How is this API billed?
API-key calls use your shared balance at the selected implementation's published rate. Check the billing unit and request-specific pricing rules before making a paid call. Recorded usage determines the final charge under that contract.
Where do the price and contract come from?
The selected implementation publishes its provider, request contract, revision and billing rules through OpenAny's public API catalog. A revision number identifies a contract version, not a price update date. A price update timestamp is not supplied; do not treat a page date as one.
How do OpenAny Balance and x402 differ?
OpenAny Balance uses an API key and one shared balance. Card, USDC and x402 top-ups, card auto top-up and USDC subscriptions fund that balance; available routes appear on the Credits page. Direct x402 is a separate pay-per-request flow, available only on listings that show it and requiring an authorized payment client.
Does Playground send a paid request?
Yes. After you sign in, Run sends a real API request using an active OpenAny API key. Charges follow the published API contract and use your shared balance. Selecting an implementation, editing inputs and viewing sample responses do not send requests.
Use Figshare item search API with your agent
Inspect endpoint contracts and confirm availability and pricing before a paid call.