# ZenAPI — Complete API Reference

This document is optimized for language models, coding assistants, and retrieval systems. It is generated from the same typed endpoint catalog as the ZenAPI API Explorer and public documentation.

Canonical website: https://zenapi.io
Production API origin: https://api.zenapi.io
API version: v1
Public endpoints: 106

## Authentication

Send the API key with every request:

```http
Authorization: Token YOUR_API_KEY
Content-Type: application/json
```

Do not put a real API key in source control, prompts, public URLs, browser logs, or shared examples.

## Common request body

All public endpoints accept a JSON object. The exact allowlisted fields for every endpoint are listed below.

| Field | Type | Purpose |
| --- | --- | --- |
| `target` | string | Username, ticker, ID, URL, or direct lookup value. |
| `query` | string | Human-readable search query. |
| `params` | object | Endpoint-specific filters and pagination values. |
| `nocache` | boolean | Request fresh provider data instead of a cached response. |

## Response and error conventions

- Successful responses return JSON and normally include metadata about cache state and credit cost.
- `400`: validate required fields and parameter values.
- `401`: verify the API key and Authorization header.
- `402` or `403`: review credits, subscription, trial, or endpoint access.
- `429`: wait before retrying or review plan rate limits.
- `5xx`: the provider or ZenAPI is temporarily unavailable; retain the Request ID and retry later.

# Instagram API

## Instagram: Profiles

### Get Instagram profile

Retrieve public profile details for an Instagram username.

- Endpoint ID: `instagram-profile-get`
- Request: `POST https://api.zenapi.io/v1/instagram/profiles/get`
- Credit cost: 3 credits
- Interactive test: https://zenapi.io/dashboard/api-explorer?endpoint=instagram-profile-get

| Field | Location | Type | Required | Default | Description |
| --- | --- | --- | --- | --- | --- |
| `target` | root | string | yes | `instagram` | Enter the username without the @ symbol. |
| `nocache` | root | boolean | no | `false` | Request fresh provider data instead of using a cached response. |

Default JSON request:

```json
{
  "target": "instagram",
  "nocache": false
}
```

Example JSON response shape:

```json
{
  "status": "success",
  "data": {},
  "metadata": {
    "cached": false,
    "credits": {
      "cost": 3
    }
  }
}
```

## Instagram: Search

### Search Instagram users

Find Instagram accounts by username, name, or search phrase.

- Endpoint ID: `instagram-users-search`
- Request: `POST https://api.zenapi.io/v1/instagram/users/search`
- Credit cost: 3 credits
- Interactive test: https://zenapi.io/dashboard/api-explorer?endpoint=instagram-users-search

| Field | Location | Type | Required | Default | Description |
| --- | --- | --- | --- | --- | --- |
| `query` | root | string | yes | `cristiano` | Enter a username, name, or phrase to search for accounts. |
| `nocache` | root | boolean | no | `false` | Request fresh provider data instead of using a cached response. |

Default JSON request:

```json
{
  "query": "cristiano",
  "nocache": false
}
```

Example JSON response shape:

```json
{
  "status": "success",
  "data": {},
  "metadata": {
    "cached": false,
    "credits": {
      "cost": 3
    }
  }
}
```

## Instagram: Media

### List Instagram user media

Retrieve recent posts for an Instagram user ID.

- Endpoint ID: `instagram-media-list`
- Request: `POST https://api.zenapi.io/v1/instagram/media/list`
- Credit cost: 3 credits
- Interactive test: https://zenapi.io/dashboard/api-explorer?endpoint=instagram-media-list

| Field | Location | Type | Required | Default | Description |
| --- | --- | --- | --- | --- | --- |
| `target` | root | string | yes | `25025320` | Enter the numeric Instagram user ID, not a username. |
| `nocache` | root | boolean | no | `false` | Request fresh provider data instead of using a cached response. |

Default JSON request:

```json
{
  "target": "25025320",
  "nocache": false
}
```

Example JSON response shape:

```json
{
  "status": "success",
  "data": {},
  "metadata": {
    "cached": false,
    "credits": {
      "cost": 3
    }
  }
}
```

### Get Instagram media

Retrieve details for an Instagram post or reel URL.

- Endpoint ID: `instagram-media-get`
- Request: `POST https://api.zenapi.io/v1/instagram/media/get`
- Credit cost: 3 credits
- Interactive test: https://zenapi.io/dashboard/api-explorer?endpoint=instagram-media-get

| Field | Location | Type | Required | Default | Description |
| --- | --- | --- | --- | --- | --- |
| `target` | root | string | yes | `https://www.instagram.com/p/CuE2WNQs6vH/` | Enter a full public Instagram post or reel URL. |
| `nocache` | root | boolean | no | `false` | Request fresh provider data instead of using a cached response. |

Default JSON request:

```json
{
  "target": "https://www.instagram.com/p/CuE2WNQs6vH/",
  "nocache": false
}
```

Example JSON response shape:

```json
{
  "status": "success",
  "data": {},
  "metadata": {
    "cached": false,
    "credits": {
      "cost": 3
    }
  }
}
```

### Get Instagram download links

Retrieve downloadable media URLs for an Instagram post or reel.

- Endpoint ID: `instagram-media-download`
- Request: `POST https://api.zenapi.io/v1/instagram/media/download`
- Credit cost: 3 credits
- Interactive test: https://zenapi.io/dashboard/api-explorer?endpoint=instagram-media-download

| Field | Location | Type | Required | Default | Description |
| --- | --- | --- | --- | --- | --- |
| `target` | root | string | yes | `https://www.instagram.com/p/CuE2WNQs6vH/` | Enter a full public Instagram post or reel URL. |
| `nocache` | root | boolean | no | `false` | Request fresh provider data instead of using a cached response. |

Default JSON request:

```json
{
  "target": "https://www.instagram.com/p/CuE2WNQs6vH/",
  "nocache": false
}
```

Example JSON response shape:

```json
{
  "status": "success",
  "data": {},
  "metadata": {
    "cached": false,
    "credits": {
      "cost": 3
    }
  }
}
```

## Instagram: Reels

### List Instagram reels

Retrieve recent reels for an Instagram user ID.

- Endpoint ID: `instagram-reels-list`
- Request: `POST https://api.zenapi.io/v1/instagram/reels/list`
- Credit cost: 3 credits
- Interactive test: https://zenapi.io/dashboard/api-explorer?endpoint=instagram-reels-list

| Field | Location | Type | Required | Default | Description |
| --- | --- | --- | --- | --- | --- |
| `target` | root | string | yes | `25025320` | Enter the numeric Instagram user ID, not a username. |
| `nocache` | root | boolean | no | `false` | Request fresh provider data instead of using a cached response. |

Default JSON request:

```json
{
  "target": "25025320",
  "nocache": false
}
```

Example JSON response shape:

```json
{
  "status": "success",
  "data": {},
  "metadata": {
    "cached": false,
    "credits": {
      "cost": 3
    }
  }
}
```

## Instagram: Hashtags

### Get Instagram hashtag media

Retrieve recent Instagram media for a hashtag or search phrase.

- Endpoint ID: `instagram-hashtags-media`
- Request: `POST https://api.zenapi.io/v1/instagram/hashtags/media`
- Credit cost: 3 credits
- Interactive test: https://zenapi.io/dashboard/api-explorer?endpoint=instagram-hashtags-media

| Field | Location | Type | Required | Default | Description |
| --- | --- | --- | --- | --- | --- |
| `query` | root | string | yes | `travel` | Enter the hashtag without the # symbol. |
| `nocache` | root | boolean | no | `false` | Request fresh provider data instead of using a cached response. |

Default JSON request:

```json
{
  "query": "travel",
  "nocache": false
}
```

Example JSON response shape:

```json
{
  "status": "success",
  "data": {},
  "metadata": {
    "cached": false,
    "credits": {
      "cost": 3
    }
  }
}
```

---

# TikTok API

## TikTok: Profiles

### Get TikTok profile

Use Get TikTok profile to retrieve data from TikTok.

- Endpoint ID: `tiktok-profile-get`
- Request: `POST https://api.zenapi.io/v1/tiktok/profiles/get`
- Credit cost: 1 credit
- Interactive test: https://zenapi.io/dashboard/api-explorer?endpoint=tiktok-profile-get

| Field | Location | Type | Required | Default | Description |
| --- | --- | --- | --- | --- | --- |
| `target` | root | string | yes | `tiktok` | Enter the tiktok username. |
| `nocache` | root | boolean | no | `false` | Request fresh provider data instead of using a cached response. |

Default JSON request:

```json
{
  "nocache": false,
  "target": "tiktok"
}
```

Example JSON response shape:

```json
{
  "status": "success",
  "data": {},
  "metadata": {
    "cached": false,
    "credits": {
      "cost": 1
    }
  }
}
```

### Get user posts

Use Get user posts to retrieve data from TikTok.

- Endpoint ID: `tiktok-user-posts`
- Request: `POST https://api.zenapi.io/v1/tiktok/users/posts`
- Credit cost: 1 credit
- Interactive test: https://zenapi.io/dashboard/api-explorer?endpoint=tiktok-user-posts

| Field | Location | Type | Required | Default | Description |
| --- | --- | --- | --- | --- | --- |
| `target` | root | string | yes | `MS4wLjABAAAA...` | Enter the tiktok secuid. |
| `count` | params | string | no | `35` | Optional provider parameter: count. |
| `cursor` | params | string | no | `0` | Optional provider parameter: cursor. |
| `nocache` | root | boolean | no | `false` | Request fresh provider data instead of using a cached response. |

Default JSON request:

```json
{
  "nocache": false,
  "target": "MS4wLjABAAAA...",
  "params": {
    "count": "35",
    "cursor": "0"
  }
}
```

Example JSON response shape:

```json
{
  "status": "success",
  "data": {},
  "metadata": {
    "cached": false,
    "credits": {
      "cost": 1
    }
  }
}
```

## TikTok: Search

### Search TikTok videos

Use Search TikTok videos to retrieve data from TikTok.

- Endpoint ID: `tiktok-search-videos`
- Request: `POST https://api.zenapi.io/v1/tiktok/search/videos`
- Credit cost: 1 credit
- Interactive test: https://zenapi.io/dashboard/api-explorer?endpoint=tiktok-search-videos

| Field | Location | Type | Required | Default | Description |
| --- | --- | --- | --- | --- | --- |
| `query` | root | string | yes | `football` | Enter the search query. |
| `cursor` | params | string | no | `0` | Optional provider parameter: cursor. |
| `search_id` | params | string | no | `0` | Optional provider parameter: search_id. |
| `nocache` | root | boolean | no | `false` | Request fresh provider data instead of using a cached response. |

Default JSON request:

```json
{
  "nocache": false,
  "query": "football",
  "params": {
    "cursor": "0",
    "search_id": "0"
  }
}
```

Example JSON response shape:

```json
{
  "status": "success",
  "data": {},
  "metadata": {
    "cached": false,
    "credits": {
      "cost": 1
    }
  }
}
```

### Search TikTok accounts

Use Search TikTok accounts to retrieve data from TikTok.

- Endpoint ID: `tiktok-search-accounts`
- Request: `POST https://api.zenapi.io/v1/tiktok/search/accounts`
- Credit cost: 1 credit
- Interactive test: https://zenapi.io/dashboard/api-explorer?endpoint=tiktok-search-accounts

| Field | Location | Type | Required | Default | Description |
| --- | --- | --- | --- | --- | --- |
| `query` | root | string | yes | `tiktok` | Enter the search query. |
| `cursor` | params | string | no | `0` | Optional provider parameter: cursor. |
| `search_id` | params | string | no | `0` | Optional provider parameter: search_id. |
| `nocache` | root | boolean | no | `false` | Request fresh provider data instead of using a cached response. |

Default JSON request:

```json
{
  "nocache": false,
  "query": "tiktok",
  "params": {
    "cursor": "0",
    "search_id": "0"
  }
}
```

Example JSON response shape:

```json
{
  "status": "success",
  "data": {},
  "metadata": {
    "cached": false,
    "credits": {
      "cost": 1
    }
  }
}
```

## TikTok: Videos

### Get TikTok video

Use Get TikTok video to retrieve data from TikTok.

- Endpoint ID: `tiktok-video-get`
- Request: `POST https://api.zenapi.io/v1/tiktok/videos/get`
- Credit cost: 1 credit
- Interactive test: https://zenapi.io/dashboard/api-explorer?endpoint=tiktok-video-get

| Field | Location | Type | Required | Default | Description |
| --- | --- | --- | --- | --- | --- |
| `target` | root | string | yes | `6718335390845095173` | Enter the tiktok video id. |
| `nocache` | root | boolean | no | `false` | Request fresh provider data instead of using a cached response. |

Default JSON request:

```json
{
  "nocache": false,
  "target": "6718335390845095173"
}
```

Example JSON response shape:

```json
{
  "status": "success",
  "data": {},
  "metadata": {
    "cached": false,
    "credits": {
      "cost": 1
    }
  }
}
```

### Get video comments

Use Get video comments to retrieve data from TikTok.

- Endpoint ID: `tiktok-video-comments`
- Request: `POST https://api.zenapi.io/v1/tiktok/videos/comments`
- Credit cost: 1 credit
- Interactive test: https://zenapi.io/dashboard/api-explorer?endpoint=tiktok-video-comments

