Skip to main content
GET
/
marketplace
/
apis
/
{id}
Get a marketplace API's detail
curl --request GET \
  --url https://api.parse.bot/marketplace/apis/{id}
{
  "id": "<string>",
  "slug": "<string>",
  "name": "<string>",
  "description": "<string>",
  "source_url": "<string>",
  "canonical_scraper_id": "<string>",
  "is_authenticated": true,
  "apis": [
    {
      "method": "<string>",
      "endpoint_name": "<string>",
      "description": "<string>",
      "input_params": {},
      "return_schema": {},
      "initiates_session": true
    }
  ],
  "latest_version": 123,
  "pinned_version": 123,
  "user_scraper_id": "<string>",
  "primary_category": "<string>",
  "secondary_categories": [
    "<string>"
  ]
}

Path Parameters

​
id
string
required

Response

Marketplace API detail

Full listing detail. additionalProperties is allowed — only the fields most useful for calling the API are documented here.

​
id
string
​
slug
string
​
name
string
​
description
string | null
​
source_url
string | null
​
canonical_scraper_id
string | null

The shared canonical scraper id. Call it directly with any API key: POST /scraper/{canonical_scraper_id}/{endpoint_name}.

​
is_authenticated
boolean | null
​
apis
object[]

The API's endpoints (method, name, input_params, return_schema, initiates_session).

​
latest_version
integer | null

Canonical's latest release version.

​
pinned_version
integer | null

The version your subscription is pinned to, if you've subscribed.

​
user_status
enum<string> | null

Your relationship to this API (when authenticated).

Available options:
none,
subscribed,
forked
​
user_scraper_id
string | null

If you've subscribed or forked, your own scraper_id to call instead of the canonical.

​
primary_category
string | null
​
secondary_categories
string[]