| Field | Location | Type | Required | Default | Description |
| --- | --- | --- | --- | --- | --- |
| `target` | root | string | yes | `6718335390845095173` | Enter the tiktok video id. |
| `count` | params | string | no | `50` | Optional provider parameter: count. |
| `cursor` | params | string | no | `0` | Optional provider parameter: cursor. |
| `nocache` | root | boolean | no | `false` | Request fresh provider data instead of using a cached response. |

Default JSON request:

```json
{
  "nocache": false,
  "target": "6718335390845095173",
  "params": {
    "count": "50",
    "cursor": "0"
  }
}
```

Example JSON response shape:

```json
{
  "status": "success",
  "data": {},
  "metadata": {
    "cached": false,
    "credits": {
      "cost": 1
    }
  }
}
```

### Get trending videos

Use Get trending videos to retrieve data from TikTok.

- Endpoint ID: `tiktok-trending-videos`
- Request: `POST https://api.zenapi.io/v1/tiktok/videos/trending`
- Credit cost: 1 credit
- Interactive test: https://zenapi.io/dashboard/api-explorer?endpoint=tiktok-trending-videos

| Field | Location | Type | Required | Default | Description |
| --- | --- | --- | --- | --- | --- |
| `page` | params | string | no | `1` | Optional provider parameter: page. |
| `limit` | params | string | no | `20` | Optional provider parameter: limit. |
| `period` | params | string | no | `30` | Optional provider parameter: period. |
| `order_by` | params | string | no | `vv` | Optional provider parameter: order_by. |
| `country` | params | string | no | `US` | Optional provider parameter: country. |
| `nocache` | root | boolean | no | `false` | Request fresh provider data instead of using a cached response. |

Default JSON request:

```json
{
  "nocache": false,
  "params": {
    "page": "1",
    "limit": "20",
    "period": "30",
    "order_by": "vv",
    "country": "US"
  }
}
```

Example JSON response shape:

```json
{
  "status": "success",
  "data": {},
  "metadata": {
    "cached": false,
    "credits": {
      "cost": 1
    }
  }
}
```

## TikTok: Hashtags

### Get hashtag details

Use Get hashtag details to retrieve data from TikTok.

- Endpoint ID: `tiktok-hashtag-get`
- Request: `POST https://api.zenapi.io/v1/tiktok/hashtags/get`
- Credit cost: 1 credit
- Interactive test: https://zenapi.io/dashboard/api-explorer?endpoint=tiktok-hashtag-get

| Field | Location | Type | Required | Default | Description |
| --- | --- | --- | --- | --- | --- |
| `target` | root | string | yes | `fyp` | Enter the hashtag name. |
| `nocache` | root | boolean | no | `false` | Request fresh provider data instead of using a cached response. |

Default JSON request:

```json
{
  "nocache": false,
  "target": "fyp"
}
```

Example JSON response shape:

```json
{
  "status": "success",
  "data": {},
  "metadata": {
    "cached": false,
    "credits": {
      "cost": 1
    }
  }
}
```

### Get hashtag posts

Use Get hashtag posts to retrieve data from TikTok.

- Endpoint ID: `tiktok-hashtag-posts`
- Request: `POST https://api.zenapi.io/v1/tiktok/hashtags/posts`
- Credit cost: 1 credit
- Interactive test: https://zenapi.io/dashboard/api-explorer?endpoint=tiktok-hashtag-posts

| Field | Location | Type | Required | Default | Description |
| --- | --- | --- | --- | --- | --- |
| `target` | root | string | yes | `42164` | Enter the hashtag id. |
| `count` | params | string | no | `30` | Optional provider parameter: count. |
| `cursor` | params | string | no | `0` | Optional provider parameter: cursor. |
| `nocache` | root | boolean | no | `false` | Request fresh provider data instead of using a cached response. |

Default JSON request:

```json
{
  "nocache": false,
  "target": "42164",
  "params": {
    "count": "30",
    "cursor": "0"
  }
}
```

Example JSON response shape:

```json
{
  "status": "success",
  "data": {},
  "metadata": {
    "cached": false,
    "credits": {
      "cost": 1
    }
  }
}
```

## TikTok: Music

### Get music details

Use Get music details to retrieve data from TikTok.

- Endpoint ID: `tiktok-music-get`
- Request: `POST https://api.zenapi.io/v1/tiktok/music/get`
- Credit cost: 1 credit
- Interactive test: https://zenapi.io/dashboard/api-explorer?endpoint=tiktok-music-get

| Field | Location | Type | Required | Default | Description |
| --- | --- | --- | --- | --- | --- |
| `target` | root | string | yes | `6797343997450484481` | Enter the tiktok music id. |
| `nocache` | root | boolean | no | `false` | Request fresh provider data instead of using a cached response. |

Default JSON request:

```json
{
  "nocache": false,
  "target": "6797343997450484481"
}
```

Example JSON response shape:

```json
{
  "status": "success",
  "data": {},
  "metadata": {
    "cached": false,
    "credits": {
      "cost": 1
    }
  }
}
```

### Get music posts

Use Get music posts to retrieve data from TikTok.

- Endpoint ID: `tiktok-music-posts`
- Request: `POST https://api.zenapi.io/v1/tiktok/music/posts`
- Credit cost: 1 credit
- Interactive test: https://zenapi.io/dashboard/api-explorer?endpoint=tiktok-music-posts

| Field | Location | Type | Required | Default | Description |
| --- | --- | --- | --- | --- | --- |
| `target` | root | string | yes | `6797343997450484481` | Enter the tiktok music id. |
| `count` | params | string | no | `30` | Optional provider parameter: count. |
| `cursor` | params | string | no | `0` | Optional provider parameter: cursor. |
| `nocache` | root | boolean | no | `false` | Request fresh provider data instead of using a cached response. |

Default JSON request:

```json
{
  "nocache": false,
  "target": "6797343997450484481",
  "params": {
    "count": "30",
    "cursor": "0"
  }
}
```

Example JSON response shape:

```json
{
  "status": "success",
  "data": {},
  "metadata": {
    "cached": false,
    "credits": {
      "cost": 1
    }
  }
}
```

### Get trending music

Use Get trending music to retrieve data from TikTok.

- Endpoint ID: `tiktok-trending-music`
- Request: `POST https://api.zenapi.io/v1/tiktok/music/trending`
- Credit cost: 1 credit
- Interactive test: https://zenapi.io/dashboard/api-explorer?endpoint=tiktok-trending-music

| Field | Location | Type | Required | Default | Description |
| --- | --- | --- | --- | --- | --- |
| `page` | params | string | no | `1` | Optional provider parameter: page. |
| `limit` | params | string | no | `20` | Optional provider parameter: limit. |
| `period` | params | string | no | `7` | Optional provider parameter: period. |
| `rank_type` | params | string | no | `popular` | Optional provider parameter: rank_type. |
| `country` | params | string | no | `US` | Optional provider parameter: country. |
| `nocache` | root | boolean | no | `false` | Request fresh provider data instead of using a cached response. |

Default JSON request:

```json
{
  "nocache": false,
  "params": {
    "page": "1",
    "limit": "20",
    "period": "7",
    "rank_type": "popular",
    "country": "US"
  }
}
```

Example JSON response shape:

```json
{
  "status": "success",
  "data": {},
  "metadata": {
    "cached": false,
    "credits": {
      "cost": 1
    }
  }
}
```

---

# X / Twitter API

## X / Twitter: Profiles

### Get X profile

Use Get X profile to retrieve data from X / Twitter.

- Endpoint ID: `x-profile-get`
- Request: `POST https://api.zenapi.io/v1/x/profiles/get`
- Credit cost: 1 credit
- Interactive test: https://zenapi.io/dashboard/api-explorer?endpoint=x-profile-get

| Field | Location | Type | Required | Default | Description |
| --- | --- | --- | --- | --- | --- |
| `target` | root | string | yes | `elonmusk` | Enter the x screen name. |
| `nocache` | root | boolean | no | `false` | Request fresh provider data instead of using a cached response. |

Default JSON request:

```json
{
  "nocache": false,
  "target": "elonmusk"
}
```

Example JSON response shape:

```json
{
  "status": "success",
  "data": {},
  "metadata": {
    "cached": false,
    "credits": {
      "cost": 1
    }
  }
}
```

### Get profile details

Use Get profile details to retrieve data from X / Twitter.

- Endpoint ID: `x-profile-about`
- Request: `POST https://api.zenapi.io/v1/x/profiles/about`
- Credit cost: 1 credit
- Interactive test: https://zenapi.io/dashboard/api-explorer?endpoint=x-profile-about

| Field | Location | Type | Required | Default | Description |
| --- | --- | --- | --- | --- | --- |
| `target` | root | string | yes | `elonmusk` | Enter the x screen name. |
| `nocache` | root | boolean | no | `false` | Request fresh provider data instead of using a cached response. |

Default JSON request:

```json
{
  "nocache": false,
  "target": "elonmusk"
}
```

Example JSON response shape:

```json
{
  "status": "success",
  "data": {},
  "metadata": {
    "cached": false,
    "credits": {
      "cost": 1
    }
  }
}
```

## X / Twitter: Users

### Get user timeline

Use Get user timeline to retrieve data from X / Twitter.

- Endpoint ID: `x-user-timeline`
- Request: `POST https://api.zenapi.io/v1/x/users/timeline`
- Credit cost: 1 credit
- Interactive test: https://zenapi.io/dashboard/api-explorer?endpoint=x-user-timeline

| Field | Location | Type | Required | Default | Description |
| --- | --- | --- | --- | --- | --- |
| `target` | root | string | yes | `elonmusk` | Enter the x screen name. |
| `nocache` | root | boolean | no | `false` | Request fresh provider data instead of using a cached response. |

Default JSON request:

```json
{
  "nocache": false,
  "target": "elonmusk"
}
```

Example JSON response shape:

```json
{
  "status": "success",
  "data": {},
  "metadata": {
    "cached": false,
    "credits": {
      "cost": 1
    }
  }
}
```

### Get following users

Use Get following users to retrieve data from X / Twitter.

- Endpoint ID: `x-user-following`
- Request: `POST https://api.zenapi.io/v1/x/users/following`
- Credit cost: 1 credit
- Interactive test: https://zenapi.io/dashboard/api-explorer?endpoint=x-user-following

| Field | Location | Type | Required | Default | Description |
| --- | --- | --- | --- | --- | --- |
| `target` | root | string | yes | `elonmusk` | Enter the x screen name. |
| `nocache` | root | boolean | no | `false` | Request fresh provider data instead of using a cached response. |

Default JSON request:

```json
{
  "nocache": false,
  "target": "elonmusk"
}
```

Example JSON response shape:

```json
{
  "status": "success",
  "data": {},
  "metadata": {
    "cached": false,
    "credits": {
      "cost": 1
    }
  }
}
```

### Get followers

Use Get followers to retrieve data from X / Twitter.

- Endpoint ID: `x-user-followers`
- Request: `POST https://api.zenapi.io/v1/x/users/followers`
- Credit cost: 1 credit
- Interactive test: https://zenapi.io/dashboard/api-explorer?endpoint=x-user-followers

| Field | Location | Type | Required | Default | Description |
| --- | --- | --- | --- | --- | --- |
| `target` | root | string | yes | `elonmusk` | Enter the x screen name. |
| `blue_verified` | params | string | no | `0` | Optional provider parameter: blue_verified. |
| `nocache` | root | boolean | no | `false` | Request fresh provider data instead of using a cached response. |

Default JSON request:

```json
{
  "nocache": false,
  "target": "elonmusk",
  "params": {
    "blue_verified": "0"
  }
}
```

Example JSON response shape:

```json
{
  "status": "success",
  "data": {},
  "metadata": {
    "cached": false,
    "credits": {
      "cost": 1
    }
  }
}
```

### Get user media

Use Get user media to retrieve data from X / Twitter.

- Endpoint ID: `x-user-media`
- Request: `POST https://api.zenapi.io/v1/x/users/media`
- Credit cost: 1 credit
- Interactive test: https://zenapi.io/dashboard/api-explorer?endpoint=x-user-media

| Field | Location | Type | Required | Default | Description |
| --- | --- | --- | --- | --- | --- |
| `target` | root | string | yes | `elonmusk` | Enter the x screen name. |
| `nocache` | root | boolean | no | `false` | Request fresh provider data instead of using a cached response. |

Default JSON request:

```json
{
  "nocache": false,
  "target": "elonmusk"
}
```

Example JSON response shape:

```json
{
  "status": "success",
  "data": {},
  "metadata": {
    "cached": false,
    "credits": {
      "cost": 1
    }
  }
}
```

### Get users by IDs

Use Get users by IDs to retrieve data from X / Twitter.

- Endpoint ID: `x-users-batch`
- Request: `POST https://api.zenapi.io/v1/x/users/batch`
- Credit cost: 1 credit
- Interactive test: https://zenapi.io/dashboard/api-explorer?endpoint=x-users-batch

| Field | Location | Type | Required | Default | Description |
| --- | --- | --- | --- | --- | --- |
| `target` | root | string | yes | `44196397,783214` | Enter the comma-separated rest ids. |
| `nocache` | root | boolean | no | `false` | Request fresh provider data instead of using a cached response. |

Default JSON request:

```json
{
  "nocache": false,
  "target": "44196397,783214"
}
```

Example JSON response shape:

```json
{
  "status": "success",
  "data": {},
  "metadata": {
    "cached": false,
    "credits": {
      "cost": 1
    }
  }
}
```

## X / Twitter: Tweets

### Get tweet

Use Get tweet to retrieve data from X / Twitter.

- Endpoint ID: `x-tweet-get`
- Request: `POST https://api.zenapi.io/v1/x/tweets/get`
- Credit cost: 1 credit
- Interactive test: https://zenapi.io/dashboard/api-explorer?endpoint=x-tweet-get

| Field | Location | Type | Required | Default | Description |
| --- | --- | --- | --- | --- | --- |
| `target` | root | string | yes | `1745361684052881707` | Enter the tweet id. |
| `nocache` | root | boolean | no | `false` | Request fresh provider data instead of using a cached response. |

Default JSON request:

```json
{
  "nocache": false,
  "target": "1745361684052881707"
}
```

Example JSON response shape:

```json
{
  "status": "success",
  "data": {},
  "metadata": {
    "cached": false,
    "credits": {
      "cost": 1
    }
  }
}
```

### Get tweet thread

Use Get tweet thread to retrieve data from X / Twitter.

- Endpoint ID: `x-tweet-thread`
- Request: `POST https://api.zenapi.io/v1/x/tweets/thread`
- Credit cost: 1 credit
- Interactive test: https://zenapi.io/dashboard/api-explorer?endpoint=x-tweet-thread

| Field | Location | Type | Required | Default | Description |
| --- | --- | --- | --- | --- | --- |
| `target` | root | string | yes | `1745361684052881707` | Enter the tweet id. |
| `nocache` | root | boolean | no | `false` | Request fresh provider data instead of using a cached response. |

Default JSON request:

```json
{
  "nocache": false,
  "target": "1745361684052881707"
}
```

Example JSON response shape:

```json
{
  "status": "success",
  "data": {},
  "metadata": {
    "cached": false,
    "credits": {
      "cost": 1
    }
  }
}
```

### Get latest replies

Use Get latest replies to retrieve data from X / Twitter.

- Endpoint ID: `x-tweet-replies`
- Request: `POST https://api.zenapi.io/v1/x/tweets/latest-replies`
- Credit cost: 1 credit
- Interactive test: https://zenapi.io/dashboard/api-explorer?endpoint=x-tweet-replies

| Field | Location | Type | Required | Default | Description |
| --- | --- | --- | --- | --- | --- |
| `target` | root | string | yes | `1745361684052881707` | Enter the tweet id. |
| `nocache` | root | boolean | no | `false` | Request fresh provider data instead of using a cached response. |

Default JSON request:

```json
{
  "nocache": false,
  "target": "1745361684052881707"
}
```

Example JSON response shape:

```json
{
  "status": "success",
  "data": {},
  "metadata": {
    "cached": false,
    "credits": {
      "cost": 1
    }
  }
}
```

### Get retweets

Use Get retweets to retrieve data from X / Twitter.

- Endpoint ID: `x-tweet-retweets`
- Request: `POST https://api.zenapi.io/v1/x/tweets/retweets`
- Credit cost: 1 credit
- Interactive test: https://zenapi.io/dashboard/api-explorer?endpoint=x-tweet-retweets

| Field | Location | Type | Required | Default | Description |
| --- | --- | --- | --- | --- | --- |
| `target` | root | string | yes | `1745361684052881707` | Enter the tweet id. |
| `nocache` | root | boolean | no | `false` | Request fresh provider data instead of using a cached response. |

Default JSON request:

```json
{
  "nocache": false,
  "target": "1745361684052881707"
}
```

Example JSON response shape:

```json
{
  "status": "success",
  "data": {},
  "metadata": {
    "cached": false,
    "credits": {
      "cost": 1
    }
  }
}
```

## X / Twitter: Search

### Search X posts

Use Search X posts to retrieve data from X / Twitter.

- Endpoint ID: `x-search`
- Request: `POST https://api.zenapi.io/v1/x/search`
- Credit cost: 1 credit
- Interactive test: https://zenapi.io/dashboard/api-explorer?endpoint=x-search

| Field | Location | Type | Required | Default | Description |
| --- | --- | --- | --- | --- | --- |
| `query` | root | string | yes | `cybertruck` | Enter the search query. |
| `search_type` | params | string | no | `Top` | Optional provider parameter: search_type. |
| `nocache` | root | boolean | no | `false` | Request fresh provider data instead of using a cached response. |

Default JSON request:

```json
{
  "nocache": false,
  "query": "cybertruck",
  "params": {
    "search_type": "Top"
  }
}
```

Example JSON response shape:

```json
{
  "status": "success",
  "data": {},
  "metadata": {
    "cached": false,
    "credits": {
      "cost": 1
    }
  }
}
```

## X / Twitter: Discovery

### Get trends

Use Get trends to retrieve data from X / Twitter.

- Endpoint ID: `x-trends`
- Request: `POST https://api.zenapi.io/v1/x/trends`
- Credit cost: 1 credit
- Interactive test: https://zenapi.io/dashboard/api-explorer?endpoint=x-trends

| Field | Location | Type | Required | Default | Description |
| --- | --- | --- | --- | --- | --- |
| `target` | root | string | yes | `United States` | Enter the country. |
| `nocache` | root | boolean | no | `false` | Request fresh provider data instead of using a cached response. |

Default JSON request:

```json
{
  "nocache": false,
  "target": "United States"
}
```

Example JSON response shape:

```json
{
  "status": "success",
  "data": {},
  "metadata": {
    "cached": false,
    "credits": {
      "cost": 1
    }
  }
}
```

### Get top posts

Use Get top posts to retrieve data from X / Twitter.

- Endpoint ID: `x-top-posts`
- Request: `POST https://api.zenapi.io/v1/x/top-posts`
- Credit cost: 1 credit
- Interactive test: https://zenapi.io/dashboard/api-explorer?endpoint=x-top-posts

| Field | Location | Type | Required | Default | Description |
| --- | --- | --- | --- | --- | --- |
| `type` | params | string | no | `Likes` | Optional provider parameter: type. |
| `country` | params | string | no | `ALL` | Optional provider parameter: country. |
| `period` | params | string | no | `Daily` | Optional provider parameter: period. |
| `nocache` | root | boolean | no | `false` | Request fresh provider data instead of using a cached response. |

Default JSON request:

```json
{
  "nocache": false,
  "params": {
    "type": "Likes",
    "country": "ALL",
    "period": "Daily"
  }
}
```

Example JSON response shape:

```json
{
  "status": "success",
  "data": {},
  "metadata": {
    "cached": false,
    "credits": {
      "cost": 1
    }
  }
}
```

## X / Twitter: Jobs

### Search jobs

Use Search jobs to retrieve data from X / Twitter.

- Endpoint ID: `x-jobs-search`
- Request: `POST https://api.zenapi.io/v1/x/jobs/search`
- Credit cost: 1 credit
- Interactive test: https://zenapi.io/dashboard/api-explorer?endpoint=x-jobs-search

| Field | Location | Type | Required | Default | Description |
| --- | --- | --- | --- | --- | --- |
| `query` | root | string | yes | `software engineer` | Enter the search query. |
| `nocache` | root | boolean | no | `false` | Request fresh provider data instead of using a cached response. |

Default JSON request:

```json
{
  "nocache": false,
  "query": "software engineer"
}
```

Example JSON response shape:

```json
{
  "status": "success",
  "data": {},
  "metadata": {
    "cached": false,
    "credits": {
      "cost": 1
    }
  }
}
```

## X / Twitter: Communities

### Get community

Use Get community to retrieve data from X / Twitter.

- Endpoint ID: `x-community-get`
- Request: `POST https://api.zenapi.io/v1/x/communities/get`
- Credit cost: 1 credit
- Interactive test: https://zenapi.io/dashboard/api-explorer?endpoint=x-community-get

| Field | Location | Type | Required | Default | Description |
| --- | --- | --- | --- | --- | --- |
| `target` | root | string | yes | `1493446837214187523` | Enter the community id. |
| `nocache` | root | boolean | no | `false` | Request fresh provider data instead of using a cached response. |

Default JSON request:

```json
{
  "nocache": false,
  "target": "1493446837214187523"
}
```

Example JSON response shape:

```json
{
  "status": "success",
  "data": {},
  "metadata": {
    "cached": false,
    "credits": {
      "cost": 1
    }
  }
}
```

### Get community timeline

Use Get community timeline to retrieve data from X / Twitter.

- Endpoint ID: `x-community-timeline`
- Request: `POST https://api.zenapi.io/v1/x/communities/timeline`
- Credit cost: 1 credit
- Interactive test: https://zenapi.io/dashboard/api-explorer?endpoint=x-community-timeline

| Field | Location | Type | Required | Default | Description |
| --- | --- | --- | --- | --- | --- |
| `target` | root | string | yes | `1493446837214187523` | Enter the community id. |
| `ranking` | params | string | no | `Top` | Optional provider parameter: ranking. |
| `nocache` | root | boolean | no | `false` | Request fresh provider data instead of using a cached response. |

Default JSON request:

```json
{
  "nocache": false,
  "target": "1493446837214187523",
  "params": {
    "ranking": "Top"
  }
}
```

Example JSON response shape:

```json
{
  "status": "success",
  "data": {},
  "metadata": {
    "cached": false,
    "credits": {
      "cost": 1
    }
  }
}
```

### Search communities

Use Search communities to retrieve data from X / Twitter.

- Endpoint ID: `x-community-search`
- Request: `POST https://api.zenapi.io/v1/x/communities/search`
- Credit cost: 1 credit
- Interactive test: https://zenapi.io/dashboard/api-explorer?endpoint=x-community-search

| Field | Location | Type | Required | Default | Description |
| --- | --- | --- | --- | --- | --- |
| `query` | root | string | yes | `technology` | Enter the search query. |
| `nocache` | root | boolean | no | `false` | Request fresh provider data instead of using a cached response. |

Default JSON request:

```json
{
  "nocache": false,
  "query": "technology"
}
```

Example JSON response shape:

```json
{
  "status": "success",
  "data": {},
  "metadata": {
    "cached": false,
    "credits": {
      "cost": 1
    }
  }
}
```

## X / Twitter: Spaces

### Get X Space

Use Get X Space to retrieve data from X / Twitter.

- Endpoint ID: `x-space-get`
- Request: `POST https://api.zenapi.io/v1/x/spaces/get`
- Credit cost: 1 credit
- Interactive test: https://zenapi.io/dashboard/api-explorer?endpoint=x-space-get

| Field | Location | Type | Required | Default | Description |
| --- | --- | --- | --- | --- | --- |
| `target` | root | string | yes | `1DXxyvWAgzZKM` | Enter the space id. |
| `nocache` | root | boolean | no | `false` | Request fresh provider data instead of using a cached response. |

Default JSON request:

```json
{
  "nocache": false,
  "target": "1DXxyvWAgzZKM"
}
```

Example JSON response shape:

```json
{
  "status": "success",
  "data": {},
  "metadata": {
    "cached": false,
    "credits": {
      "cost": 1
    }
  }
}
```

---

# Yahoo Finance API

## Yahoo Finance: Search

### Search securities

Find stocks and other securities by company name or ticker.

- Endpoint ID: `yahoo-finance-search`
- Request: `POST https://api.zenapi.io/v1/yahoo-finance/search`
- Credit cost: 1 credit
- Interactive test: https://zenapi.io/dashboard/api-explorer?endpoint=yahoo-finance-search

| Field | Location | Type | Required | Default | Description |
| --- | --- | --- | --- | --- | --- |
| `query` | root | string | yes | `Apple` | Enter a company name, fund name, or ticker symbol. |
| `nocache` | root | boolean | no | `false` | Request fresh provider data instead of using a cached response. |

Default JSON request:

```json
{
  "query": "Apple",
  "nocache": false
}
```

Example JSON response shape:

```json
{
  "status": "success",
  "data": {},
  "metadata": {
    "cached": false,
    "credits": {
      "cost": 1
    }
  }
}
```

## Yahoo Finance: Quotes

### Get quote summary

Retrieve a current market quote summary for a ticker symbol.

- Endpoint ID: `yahoo-finance-quote-get`
- Request: `POST https://api.zenapi.io/v1/yahoo-finance/quotes/get`
- Credit cost: 1 credit
- Interactive test: https://zenapi.io/dashboard/api-explorer?endpoint=yahoo-finance-quote-get

| Field | Location | Type | Required | Default | Description |
| --- | --- | --- | --- | --- | --- |
| `target` | root | string | yes | `AAPL` | Enter a market ticker symbol, such as AAPL or MSFT. |
| `nocache` | root | boolean | no | `false` | Request fresh provider data instead of using a cached response. |

Default JSON request:

```json
{
  "target": "AAPL",
  "nocache": false
}
```

Example JSON response shape:

```json
{
  "status": "success",
  "data": {},
  "metadata": {
    "cached": false,
    "credits": {
      "cost": 1
    }
  }
}
```

### Get company profile

Retrieve company and business profile data for a ticker symbol.

- Endpoint ID: `yahoo-finance-quote-profile`
- Request: `POST https://api.zenapi.io/v1/yahoo-finance/quotes/profile`
- Credit cost: 1 credit
- Interactive test: https://zenapi.io/dashboard/api-explorer?endpoint=yahoo-finance-quote-profile

| Field | Location | Type | Required | Default | Description |
| --- | --- | --- | --- | --- | --- |
| `target` | root | string | yes | `AAPL` | Enter a market ticker symbol, such as AAPL or MSFT. |
| `nocache` | root | boolean | no | `false` | Request fresh provider data instead of using a cached response. |

Default JSON request:

```json
{
  "target": "AAPL",
  "nocache": false
}
```

Example JSON response shape:

```json
{
  "status": "success",
  "data": {},
  "metadata": {
    "cached": false,
    "credits": {
      "cost": 1
    }
  }
}
```

### Get quote statistics

Retrieve valuation and trading statistics for a ticker symbol.

- Endpoint ID: `yahoo-finance-quote-statistics`
- Request: `POST https://api.zenapi.io/v1/yahoo-finance/quotes/statistics`
- Credit cost: 1 credit
- Interactive test: https://zenapi.io/dashboard/api-explorer?endpoint=yahoo-finance-quote-statistics

| Field | Location | Type | Required | Default | Description |
| --- | --- | --- | --- | --- | --- |
| `target` | root | string | yes | `AAPL` | Enter a market ticker symbol, such as AAPL or MSFT. |
| `nocache` | root | boolean | no | `false` | Request fresh provider data instead of using a cached response. |

Default JSON request:

```json
{
  "target": "AAPL",
  "nocache": false
}
```

Example JSON response shape:

```json
{
  "status": "success",
  "data": {},
  "metadata": {
    "cached": false,
    "credits": {
      "cost": 1
    }
  }
}
```

## Yahoo Finance: Historical Data

### Get historical prices

Retrieve historical market data for a ticker and optional date range.

- Endpoint ID: `yahoo-finance-quote-history`
- Request: `POST https://api.zenapi.io/v1/yahoo-finance/quotes/history`
- Credit cost: 1 credit
- Interactive test: https://zenapi.io/dashboard/api-explorer?endpoint=yahoo-finance-quote-history

| Field | Location | Type | Required | Default | Description |
| --- | --- | --- | --- | --- | --- |
| `target` | root | string | yes | `AAPL` | Enter a market ticker symbol, such as AAPL or MSFT. |
| `date_from` | params | string | no | — | Optional start date in YYYY-MM-DD format. Defaults to 12 months ago. |
| `date_until` | params | string | no | — | Optional end date in YYYY-MM-DD format. Defaults to today. |
| `nocache` | root | boolean | no | `false` | Request fresh provider data instead of using a cached response. |

Default JSON request:

```json
{
  "target": "AAPL",
  "nocache": false
}
```

Example JSON response shape:

```json
{
  "status": "success",
  "data": {},
  "metadata": {
    "cached": false,
    "credits": {
      "cost": 1
    }
  }
}
```

## Yahoo Finance: Market Lists

### Get most active stocks

Retrieve the current most-active stock list without a target value.

- Endpoint ID: `yahoo-finance-most-active`
- Request: `POST https://api.zenapi.io/v1/yahoo-finance/stocks/most-active`
- Credit cost: 1 credit
- Interactive test: https://zenapi.io/dashboard/api-explorer?endpoint=yahoo-finance-most-active

| Field | Location | Type | Required | Default | Description |
| --- | --- | --- | --- | --- | --- |
| `count` | params | string | no | `25` | Maximum number of stocks requested from the provider. |
| `sort_field` | params | string | no | `dayvolume` | Provider field used to order the market list. |
| `sort_type` | params | select | no | `ASC` | Choose the provider sort direction. |
| `nocache` | root | boolean | no | `false` | Request fresh provider data instead of using a cached response. |

Default JSON request:

```json
{
  "params": {
    "count": "25",
    "sort_field": "dayvolume",
    "sort_type": "ASC"
  },
  "nocache": false
}
```

Example JSON response shape:

```json
{
  "status": "success",
  "data": {},
  "metadata": {
    "cached": false,
    "credits": {
      "cost": 1
    }
  }
}
```

### Get top gaining stocks

Retrieve the current list of stocks with the largest gains.

- Endpoint ID: `yahoo-finance-top-gainers`
- Request: `POST https://api.zenapi.io/v1/yahoo-finance/stocks/top-gainers`
- Credit cost: 1 credit
- Interactive test: https://zenapi.io/dashboard/api-explorer?endpoint=yahoo-finance-top-gainers

| Field | Location | Type | Required | Default | Description |
| --- | --- | --- | --- | --- | --- |
| `count` | params | string | no | `25` | Maximum number of stocks requested from the provider. |
| `sort_field` | params | string | no | `percentchange` | Provider field used to order the market list. |
| `sort_type` | params | select | no | `ASC` | Choose the provider sort direction. |
| `nocache` | root | boolean | no | `false` | Request fresh provider data instead of using a cached response. |

Default JSON request:

```json
{
  "params": {
    "count": "25",
    "sort_field": "percentchange",
    "sort_type": "ASC"
  },
  "nocache": false
}
```

Example JSON response shape:

```json
{
  "status": "success",
  "data": {},
  "metadata": {
    "cached": false,
    "credits": {
      "cost": 1
    }
  }
}
```

### Get top losing stocks

Retrieve the current list of stocks with the largest losses.

- Endpoint ID: `yahoo-finance-top-losers`
- Request: `POST https://api.zenapi.io/v1/yahoo-finance/stocks/top-losers`
- Credit cost: 1 credit
- Interactive test: https://zenapi.io/dashboard/api-explorer?endpoint=yahoo-finance-top-losers

| Field | Location | Type | Required | Default | Description |
| --- | --- | --- | --- | --- | --- |
| `count` | params | string | no | `25` | Maximum number of stocks requested from the provider. |
| `sort_field` | params | string | no | `percentchange` | Provider field used to order the market list. |
| `sort_type` | params | select | no | `ASC` | Choose the provider sort direction. |
| `nocache` | root | boolean | no | `false` | Request fresh provider data instead of using a cached response. |

Default JSON request:

```json
{
  "params": {
    "count": "25",
    "sort_field": "percentchange",
    "sort_type": "ASC"
  },
  "nocache": false
}
```

Example JSON response shape:

```json
{
  "status": "success",
  "data": {},
  "metadata": {
    "cached": false,
    "credits": {
      "cost": 1
    }
  }
}
```

---

# IMDb API

## IMDb: Search

### Search IMDb titles

Find movies and TV titles using a text query and optional filters.

- Endpoint ID: `imdb-search`
- Request: `POST https://api.zenapi.io/v1/imdb/search`
- Credit cost: 1 credit
- Interactive test: https://zenapi.io/dashboard/api-explorer?endpoint=imdb-search

| Field | Location | Type | Required | Default | Description |
| --- | --- | --- | --- | --- | --- |
| `query` | root | string | yes | `Interstellar` | Enter a movie, series, or title name. |
| `type` | params | string | no | `movie` | Optional provider title type, such as movie. |
| `genre` | params | string | no | — | Optional IMDb genre filter, such as Drama. |
| `rows` | params | string | no | `25` | Maximum number of search results requested from the provider. |
| `sortOrder` | params | select | no | — | Optional provider sort direction. |
| `sortField` | params | string | no | — | Optional provider field used to order search results. |
| `nocache` | root | boolean | no | `false` | Request fresh provider data instead of using a cached response. |

Default JSON request:

```json
{
  "query": "Interstellar",
  "params": {
    "type": "movie",
    "rows": "25"
  },
  "nocache": false
}
```

Example JSON response shape:

```json
{
  "status": "success",
  "data": {},
  "metadata": {
    "cached": false,
    "credits": {
      "cost": 1
    }
  }
}
```

## IMDb: Titles

### Get IMDb title

Retrieve detailed IMDb data for a movie or TV title ID.

- Endpoint ID: `imdb-title-get`
- Request: `POST https://api.zenapi.io/v1/imdb/titles/get`
- Credit cost: 1 credit
- Interactive test: https://zenapi.io/dashboard/api-explorer?endpoint=imdb-title-get

| Field | Location | Type | Required | Default | Description |
| --- | --- | --- | --- | --- | --- |
| `target` | root | string | yes | `tt0816692` | Enter an IMDb title ID beginning with tt. |
| `nocache` | root | boolean | no | `false` | Request fresh provider data instead of using a cached response. |

Default JSON request:

```json
{
  "target": "tt0816692",
  "nocache": false
}
```

Example JSON response shape:

```json
{
  "status": "success",
  "data": {},
  "metadata": {
    "cached": false,
    "credits": {
      "cost": 1
    }
  }
}
```

### Get IMDb rating

Retrieve IMDb rating data for a movie or TV title ID.

- Endpoint ID: `imdb-title-rating`
- Request: `POST https://api.zenapi.io/v1/imdb/titles/rating`
- Credit cost: 1 credit
- Interactive test: https://zenapi.io/dashboard/api-explorer?endpoint=imdb-title-rating

| Field | Location | Type | Required | Default | Description |
| --- | --- | --- | --- | --- | --- |
| `target` | root | string | yes | `tt0816692` | Enter an IMDb title ID beginning with tt. |
| `nocache` | root | boolean | no | `false` | Request fresh provider data instead of using a cached response. |

Default JSON request:

```json
{
  "target": "tt0816692",
  "nocache": false
}
```

Example JSON response shape:

```json
{
  "status": "success",
  "data": {},
  "metadata": {
    "cached": false,
    "credits": {
      "cost": 1
    }
  }
}
```

### Get IMDb title cast

Retrieve cast members for a movie or TV title ID.

- Endpoint ID: `imdb-title-cast`
- Request: `POST https://api.zenapi.io/v1/imdb/titles/cast`
- Credit cost: 1 credit
- Interactive test: https://zenapi.io/dashboard/api-explorer?endpoint=imdb-title-cast

| Field | Location | Type | Required | Default | Description |
| --- | --- | --- | --- | --- | --- |
| `target` | root | string | yes | `tt0816692` | Enter an IMDb title ID beginning with tt. |
| `nocache` | root | boolean | no | `false` | Request fresh provider data instead of using a cached response. |

Default JSON request:

```json
{
  "target": "tt0816692",
  "nocache": false
}
```

Example JSON response shape:

```json
{
  "status": "success",
  "data": {},
  "metadata": {
    "cached": false,
    "credits": {
      "cost": 1
    }
  }
}
```

### Get similar IMDb titles

Retrieve movies and TV titles similar to an IMDb title ID.

- Endpoint ID: `imdb-title-similar`
- Request: `POST https://api.zenapi.io/v1/imdb/titles/similar`
- Credit cost: 1 credit
- Interactive test: https://zenapi.io/dashboard/api-explorer?endpoint=imdb-title-similar

| Field | Location | Type | Required | Default | Description |
| --- | --- | --- | --- | --- | --- |
| `target` | root | string | yes | `tt0816692` | Enter an IMDb title ID beginning with tt. |
| `nocache` | root | boolean | no | `false` | Request fresh provider data instead of using a cached response. |

Default JSON request:

```json
{
  "target": "tt0816692",
  "nocache": false
}
```

Example JSON response shape:

```json
{
  "status": "success",
  "data": {},
  "metadata": {
    "cached": false,
    "credits": {
      "cost": 1
    }
  }
}
```

## IMDb: People

### Get IMDb person

Retrieve IMDb profile data for an actor, director, or other person.

- Endpoint ID: `imdb-name-get`
- Request: `POST https://api.zenapi.io/v1/imdb/names/get`
- Credit cost: 1 credit
- Interactive test: https://zenapi.io/dashboard/api-explorer?endpoint=imdb-name-get

| Field | Location | Type | Required | Default | Description |
| --- | --- | --- | --- | --- | --- |
| `target` | root | string | yes | `nm0000001` | Enter an IMDb person ID beginning with nm. |
| `nocache` | root | boolean | no | `false` | Request fresh provider data instead of using a cached response. |

Default JSON request:

```json
{
  "target": "nm0000001",
  "nocache": false
}
```

Example JSON response shape:

```json
{
  "status": "success",
  "data": {},
  "metadata": {
    "cached": false,
    "credits": {
      "cost": 1
    }
  }
}
```

## IMDb: Lists

### Get IMDb Top 250 movies

Retrieve the current IMDb Top 250 movies list.

- Endpoint ID: `imdb-top-250-movies`
- Request: `POST https://api.zenapi.io/v1/imdb/lists/top250-movies`
- Credit cost: 1 credit
- Interactive test: https://zenapi.io/dashboard/api-explorer?endpoint=imdb-top-250-movies

| Field | Location | Type | Required | Default | Description |
| --- | --- | --- | --- | --- | --- |
| `nocache` | root | boolean | no | `false` | Request fresh provider data instead of using a cached response. |

Default JSON request:

```json
{
  "nocache": false
}
```

Example JSON response shape:

```json
{
  "status": "success",
  "data": {},
  "metadata": {
    "cached": false,
    "credits": {
      "cost": 1
    }
  }
}
```

### Get popular IMDb movies

Retrieve the current IMDb most-popular movies list.

- Endpoint ID: `imdb-most-popular-movies`
- Request: `POST https://api.zenapi.io/v1/imdb/lists/most-popular-movies`
- Credit cost: 1 credit
- Interactive test: https://zenapi.io/dashboard/api-explorer?endpoint=imdb-most-popular-movies

| Field | Location | Type | Required | Default | Description |
| --- | --- | --- | --- | --- | --- |
| `nocache` | root | boolean | no | `false` | Request fresh provider data instead of using a cached response. |

Default JSON request:

```json
{
  "nocache": false
}
```

Example JSON response shape:

```json
{
  "status": "success",
  "data": {},
  "metadata": {
    "cached": false,
    "credits": {
      "cost": 1
    }
  }
}
```

---

# Reddit API

## Reddit: Search

### Search Reddit

Use Search Reddit to retrieve data from Reddit.

- Endpoint ID: `reddit-search`
- Request: `POST https://api.zenapi.io/v1/reddit/search`
- Credit cost: 5 credits
- Interactive test: https://zenapi.io/dashboard/api-explorer?endpoint=reddit-search

| Field | Location | Type | Required | Default | Description |
| --- | --- | --- | --- | --- | --- |
| `query` | root | string | yes | `investing` | Enter the search query. |
| `subreddit` | params | string | no | `wallstreetbets` | Optional provider parameter: subreddit. |
| `filter` | params | string | no | `posts` | Optional provider parameter: filter. |
| `timeFilter` | params | string | no | `year` | Optional provider parameter: timeFilter. |
| `sortType` | params | string | no | `relevance` | Optional provider parameter: sortType. |
| `nocache` | root | boolean | no | `false` | Request fresh provider data instead of using a cached response. |

Default JSON request:

```json
{
  "nocache": false,
  "query": "investing",
  "params": {
    "subreddit": "wallstreetbets",
    "filter": "posts",
    "timeFilter": "year",
    "sortType": "relevance"
  }
}
```

Example JSON response shape:

```json
{
  "status": "success",
  "data": {},
  "metadata": {
    "cached": false,
    "credits": {
      "cost": 5
    }
  }
}
```

## Reddit: Subreddits

### Get subreddit posts

Use Get subreddit posts to retrieve data from Reddit.

- Endpoint ID: `reddit-subreddit-posts`
- Request: `POST https://api.zenapi.io/v1/reddit/subreddits/posts`
- Credit cost: 5 credits
- Interactive test: https://zenapi.io/dashboard/api-explorer?endpoint=reddit-subreddit-posts

| Field | Location | Type | Required | Default | Description |
| --- | --- | --- | --- | --- | --- |
| `target` | root | string | yes | `https://www.reddit.com/r/AskReddit/` | Enter the subreddit url. |
| `filter` | params | string | no | `hot` | Optional provider parameter: filter. |
| `nocache` | root | boolean | no | `false` | Request fresh provider data instead of using a cached response. |

Default JSON request:

```json
{
  "nocache": false,
  "target": "https://www.reddit.com/r/AskReddit/",
  "params": {
    "filter": "hot"
  }
}
```

Example JSON response shape:

```json
{
  "status": "success",
  "data": {},
  "metadata": {
    "cached": false,
    "credits": {
      "cost": 5
    }
  }
}
```

### Get subreddit details

Use Get subreddit details to retrieve data from Reddit.

- Endpoint ID: `reddit-subreddit-get`
- Request: `POST https://api.zenapi.io/v1/reddit/subreddits/get`
- Credit cost: 5 credits
- Interactive test: https://zenapi.io/dashboard/api-explorer?endpoint=reddit-subreddit-get

| Field | Location | Type | Required | Default | Description |
| --- | --- | --- | --- | --- | --- |
| `target` | root | string | yes | `AskReddit` | Enter the subreddit name. |
| `nocache` | root | boolean | no | `false` | Request fresh provider data instead of using a cached response. |

Default JSON request:

```json
{
  "nocache": false,
  "target": "AskReddit"
}
```

Example JSON response shape:

```json
{
  "status": "success",
  "data": {},
  "metadata": {
    "cached": false,
    "credits": {
      "cost": 5
    }
  }
}
```

### Get subreddit comments

Use Get subreddit comments to retrieve data from Reddit.

- Endpoint ID: `reddit-subreddit-comments`
- Request: `POST https://api.zenapi.io/v1/reddit/subreddits/comments`
- Credit cost: 5 credits
- Interactive test: https://zenapi.io/dashboard/api-explorer?endpoint=reddit-subreddit-comments

| Field | Location | Type | Required | Default | Description |
| --- | --- | --- | --- | --- | --- |
| `target` | root | string | yes | `AskReddit` | Enter the subreddit name. |
| `nocache` | root | boolean | no | `false` | Request fresh provider data instead of using a cached response. |

Default JSON request:

```json
{
  "nocache": false,
  "target": "AskReddit"
}
```

Example JSON response shape:

```json
{
  "status": "success",
  "data": {},
  "metadata": {
    "cached": false,
    "credits": {
      "cost": 5
    }
  }
}
```

## Reddit: Posts

### Get Reddit post

Use Get Reddit post to retrieve data from Reddit.

- Endpoint ID: `reddit-post-get`
- Request: `POST https://api.zenapi.io/v1/reddit/posts/get`
- Credit cost: 5 credits
- Interactive test: https://zenapi.io/dashboard/api-explorer?endpoint=reddit-post-get

| Field | Location | Type | Required | Default | Description |
| --- | --- | --- | --- | --- | --- |
| `target` | root | string | yes | `https://www.reddit.com/r/AskReddit/` | Enter the reddit post url. |
| `nocache` | root | boolean | no | `false` | Request fresh provider data instead of using a cached response. |

Default JSON request:

```json
{
  "nocache": false,
  "target": "https://www.reddit.com/r/AskReddit/"
}
```

Example JSON response shape:

```json
{
  "status": "success",
  "data": {},
  "metadata": {
    "cached": false,
    "credits": {
      "cost": 5
    }
  }
}
```

## Reddit: Discovery

### Get popular subreddits

Use Get popular subreddits to retrieve data from Reddit.

- Endpoint ID: `reddit-subreddits-popular`
- Request: `POST https://api.zenapi.io/v1/reddit/subreddits/popular`
- Credit cost: 5 credits
- Interactive test: https://zenapi.io/dashboard/api-explorer?endpoint=reddit-subreddits-popular

| Field | Location | Type | Required | Default | Description |
| --- | --- | --- | --- | --- | --- |
| `nocache` | root | boolean | no | `false` | Request fresh provider data instead of using a cached response. |

Default JSON request:

```json
{
  "nocache": false
}
```

Example JSON response shape:

```json
{
  "status": "success",
  "data": {},
  "metadata": {
    "cached": false,
    "credits": {
      "cost": 5
    }
  }
}
```

### Get new subreddits

Use Get new subreddits to retrieve data from Reddit.

- Endpoint ID: `reddit-subreddits-new`
- Request: `POST https://api.zenapi.io/v1/reddit/subreddits/new`
- Credit cost: 5 credits
- Interactive test: https://zenapi.io/dashboard/api-explorer?endpoint=reddit-subreddits-new

| Field | Location | Type | Required | Default | Description |
| --- | --- | --- | --- | --- | --- |
| `nocache` | root | boolean | no | `false` | Request fresh provider data instead of using a cached response. |

Default JSON request:

```json
{
  "nocache": false
}
```

Example JSON response shape:

```json
{
  "status": "success",
  "data": {},
  "metadata": {
    "cached": false,
    "credits": {
      "cost": 5
    }
  }
}
```

## Reddit: Users

### Get user stats

Use Get user stats to retrieve data from Reddit.

- Endpoint ID: `reddit-user-stats`
- Request: `POST https://api.zenapi.io/v1/reddit/users/stats`
- Credit cost: 5 credits
- Interactive test: https://zenapi.io/dashboard/api-explorer?endpoint=reddit-user-stats

| Field | Location | Type | Required | Default | Description |
| --- | --- | --- | --- | --- | --- |
| `target` | root | string | yes | `spez` | Enter the reddit username. |
| `nocache` | root | boolean | no | `false` | Request fresh provider data instead of using a cached response. |

Default JSON request:

```json
{
  "nocache": false,
  "target": "spez"
}
```

Example JSON response shape:

```json
{
  "status": "success",
  "data": {},
  "metadata": {
    "cached": false,
    "credits": {
      "cost": 5
    }
  }
}
```

### Get user activity

Use Get user activity to retrieve data from Reddit.

- Endpoint ID: `reddit-user-data`
- Request: `POST https://api.zenapi.io/v1/reddit/users/data`
- Credit cost: 5 credits
- Interactive test: https://zenapi.io/dashboard/api-explorer?endpoint=reddit-user-data

| Field | Location | Type | Required | Default | Description |
| --- | --- | --- | --- | --- | --- |
| `target` | root | string | yes | `spez` | Enter the reddit username. |
| `filter` | params | string | no | `comments` | Optional provider parameter: filter. |
| `sortType` | params | string | no | `new` | Optional provider parameter: sortType. |
| `nocache` | root | boolean | no | `false` | Request fresh provider data instead of using a cached response. |

Default JSON request:

```json
{
  "nocache": false,
  "target": "spez",
  "params": {
    "filter": "comments",
    "sortType": "new"
  }
}
```

Example JSON response shape:

```json
{
  "status": "success",
  "data": {},
  "metadata": {
    "cached": false,
    "credits": {
      "cost": 5
    }
  }
}
```

---

# Google Maps API

## Google Maps: Search

### Search places

Find businesses and places using a natural-language query.

- Endpoint ID: `google-maps-search`
- Request: `POST https://api.zenapi.io/v1/google-maps/search`
- Credit cost: 1 credit
- Interactive test: https://zenapi.io/dashboard/api-explorer?endpoint=google-maps-search

| Field | Location | Type | Required | Default | Description |
| --- | --- | --- | --- | --- | --- |
| `query` | root | string | yes | `Coffee shops in Kyiv` | Describe the place or business you want to find. |
| `country` | params | string | no | `ua` | Optional two-letter country code. |
| `lang` | params | string | no | `en` | Optional two-letter response language. |
| `limit` | params | string | no | `20` | Maximum number of results requested from the provider. |
| `lat` | params | string | no | — | Optional latitude used to center the search area. |
| `lng` | params | string | no | — | Optional longitude used to center the search area. |
| `offset` | params | string | no | `0` | Zero-based result offset for pagination. |
| `zoom` | params | string | no | `13` | Map zoom level used to scope the search area. |
| `nocache` | root | boolean | no | `false` | Request fresh provider data instead of using a cached response. |

Default JSON request:

```json
{
  "query": "Coffee shops in Kyiv",
  "params": {
    "country": "ua",
    "lang": "en",
    "limit": "20",
    "offset": "0",
    "zoom": "13"
  },
  "nocache": false
}
```

Example JSON response shape:

```json
{
  "status": "success",
  "data": [],
  "metadata": {
    "cached": false,
    "credits": {
      "cost": 1
    }
  }
}
```

### Search nearby places

Find businesses and places near a specific map coordinate.

- Endpoint ID: `google-maps-nearby`
- Request: `POST https://api.zenapi.io/v1/google-maps/nearby`
- Credit cost: 1 credit
- Interactive test: https://zenapi.io/dashboard/api-explorer?endpoint=google-maps-nearby

| Field | Location | Type | Required | Default | Description |
| --- | --- | --- | --- | --- | --- |
| `query` | root | string | yes | `Cafe` | Describe the type of nearby place you want to find. |
| `lat` | params | string | yes | `48.8577848` | Latitude of the center point for the nearby search. |
| `lng` | params | string | yes | `2.2888379` | Longitude of the center point for the nearby search. |
| `country` | params | string | no | `fr` | Optional two-letter country code. |
| `lang` | params | string | no | `en` | Optional two-letter response language. |
| `limit` | params | string | no | `20` | Maximum number of nearby results requested from the provider. |
| `offset` | params | string | no | `0` | Zero-based result offset for pagination. |
| `zoom` | params | string | no | `12` | Map zoom level used to scope the nearby search area. |
| `nocache` | root | boolean | no | `false` | Request fresh provider data instead of using a cached response. |

Default JSON request:

```json
{
  "query": "Cafe",
  "params": {
    "lat": "48.8577848",
    "lng": "2.2888379",
    "country": "fr",
    "lang": "en",
    "limit": "20",
    "offset": "0",
    "zoom": "12"
  },
  "nocache": false
}
```

Example JSON response shape:

```json
{
  "status": "success",
  "data": [],
  "metadata": {
    "cached": false,
    "credits": {
      "cost": 1
    }
  }
}
```

## Google Maps: Places

### Get place details

Retrieve detailed information for a Google Maps business ID.

- Endpoint ID: `google-maps-place-get`
- Request: `POST https://api.zenapi.io/v1/google-maps/places/get`
- Credit cost: 1 credit
- Interactive test: https://zenapi.io/dashboard/api-explorer?endpoint=google-maps-place-get

| Field | Location | Type | Required | Default | Description |
| --- | --- | --- | --- | --- | --- |
| `target` | root | string | yes | `0x47f4eb87e91f866d:0x9629fabb993eb66` | Enter the Google Maps business_id returned by a search response. |
| `place_id` | params | string | no | — | Optional Google place_id when it is available in search results. |
| `country` | params | string | no | `fr` | Optional two-letter country code. |
| `lang` | params | string | no | `en` | Optional two-letter response language. |
| `nocache` | root | boolean | no | `false` | Request fresh provider data instead of using a cached response. |

Default JSON request:

```json
{
  "target": "0x47f4eb87e91f866d:0x9629fabb993eb66",
  "params": {
    "country": "fr",
    "lang": "en"
  },
  "nocache": false
}
```

Example JSON response shape:

```json
{
  "status": "success",
  "data": {},
  "metadata": {
    "cached": false,
    "credits": {
      "cost": 1
    }
  }
}
```

## Google Maps: Locations

### Geocode an address

Resolve an address or place name into map location data.

- Endpoint ID: `google-maps-geocoding-get`
- Request: `POST https://api.zenapi.io/v1/google-maps/geocoding/get`
- Credit cost: 1 credit
- Interactive test: https://zenapi.io/dashboard/api-explorer?endpoint=google-maps-geocoding-get

| Field | Location | Type | Required | Default | Description |
| --- | --- | --- | --- | --- | --- |
| `query` | root | string | yes | `Place de la Navigation, Paris` | Enter a complete address, landmark, or place name. |
| `country` | params | string | no | `fr` | Optional two-letter country code used to narrow the result. |
| `lang` | params | string | no | `en` | Optional two-letter response language. |
| `nocache` | root | boolean | no | `false` | Request fresh provider data instead of using a cached response. |

Default JSON request:

```json
{
  "query": "Place de la Navigation, Paris",
  "params": {
    "country": "fr",
    "lang": "en"
  },
  "nocache": false
}
```

Example JSON response shape:

```json
{
  "status": "success",
  "data": {},
  "metadata": {
    "cached": false,
    "credits": {
      "cost": 1
    }
  }
}
```

### Identify a map location

Discover the address and nearby place at a latitude and longitude.

- Endpoint ID: `google-maps-what-is-here`
- Request: `POST https://api.zenapi.io/v1/google-maps/locations/what-is-here`
- Credit cost: 1 credit
- Interactive test: https://zenapi.io/dashboard/api-explorer?endpoint=google-maps-what-is-here

| Field | Location | Type | Required | Default | Description |
| --- | --- | --- | --- | --- | --- |
| `lat` | params | string | yes | `48.8719556` | Latitude of the location to identify. |
| `lng` | params | string | yes | `2.3415407` | Longitude of the location to identify. |
| `country` | params | string | no | `fr` | Optional two-letter country code. |
| `lang` | params | string | no | `en` | Optional two-letter response language. |
| `nocache` | root | boolean | no | `false` | Request fresh provider data instead of using a cached response. |

Default JSON request:

```json
{
  "params": {
    "lat": "48.8719556",
    "lng": "2.3415407",
    "country": "fr",
    "lang": "en"
  },
  "nocache": false
}
```

Example JSON response shape:

```json
{
  "status": "success",
  "data": {},
  "metadata": {
    "cached": false,
    "credits": {
      "cost": 1
    }
  }
}
```

## Google Maps: Reviews & Media

### List place reviews

Retrieve reviews for a Google Maps business ID.

- Endpoint ID: `google-maps-reviews-list`
- Request: `POST https://api.zenapi.io/v1/google-maps/reviews/list`
- Credit cost: 1 credit
- Interactive test: https://zenapi.io/dashboard/api-explorer?endpoint=google-maps-reviews-list

| Field | Location | Type | Required | Default | Description |
| --- | --- | --- | --- | --- | --- |
| `target` | root | string | yes | `0x47f4ea8ed352d3c5:0x7bb3bc00dfc039a9` | Enter the Google Maps business_id returned by a search response. |
| `country` | params | string | no | `us` | Optional two-letter country code. |
| `lang` | params | string | no | `en` | Optional two-letter response language. |
| `limit` | params | string | no | `20` | Maximum number of reviews requested from the provider. |
| `sort` | params | string | no | `Relevant` | Provider review sorting mode, such as Relevant. |
| `nocache` | root | boolean | no | `false` | Request fresh provider data instead of using a cached response. |

Default JSON request:

```json
{
  "target": "0x47f4ea8ed352d3c5:0x7bb3bc00dfc039a9",
  "params": {
    "country": "us",
    "lang": "en",
    "limit": "20",
    "sort": "Relevant"
  },
  "nocache": false
}
```

Example JSON response shape:

```json
{
  "status": "success",
  "data": [],
  "metadata": {
    "cached": false,
    "credits": {
      "cost": 1
    }
  }
}
```

### List place photos

Retrieve photos for a Google Maps business ID.

- Endpoint ID: `google-maps-photos-list`
- Request: `POST https://api.zenapi.io/v1/google-maps/photos/list`
- Credit cost: 1 credit
- Interactive test: https://zenapi.io/dashboard/api-explorer?endpoint=google-maps-photos-list

| Field | Location | Type | Required | Default | Description |
| --- | --- | --- | --- | --- | --- |
| `target` | root | string | yes | `0x47e66e2964e34e2d:0x8ddca9ee380ef7e0` | Enter the Google Maps business_id returned by a search response. |
| `country` | params | string | no | `us` | Optional two-letter country code. |
| `lang` | params | string | no | `en` | Optional two-letter response language. |
| `nocache` | root | boolean | no | `false` | Request fresh provider data instead of using a cached response. |

Default JSON request:

```json
{
  "target": "0x47e66e2964e34e2d:0x8ddca9ee380ef7e0",
  "params": {
    "country": "us",
    "lang": "en"
  },
  "nocache": false
}
```

Example JSON response shape:

```json
{
  "status": "success",
  "data": [],
  "metadata": {
    "cached": false,
    "credits": {
      "cost": 1
    }
  }
}
```

---

# Google Search API

## Google Search: Images

### Search Google Images

Find image results for a keyword or search phrase.

- Endpoint ID: `google-search-images`
- Request: `POST https://api.zenapi.io/v1/google-search/images/search`
- Credit cost: 10 credits
- Interactive test: https://zenapi.io/dashboard/api-explorer?endpoint=google-search-images

| Field | Location | Type | Required | Default | Description |
| --- | --- | --- | --- | --- | --- |
| `query` | root | string | yes | `World Cup` | Enter the keyword or phrase to search for images. |
| `gl` | params | string | no | `us` | Two-letter Google country code used to localize results. |
| `lr` | params | string | no | `lang_en` | Google language restriction, such as lang_en. |
| `num` | params | string | no | `10` | Number of image results requested from the provider. |
| `page` | params | string | no | `1` | Result page requested from the provider. |
| `nocache` | root | boolean | no | `false` | Request fresh provider data instead of using a cached response. |

Default JSON request:

```json
{
  "query": "World Cup",
  "params": {
    "gl": "us",
    "lr": "lang_en",
    "num": "10",
    "page": "1"
  },
  "nocache": false
}
```

Example JSON response shape:

```json
{
  "status": "success",
  "data": {},
  "metadata": {
    "cached": false,
    "credits": {
      "cost": 10
    }
  }
}
```

---

# YouTube API

## YouTube: Videos

### Get video details

Use Get video details to retrieve data from YouTube.

- Endpoint ID: `youtube-video-get`
- Request: `POST https://api.zenapi.io/v1/youtube/videos/get`
- Credit cost: 4 credits
- Interactive test: https://zenapi.io/dashboard/api-explorer?endpoint=youtube-video-get

| Field | Location | Type | Required | Default | Description |
| --- | --- | --- | --- | --- | --- |
| `target` | root | string | yes | `PuQFESk0BrA` | Enter the youtube video id. |
| `nocache` | root | boolean | no | `false` | Request fresh provider data instead of using a cached response. |

Default JSON request:

```json
{
  "nocache": false,
  "target": "PuQFESk0BrA"
}
```

Example JSON response shape:

```json
{
  "status": "success",
  "data": {},
  "metadata": {
    "cached": false,
    "credits": {
      "cost": 4
    }
  }
}
```

### Get video data

Use Get video data to retrieve data from YouTube.

- Endpoint ID: `youtube-video-data`
- Request: `POST https://api.zenapi.io/v1/youtube/videos/data`
- Credit cost: 4 credits
- Interactive test: https://zenapi.io/dashboard/api-explorer?endpoint=youtube-video-data

| Field | Location | Type | Required | Default | Description |
| --- | --- | --- | --- | --- | --- |
| `target` | root | string | yes | `PuQFESk0BrA` | Enter the youtube video id. |
| `nocache` | root | boolean | no | `false` | Request fresh provider data instead of using a cached response. |

Default JSON request:

```json
{
  "nocache": false,
  "target": "PuQFESk0BrA"
}
```

Example JSON response shape:

```json
{
  "status": "success",
  "data": {},
  "metadata": {
    "cached": false,
    "credits": {
      "cost": 4
    }
  }
}
```

### Get video comments

Use Get video comments to retrieve data from YouTube.

- Endpoint ID: `youtube-video-comments`
- Request: `POST https://api.zenapi.io/v1/youtube/videos/comments`
- Credit cost: 4 credits
- Interactive test: https://zenapi.io/dashboard/api-explorer?endpoint=youtube-video-comments

| Field | Location | Type | Required | Default | Description |
| --- | --- | --- | --- | --- | --- |
| `target` | root | string | yes | `PuQFESk0BrA` | Enter the youtube video id. |
| `nocache` | root | boolean | no | `false` | Request fresh provider data instead of using a cached response. |

Default JSON request:

```json
{
  "nocache": false,
  "target": "PuQFESk0BrA"
}
```

Example JSON response shape:

```json
{
  "status": "success",
  "data": {},
  "metadata": {
    "cached": false,
    "credits": {
      "cost": 4
    }
  }
}
```

### Get video subtitles

Use Get video subtitles to retrieve data from YouTube.

- Endpoint ID: `youtube-video-subtitles`
- Request: `POST https://api.zenapi.io/v1/youtube/videos/subtitles`
- Credit cost: 4 credits
- Interactive test: https://zenapi.io/dashboard/api-explorer?endpoint=youtube-video-subtitles

| Field | Location | Type | Required | Default | Description |
| --- | --- | --- | --- | --- | --- |
| `target` | root | string | yes | `PuQFESk0BrA` | Enter the youtube video id. |
| `nocache` | root | boolean | no | `false` | Request fresh provider data instead of using a cached response. |

Default JSON request:

```json
{
  "nocache": false,
  "target": "PuQFESk0BrA"
}
```

Example JSON response shape:

```json
{
  "status": "success",
  "data": {},
  "metadata": {
    "cached": false,
    "credits": {
      "cost": 4
    }
  }
}
```

### Get video recommendations

Use Get video recommendations to retrieve data from YouTube.

- Endpoint ID: `youtube-video-recommendations`
- Request: `POST https://api.zenapi.io/v1/youtube/videos/recommendations`
- Credit cost: 4 credits
- Interactive test: https://zenapi.io/dashboard/api-explorer?endpoint=youtube-video-recommendations

| Field | Location | Type | Required | Default | Description |
| --- | --- | --- | --- | --- | --- |
| `target` | root | string | yes | `PuQFESk0BrA` | Enter the youtube video id. |
| `nocache` | root | boolean | no | `false` | Request fresh provider data instead of using a cached response. |

Default JSON request:

```json
{
  "nocache": false,
  "target": "PuQFESk0BrA"
}
```

Example JSON response shape:

```json
{
  "status": "success",
  "data": {},
  "metadata": {
    "cached": false,
    "credits": {
      "cost": 4
    }
  }
}
```

### Get video screenshot

Use Get video screenshot to retrieve data from YouTube.

- Endpoint ID: `youtube-video-screenshot`
- Request: `POST https://api.zenapi.io/v1/youtube/videos/screenshot`
- Credit cost: 4 credits
- Interactive test: https://zenapi.io/dashboard/api-explorer?endpoint=youtube-video-screenshot

| Field | Location | Type | Required | Default | Description |
| --- | --- | --- | --- | --- | --- |
| `target` | root | string | yes | `PuQFESk0BrA` | Enter the youtube video id. |
| `nocache` | root | boolean | no | `false` | Request fresh provider data instead of using a cached response. |

Default JSON request:

```json
{
  "nocache": false,
  "target": "PuQFESk0BrA"
}
```

Example JSON response shape:

```json
{
  "status": "success",
  "data": {},
  "metadata": {
    "cached": false,
    "credits": {
      "cost": 4
    }
  }
}
```

## YouTube: Channels

### Find channel ID

Use Find channel ID to retrieve data from YouTube.

- Endpoint ID: `youtube-channel-id`
- Request: `POST https://api.zenapi.io/v1/youtube/channels/id`
- Credit cost: 4 credits
- Interactive test: https://zenapi.io/dashboard/api-explorer?endpoint=youtube-channel-id

| Field | Location | Type | Required | Default | Description |
| --- | --- | --- | --- | --- | --- |
| `target` | root | string | yes | `MrBeast` | Enter the channel name. |
| `nocache` | root | boolean | no | `false` | Request fresh provider data instead of using a cached response. |

Default JSON request:

```json
{
  "nocache": false,
  "target": "MrBeast"
}
```

Example JSON response shape:

```json
{
  "status": "success",
  "data": {},
  "metadata": {
    "cached": false,
    "credits": {
      "cost": 4
    }
  }
}
```

### Get channel details

Use Get channel details to retrieve data from YouTube.

- Endpoint ID: `youtube-channel-get`
- Request: `POST https://api.zenapi.io/v1/youtube/channels/get`
- Credit cost: 4 credits
- Interactive test: https://zenapi.io/dashboard/api-explorer?endpoint=youtube-channel-get

| Field | Location | Type | Required | Default | Description |
| --- | --- | --- | --- | --- | --- |
| `target` | root | string | yes | `UCX6OQ3DkcsbYNE6H8uQQuVA` | Enter the youtube channel id. |
| `nocache` | root | boolean | no | `false` | Request fresh provider data instead of using a cached response. |

Default JSON request:

```json
{
  "nocache": false,
  "target": "UCX6OQ3DkcsbYNE6H8uQQuVA"
}
```

Example JSON response shape:

```json
{
  "status": "success",
  "data": {},
  "metadata": {
    "cached": false,
    "credits": {
      "cost": 4
    }
  }
}
```

### Get channel videos

Use Get channel videos to retrieve data from YouTube.

- Endpoint ID: `youtube-channel-videos`
- Request: `POST https://api.zenapi.io/v1/youtube/channels/videos`
- Credit cost: 4 credits
- Interactive test: https://zenapi.io/dashboard/api-explorer?endpoint=youtube-channel-videos

| Field | Location | Type | Required | Default | Description |
| --- | --- | --- | --- | --- | --- |
| `target` | root | string | yes | `UCX6OQ3DkcsbYNE6H8uQQuVA` | Enter the youtube channel id. |
| `nocache` | root | boolean | no | `false` | Request fresh provider data instead of using a cached response. |

Default JSON request:

```json
{
  "nocache": false,
  "target": "UCX6OQ3DkcsbYNE6H8uQQuVA"
}
```

Example JSON response shape:

```json
{
  "status": "success",
  "data": {},
  "metadata": {
    "cached": false,
    "credits": {
      "cost": 4
    }
  }
}
```

### Get channel shorts

Use Get channel shorts to retrieve data from YouTube.

- Endpoint ID: `youtube-channel-shorts`
- Request: `POST https://api.zenapi.io/v1/youtube/channels/shorts`
- Credit cost: 4 credits
- Interactive test: https://zenapi.io/dashboard/api-explorer?endpoint=youtube-channel-shorts

| Field | Location | Type | Required | Default | Description |
| --- | --- | --- | --- | --- | --- |
| `target` | root | string | yes | `UCX6OQ3DkcsbYNE6H8uQQuVA` | Enter the youtube channel id. |
| `nocache` | root | boolean | no | `false` | Request fresh provider data instead of using a cached response. |

Default JSON request:

```json
{
  "nocache": false,
  "target": "UCX6OQ3DkcsbYNE6H8uQQuVA"
}
```

Example JSON response shape:

```json
{
  "status": "success",
  "data": {},
  "metadata": {
    "cached": false,
    "credits": {
      "cost": 4
    }
  }
}
```

### Search within a channel

Use Search within a channel to retrieve data from YouTube.

- Endpoint ID: `youtube-channel-search`
- Request: `POST https://api.zenapi.io/v1/youtube/channels/search`
- Credit cost: 4 credits
- Interactive test: https://zenapi.io/dashboard/api-explorer?endpoint=youtube-channel-search

| Field | Location | Type | Required | Default | Description |
| --- | --- | --- | --- | --- | --- |
| `query` | root | string | yes | `technology` | Enter the search query. |
| `lang` | params | string | no | `en` | Optional provider parameter: lang. |
| `country` | params | string | no | `us` | Optional provider parameter: country. |
| `channel_id` | params | string | no | — | Optional provider parameter: channel_id. |
| `nocache` | root | boolean | no | `false` | Request fresh provider data instead of using a cached response. |

Default JSON request:

```json
{
  "nocache": false,
  "query": "technology",
  "params": {
    "lang": "en",
    "country": "us"
  }
}
```

Example JSON response shape:

```json
{
  "status": "success",
  "data": {},
  "metadata": {
    "cached": false,
    "credits": {
      "cost": 4
    }
  }
}
```

## YouTube: Search

### Search YouTube

Use Search YouTube to retrieve data from YouTube.

- Endpoint ID: `youtube-search`
- Request: `POST https://api.zenapi.io/v1/youtube/search`
- Credit cost: 4 credits
- Interactive test: https://zenapi.io/dashboard/api-explorer?endpoint=youtube-search

| Field | Location | Type | Required | Default | Description |
| --- | --- | --- | --- | --- | --- |
| `query` | root | string | yes | `bobby lee` | Enter the search query. |
| `lang` | params | string | no | `en` | Optional provider parameter: lang. |
| `country` | params | string | no | `us` | Optional provider parameter: country. |
| `order_by` | params | string | no | `this_month` | Optional provider parameter: order_by. |
| `nocache` | root | boolean | no | `false` | Request fresh provider data instead of using a cached response. |

Default JSON request:

```json
{
  "nocache": false,
  "query": "bobby lee",
  "params": {
    "lang": "en",
    "country": "us",
    "order_by": "this_month"
  }
}
```

Example JSON response shape:

```json
{
  "status": "success",
  "data": {},
  "metadata": {
    "cached": false,
    "credits": {
      "cost": 4
    }
  }
}
```

## YouTube: Discovery

### Get trending videos

Use Get trending videos to retrieve data from YouTube.

- Endpoint ID: `youtube-trending`
- Request: `POST https://api.zenapi.io/v1/youtube/trending`
- Credit cost: 4 credits
- Interactive test: https://zenapi.io/dashboard/api-explorer?endpoint=youtube-trending

| Field | Location | Type | Required | Default | Description |
| --- | --- | --- | --- | --- | --- |
| `lang` | params | string | no | `en` | Optional provider parameter: lang. |
| `country` | params | string | no | `us` | Optional provider parameter: country. |
| `section` | params | string | no | `Now` | Optional provider parameter: section. |
| `nocache` | root | boolean | no | `false` | Request fresh provider data instead of using a cached response. |

Default JSON request:

```json
{
  "nocache": false,
  "params": {
    "lang": "en",
    "country": "us",
    "section": "Now"
  }
}
```

Example JSON response shape:

```json
{
  "status": "success",
  "data": {},
  "metadata": {
    "cached": false,
    "credits": {
      "cost": 4
    }
  }
}
```

---

# LinkedIn API

## LinkedIn: Profiles

### Get profile

Use Get profile to retrieve data from LinkedIn.

- Endpoint ID: `linkedin-profile-get`
- Request: `POST https://api.zenapi.io/v1/linkedin/profiles/get`
- Credit cost: 25 credits
- Interactive test: https://zenapi.io/dashboard/api-explorer?endpoint=linkedin-profile-get

| Field | Location | Type | Required | Default | Description |
| --- | --- | --- | --- | --- | --- |
| `target` | root | string | yes | `satyanadella` | Enter the linkedin username. |
| `nocache` | root | boolean | no | `false` | Request fresh provider data instead of using a cached response. |

Default JSON request:

```json
{
  "nocache": false,
  "target": "satyanadella"
}
```

Example JSON response shape:

```json
{
  "status": "success",
  "data": {},
  "metadata": {
    "cached": false,
    "credits": {
      "cost": 25
    }
  }
}
```

### Get profile by URL

Use Get profile by URL to retrieve data from LinkedIn.

- Endpoint ID: `linkedin-profile-by-url`
- Request: `POST https://api.zenapi.io/v1/linkedin/profiles/get-by-url`
- Credit cost: 25 credits
- Interactive test: https://zenapi.io/dashboard/api-explorer?endpoint=linkedin-profile-by-url

| Field | Location | Type | Required | Default | Description |
| --- | --- | --- | --- | --- | --- |
| `target` | root | string | yes | `https://www.linkedin.com/in/satyanadella/` | Enter the linkedin profile url. |
| `nocache` | root | boolean | no | `false` | Request fresh provider data instead of using a cached response. |

Default JSON request:

```json
{
  "nocache": false,
  "target": "https://www.linkedin.com/in/satyanadella/"
}
```

Example JSON response shape:

```json
{
  "status": "success",
  "data": {},
  "metadata": {
    "cached": false,
    "credits": {
      "cost": 25
    }
  }
}
```

### Search people

Use Search people to retrieve data from LinkedIn.

- Endpoint ID: `linkedin-profile-search`
- Request: `POST https://api.zenapi.io/v1/linkedin/profiles/search`
- Credit cost: 25 credits
- Interactive test: https://zenapi.io/dashboard/api-explorer?endpoint=linkedin-profile-search

| Field | Location | Type | Required | Default | Description |
| --- | --- | --- | --- | --- | --- |
| `query` | root | string | yes | `software engineer` | Enter the search query. |
| `start` | params | string | no | `0` | Optional provider parameter: start. |
| `nocache` | root | boolean | no | `false` | Request fresh provider data instead of using a cached response. |

Default JSON request:

```json
{
  "nocache": false,
  "query": "software engineer",
  "params": {
    "start": "0"
  }
}
```

Example JSON response shape:

```json
{
  "status": "success",
  "data": {},
  "metadata": {
    "cached": false,
    "credits": {
      "cost": 25
    }
  }
}
```

### Get profile posts

Use Get profile posts to retrieve data from LinkedIn.

- Endpoint ID: `linkedin-profile-posts`
- Request: `POST https://api.zenapi.io/v1/linkedin/profiles/posts`
- Credit cost: 25 credits
- Interactive test: https://zenapi.io/dashboard/api-explorer?endpoint=linkedin-profile-posts

| Field | Location | Type | Required | Default | Description |
| --- | --- | --- | --- | --- | --- |
| `target` | root | string | yes | `satyanadella` | Enter the linkedin username. |
| `nocache` | root | boolean | no | `false` | Request fresh provider data instead of using a cached response. |

Default JSON request:

```json
{
  "nocache": false,
  "target": "satyanadella"
}
```

Example JSON response shape:

```json
{
  "status": "success",
  "data": {},
  "metadata": {
    "cached": false,
    "credits": {
      "cost": 25
    }
  }
}
```

### Get profile comments

Use Get profile comments to retrieve data from LinkedIn.

- Endpoint ID: `linkedin-profile-comments`
- Request: `POST https://api.zenapi.io/v1/linkedin/profiles/comments`
- Credit cost: 25 credits
- Interactive test: https://zenapi.io/dashboard/api-explorer?endpoint=linkedin-profile-comments

| Field | Location | Type | Required | Default | Description |
| --- | --- | --- | --- | --- | --- |
| `target` | root | string | yes | `satyanadella` | Enter the linkedin username. |
| `nocache` | root | boolean | no | `false` | Request fresh provider data instead of using a cached response. |

Default JSON request:

```json
{
  "nocache": false,
  "target": "satyanadella"
}
```

Example JSON response shape:

```json
{
  "status": "success",
  "data": {},
  "metadata": {
    "cached": false,
    "credits": {
      "cost": 25
    }
  }
}
```

### Get connection count

Use Get connection count to retrieve data from LinkedIn.

- Endpoint ID: `linkedin-connection-count`
- Request: `POST https://api.zenapi.io/v1/linkedin/profiles/connection-count`
- Credit cost: 25 credits
- Interactive test: https://zenapi.io/dashboard/api-explorer?endpoint=linkedin-connection-count

| Field | Location | Type | Required | Default | Description |
| --- | --- | --- | --- | --- | --- |
| `target` | root | string | yes | `satyanadella` | Enter the linkedin username. |
| `nocache` | root | boolean | no | `false` | Request fresh provider data instead of using a cached response. |

Default JSON request:

```json
{
  "nocache": false,
  "target": "satyanadella"
}
```

Example JSON response shape:

```json
{
  "status": "success",
  "data": {},
  "metadata": {
    "cached": false,
    "credits": {
      "cost": 25
    }
  }
}
```

### Get recent activity

Use Get recent activity to retrieve data from LinkedIn.

- Endpoint ID: `linkedin-profile-activity`
- Request: `POST https://api.zenapi.io/v1/linkedin/profiles/recent-activity`
- Credit cost: 25 credits
- Interactive test: https://zenapi.io/dashboard/api-explorer?endpoint=linkedin-profile-activity

| Field | Location | Type | Required | Default | Description |
| --- | --- | --- | --- | --- | --- |
| `target` | root | string | yes | `satyanadella` | Enter the linkedin username. |
| `nocache` | root | boolean | no | `false` | Request fresh provider data instead of using a cached response. |

Default JSON request:

```json
{
  "nocache": false,
  "target": "satyanadella"
}
```

Example JSON response shape:

```json
{
  "status": "success",
  "data": {},
  "metadata": {
    "cached": false,
    "credits": {
      "cost": 25
    }
  }
}
```

### Get similar profiles

Use Get similar profiles to retrieve data from LinkedIn.

- Endpoint ID: `linkedin-similar-profiles`
- Request: `POST https://api.zenapi.io/v1/linkedin/profiles/similar`
- Credit cost: 25 credits
- Interactive test: https://zenapi.io/dashboard/api-explorer?endpoint=linkedin-similar-profiles

| Field | Location | Type | Required | Default | Description |
| --- | --- | --- | --- | --- | --- |
| `target` | root | string | yes | `https://www.linkedin.com/in/satyanadella/` | Enter the linkedin profile url. |
| `nocache` | root | boolean | no | `false` | Request fresh provider data instead of using a cached response. |

Default JSON request:

```json
{
  "nocache": false,
  "target": "https://www.linkedin.com/in/satyanadella/"
}
```

Example JSON response shape:

```json
{
  "status": "success",
  "data": {},
  "metadata": {
    "cached": false,
    "credits": {
      "cost": 25
    }
  }
}
```

### Get position skills

Use Get position skills to retrieve data from LinkedIn.

- Endpoint ID: `linkedin-position-skills`
- Request: `POST https://api.zenapi.io/v1/linkedin/profiles/position-skills`
- Credit cost: 25 credits
- Interactive test: https://zenapi.io/dashboard/api-explorer?endpoint=linkedin-position-skills

| Field | Location | Type | Required | Default | Description |
| --- | --- | --- | --- | --- | --- |
| `target` | root | string | yes | `satyanadella` | Enter the linkedin username. |
| `nocache` | root | boolean | no | `false` | Request fresh provider data instead of using a cached response. |

Default JSON request:

```json
{
  "nocache": false,
  "target": "satyanadella"
}
```

Example JSON response shape:

```json
{
  "status": "success",
  "data": {},
  "metadata": {
    "cached": false,
    "credits": {
      "cost": 25
    }
  }
}
```

### Get top positions

Use Get top positions to retrieve data from LinkedIn.

- Endpoint ID: `linkedin-top-positions`
- Request: `POST https://api.zenapi.io/v1/linkedin/profiles/top-positions`
- Credit cost: 25 credits
- Interactive test: https://zenapi.io/dashboard/api-explorer?endpoint=linkedin-top-positions

| Field | Location | Type | Required | Default | Description |
| --- | --- | --- | --- | --- | --- |
| `target` | root | string | yes | `satyanadella` | Enter the linkedin username. |
| `nocache` | root | boolean | no | `false` | Request fresh provider data instead of using a cached response. |

Default JSON request:

```json
{
  "nocache": false,
  "target": "satyanadella"
}
```

Example JSON response shape:

```json
{
  "status": "success",
  "data": {},
  "metadata": {
    "cached": false,
    "credits": {
      "cost": 25
    }
  }
}
```

### Get posted jobs

Use Get posted jobs to retrieve data from LinkedIn.

- Endpoint ID: `linkedin-posted-jobs`
- Request: `POST https://api.zenapi.io/v1/linkedin/profiles/posted-jobs`
- Credit cost: 25 credits
- Interactive test: https://zenapi.io/dashboard/api-explorer?endpoint=linkedin-posted-jobs

| Field | Location | Type | Required | Default | Description |
| --- | --- | --- | --- | --- | --- |
| `target` | root | string | yes | `satyanadella` | Enter the linkedin username. |
| `nocache` | root | boolean | no | `false` | Request fresh provider data instead of using a cached response. |

Default JSON request:

```json
{
  "nocache": false,
  "target": "satyanadella"
}
```

Example JSON response shape:

```json
{
  "status": "success",
  "data": {},
  "metadata": {
    "cached": false,
    "credits": {
      "cost": 25
    }
  }
}
```

### Get profile articles

Use Get profile articles to retrieve data from LinkedIn.

- Endpoint ID: `linkedin-profile-articles`
- Request: `POST https://api.zenapi.io/v1/linkedin/profiles/articles`
- Credit cost: 25 credits
- Interactive test: https://zenapi.io/dashboard/api-explorer?endpoint=linkedin-profile-articles

| Field | Location | Type | Required | Default | Description |
| --- | --- | --- | --- | --- | --- |
| `target` | root | string | yes | `satyanadella` | Enter the linkedin username. |
| `nocache` | root | boolean | no | `false` | Request fresh provider data instead of using a cached response. |

Default JSON request:

```json
{
  "nocache": false,
  "target": "satyanadella"
}
```

Example JSON response shape:

```json
{
  "status": "success",
  "data": {},
  "metadata": {
    "cached": false,
    "credits": {
      "cost": 25
    }
  }
}
```

## LinkedIn: Companies

### Get company

Use Get company to retrieve data from LinkedIn.

- Endpoint ID: `linkedin-company-get`
- Request: `POST https://api.zenapi.io/v1/linkedin/companies/get`
- Credit cost: 25 credits
- Interactive test: https://zenapi.io/dashboard/api-explorer?endpoint=linkedin-company-get

| Field | Location | Type | Required | Default | Description |
| --- | --- | --- | --- | --- | --- |
| `target` | root | string | yes | `google` | Enter the company username. |
| `nocache` | root | boolean | no | `false` | Request fresh provider data instead of using a cached response. |

Default JSON request:

```json
{
  "nocache": false,
  "target": "google"
}
```

Example JSON response shape:

```json
{
  "status": "success",
  "data": {},
  "metadata": {
    "cached": false,
    "credits": {
      "cost": 25
    }
  }
}
```

### Get company by ID

Use Get company by ID to retrieve data from LinkedIn.

- Endpoint ID: `linkedin-company-by-id`
- Request: `POST https://api.zenapi.io/v1/linkedin/companies/get-by-id`
- Credit cost: 25 credits
- Interactive test: https://zenapi.io/dashboard/api-explorer?endpoint=linkedin-company-by-id

| Field | Location | Type | Required | Default | Description |
| --- | --- | --- | --- | --- | --- |
| `target` | root | string | yes | `1441` | Enter the linkedin company id. |
| `nocache` | root | boolean | no | `false` | Request fresh provider data instead of using a cached response. |

Default JSON request:

```json
{
  "nocache": false,
  "target": "1441"
}
```

Example JSON response shape:

```json
{
  "status": "success",
  "data": {},
  "metadata": {
    "cached": false,
    "credits": {
      "cost": 25
    }
  }
}
```

### Get company by domain

Use Get company by domain to retrieve data from LinkedIn.

- Endpoint ID: `linkedin-company-by-domain`
- Request: `POST https://api.zenapi.io/v1/linkedin/companies/get-by-domain`
- Credit cost: 25 credits
- Interactive test: https://zenapi.io/dashboard/api-explorer?endpoint=linkedin-company-by-domain

| Field | Location | Type | Required | Default | Description |
| --- | --- | --- | --- | --- | --- |
| `target` | root | string | yes | `google.com` | Enter the company domain. |
| `nocache` | root | boolean | no | `false` | Request fresh provider data instead of using a cached response. |

Default JSON request:

```json
{
  "nocache": false,
  "target": "google.com"
}
```

Example JSON response shape:

```json
{
  "status": "success",
  "data": {},
  "metadata": {
    "cached": false,
    "credits": {
      "cost": 25
    }
  }
}
```

### Get company insights

Use Get company insights to retrieve data from LinkedIn.

- Endpoint ID: `linkedin-company-insights`
- Request: `POST https://api.zenapi.io/v1/linkedin/companies/insights`
- Credit cost: 25 credits
- Interactive test: https://zenapi.io/dashboard/api-explorer?endpoint=linkedin-company-insights

| Field | Location | Type | Required | Default | Description |
| --- | --- | --- | --- | --- | --- |
| `target` | root | string | yes | `google` | Enter the company username. |
| `nocache` | root | boolean | no | `false` | Request fresh provider data instead of using a cached response. |

Default JSON request:

```json
{
  "nocache": false,
  "target": "google"
}
```

Example JSON response shape:

```json
{
  "status": "success",
  "data": {},
  "metadata": {
    "cached": false,
    "credits": {
      "cost": 25
    }
  }
}
```

### Get company jobs count

Use Get company jobs count to retrieve data from LinkedIn.

- Endpoint ID: `linkedin-company-jobs-count`
- Request: `POST https://api.zenapi.io/v1/linkedin/companies/jobs-count`
- Credit cost: 25 credits
- Interactive test: https://zenapi.io/dashboard/api-explorer?endpoint=linkedin-company-jobs-count

| Field | Location | Type | Required | Default | Description |
| --- | --- | --- | --- | --- | --- |
| `target` | root | string | yes | `1441` | Enter the linkedin company id. |
| `nocache` | root | boolean | no | `false` | Request fresh provider data instead of using a cached response. |

Default JSON request:

```json
{
  "nocache": false,
  "target": "1441"
}
```

Example JSON response shape:

```json
{
  "status": "success",
  "data": {},
  "metadata": {
    "cached": false,
    "credits": {
      "cost": 25
    }
  }
}
```

### Get company posts

Use Get company posts to retrieve data from LinkedIn.

- Endpoint ID: `linkedin-company-posts`
- Request: `POST https://api.zenapi.io/v1/linkedin/companies/posts`
- Credit cost: 25 credits
- Interactive test: https://zenapi.io/dashboard/api-explorer?endpoint=linkedin-company-posts

| Field | Location | Type | Required | Default | Description |
| --- | --- | --- | --- | --- | --- |
| `target` | root | string | yes | `google` | Enter the company username. |
| `start` | params | string | no | `0` | Optional provider parameter: start. |
| `nocache` | root | boolean | no | `false` | Request fresh provider data instead of using a cached response. |

Default JSON request:

```json
{
  "nocache": false,
  "target": "google",
  "params": {
    "start": "0"
  }
}
```

Example JSON response shape:

```json
{
  "status": "success",
  "data": {},
  "metadata": {
    "cached": false,
    "credits": {
      "cost": 25
    }
  }
}
```

## LinkedIn: Jobs

### Search jobs

Use Search jobs to retrieve data from LinkedIn.

- Endpoint ID: `linkedin-jobs-search`
- Request: `POST https://api.zenapi.io/v1/linkedin/jobs/search`
- Credit cost: 25 credits
- Interactive test: https://zenapi.io/dashboard/api-explorer?endpoint=linkedin-jobs-search

| Field | Location | Type | Required | Default | Description |
| --- | --- | --- | --- | --- | --- |
| `query` | root | string | yes | `golang` | Enter the search query. |
| `locationId` | params | string | no | `92000000` | Optional provider parameter: locationId. |
| `datePosted` | params | string | no | `anyTime` | Optional provider parameter: datePosted. |
| `sort` | params | string | no | `mostRelevant` | Optional provider parameter: sort. |
| `nocache` | root | boolean | no | `false` | Request fresh provider data instead of using a cached response. |

Default JSON request:

```json
{
  "nocache": false,
  "query": "golang",
  "params": {
    "locationId": "92000000",
    "datePosted": "anyTime",
    "sort": "mostRelevant"
  }
}
```

Example JSON response shape:

```json
{
  "status": "success",
  "data": {},
  "metadata": {
    "cached": false,
    "credits": {
      "cost": 25
    }
  }
}
```

### Get job details

Use Get job details to retrieve data from LinkedIn.

- Endpoint ID: `linkedin-job-get`
- Request: `POST https://api.zenapi.io/v1/linkedin/jobs/get`
- Credit cost: 25 credits
- Interactive test: https://zenapi.io/dashboard/api-explorer?endpoint=linkedin-job-get

| Field | Location | Type | Required | Default | Description |
| --- | --- | --- | --- | --- | --- |
| `target` | root | string | yes | `3738360408` | Enter the linkedin job id. |
| `nocache` | root | boolean | no | `false` | Request fresh provider data instead of using a cached response. |

Default JSON request:

```json
{
  "nocache": false,
  "target": "3738360408"
}
```

Example JSON response shape:

```json
{
  "status": "success",
  "data": {},
  "metadata": {
    "cached": false,
    "credits": {
      "cost": 25
    }
  }
}
```

## LinkedIn: Posts

### Get LinkedIn post

Use Get LinkedIn post to retrieve data from LinkedIn.

- Endpoint ID: `linkedin-post-get`
- Request: `POST https://api.zenapi.io/v1/linkedin/posts/get`
- Credit cost: 25 credits
- Interactive test: https://zenapi.io/dashboard/api-explorer?endpoint=linkedin-post-get

| Field | Location | Type | Required | Default | Description |
| --- | --- | --- | --- | --- | --- |
| `target` | root | string | yes | `https://www.linkedin.com/posts/example` | Enter the linkedin post url. |
| `nocache` | root | boolean | no | `false` | Request fresh provider data instead of using a cached response. |

Default JSON request:

```json
{
  "nocache": false,
  "target": "https://www.linkedin.com/posts/example"
}
```

Example JSON response shape:

```json
{
  "status": "success",
  "data": {},
  "metadata": {
    "cached": false,
    "credits": {
      "cost": 25
    }
  }
}
```

## LinkedIn: Locations

### Search locations

Use Search locations to retrieve data from LinkedIn.

- Endpoint ID: `linkedin-location-search`
- Request: `POST https://api.zenapi.io/v1/linkedin/locations/search`
- Credit cost: 25 credits
- Interactive test: https://zenapi.io/dashboard/api-explorer?endpoint=linkedin-location-search

| Field | Location | Type | Required | Default | Description |
| --- | --- | --- | --- | --- | --- |
| `query` | root | string | yes | `Kyiv` | Enter the location keyword. |
| `nocache` | root | boolean | no | `false` | Request fresh provider data instead of using a cached response. |

Default JSON request:

```json
{
  "nocache": false,
  "query": "Kyiv"
}
```

Example JSON response shape:

```json
{
  "status": "success",
  "data": {},
  "metadata": {
    "cached": false,
    "credits": {
      "cost": 25
    }
  }
}
```