Vimeo Content Capture API

API ID 9897

Deliver detailed Vimeo data in JSON format, including videos, channels, users, thumbnails, durations, follower counts, and related information for efficient integration.

100% uptime 2,492 ms avg response

API Documentation

Endpoints

Request

Retrieve comprehensive Vimeo channel data, including names, links, images, video counts, follower statistics, and metadata to optimize discovery and integration.

Endpoint ID: 18638
GET https://zylalabs.com/api/9897/vimeo+content+capture+api/18638/search+channel
INPUT PARAMETERS

Search Channel — Endpoint Features

Object Description
query Required Enter the name of a channel

Free test requests remaining: 3 of 3.


INPUT PARAMETERS

query
API EXAMPLE RESPONSE
JSON
{"status":"ok","request_id":"ba17628b-8757-482b-854a-6bd99739a350","message":null,"data":{"channels":[{"channel_id":"dpcgsoccer14","uri":"/channels/811003","name":"DePaul Catholic Girls Soccer","link":"https://vimeo.com/channels/dpcgsoccer14","pictures":{"sizes":[{"width":100,"height":75,"link":"https://i.vimeocdn.com/video/738214165-06474037a4f61b11f6f3b802a86a40091848b1a4c5025725b6b23fc9ce0c4a49-d_100x75?&r=pad&region=us","link_with_play_button":"https://i.vimeocdn.com/filter/overlay?src0=https%3A%2F%2Fi.vimeocdn.com%2Fvideo%2F738214165-06474037a4f61b11f6f3b802a86a40091848b1a4c5025725b6b23fc9ce0c4a49-d_100x75%3F%26region%3Dus&src1=http%3A%2F%2Ff.vimeocdn.com%2Fp%2Fimages%2Fcrawler_play.png"},{"width":200,"height":150,"link":"https://i.vimeocdn.com/video/738214165-06474037a4f61b11f6f3b802a86a40091848b1a4c5025725b6b23fc9ce0c4a49-d_200x150?&r=pad&region=us","link_with_play_button":"https://i.vimeocdn.com/filter/overlay?src0=https%3A%2F%2Fi.vimeocdn.com%2Fvideo%2F738214165-06474037a4f61b11f6f3b802a86a40091848b1a4c5025725b6b23fc9ce0c4a49-d_200x150%3F%26region%3Dus&src1=http%3A%2F%2Ff.vimeocdn.com%2Fp%2Fimages%2Fcrawler_play.png"},{"width":295,"height":166,"link":"https://i.vimeocdn.com/video/738214165-06474037a4f61b11f6f3b802a86a40091848b1a4c5025725b6b23fc9ce0c4a49-d_295x166?&r=pad&region=us","link_with_play_button":"https://i.vimeocdn.com/filter/overlay?src0=https%3A%2F%2Fi.vimeocdn.com%2Fvideo%2F738214165-06474037a4f61b11f6f3b802a86a40091848b1a4c5025725b6b23fc9ce0c4a49-d_295x166%3F%26region%3Dus&src1=http%3A%2F%2Ff.vimeocdn.com%2Fp%2Fimages%2Fcrawler_play.png"},{"width":640,"height":360,"link":"https://i.vimeocdn.com/video/738214165-06474037a4f61b11f6f3b802a86a40091848b1a4c5025725b6b23fc9ce0c4a49-d_640x360?&r=pad&region=us","link_with_play_button":"https://i.vimeocdn.com/filter/overlay?src0=https%3A%2F%2Fi.vimeocdn.com%2Fvideo%2F738214165-06474037a4f61b11f6f3b802a86a40091848b1a4c5025725b6b23fc9ce0c4a49-d_640x360%3F%26region%3Dus&src1=http%3A%2F%2Ff.vimeocdn.com%2Fp%2Fimages%2Fcrawler_play.png"},{"width":960,"height":540,"link":"https://i.vimeocdn.com/video/738214165-06474037a4f61b11f6f3b802a86a40091848b1a4c5025725b6b23fc9ce0c4a49-d_960x540?&r=pad&region=us","link_with_play_button":"https://i.vimeocdn.com/filter/overlay?src0=https%3A%2F%2Fi.vimeocdn.com%2Fvideo%2F738214165-06474037a4f61b11f6f3b802a86a40091848b1a4c5025725b6b23fc9ce0c4a49-d_960x540%3F%26region%3Dus&src1=http%3A%2F%2Ff.vimeocdn.com%2Fp%2Fimages%2Fcrawler_play.png"},{"width":1280,"height":720,"link":"https://i.vimeocdn.com/video/738214165-06474037a4f61b11f6f3b802a86a40091848b1a4c5025725b6b23fc9ce0c4a49-d_1280x720?&r=pad&region=us","link_with_play_button":"https://i.vimeocdn.com/filter/overlay?src0=https%3A%2F%2Fi.vimeocdn.com%2Fvideo%2F738214165-06474037a4f61b11f6f3b802a86a40091848b1a4c5025725b6b23fc9ce0c4a49-d_1280x720%3F%26region%3Dus&src1=http%3A%2F%2Ff.vimeocdn.com%2Fp%2Fimages%2Fcrawler_play.png"},{"width":1920,"height":1080,"link":"https://i.vimeocdn.com/video/738214165-06474037a4f61b11f6f3b802a86a40091848b1a4c5025725b6b23fc9ce0c4a49-d_1920x1080?&r=pad&region=us","link_with_play_button":"https://i.vimeocdn.com/filter/overlay?src0=https%3A%2F%2Fi.vimeocdn.com%2Fvideo%2F738214165-06474037a4f61b11f6f3b802a86a40091848b1a4c5025725b6b23fc9ce0c4a49-d_1920x1080%3F%26region%3Dus&src1=http%3A%2F%2Ff.vimeocdn.com%2Fp%2Fimages%2Fcrawler_play.png"}]},"metadata":{"connections":{"users":{"total":47},"videos":{"total":85}}}},{"channel_id":"soccerquebec","uri":"/channels/498556","name":"Soccer Québec","link":"https://vimeo.com/channels/soccerquebec","pictures":{"sizes":[{"width":100,"height":75,"link":"https://i.vimeocdn.com/video/745007830-f5095f5e2fae5c525df29357175a15b9167689dc518320b9c624f36fd3160b47-d_100x75?&r=pad&region=us","link_with_play_button":"https://i.vimeocdn.com/filter/overlay?src0=https%3A%2F%2Fi.vimeocdn.com%2Fvideo%2F745007830-f5095f5e2fae5c525df29357175a15b9167689dc518320b9c624f36fd3160b47-d_100x75%3F%26region%3Dus&src1=http%3A%2F%2Ff.vimeocdn.com%2Fp%2Fimages%2Fcrawler_play.png"},{"width":200,"height":150,"link":"https://i.vimeocdn.com/video/745007830-f5095f5e2fae5c525df29357175a15b9167689dc518320b9c624f36fd3160b47-d_200x150?&r=pad&region=us","link_with_play_button":"https://i.vimeocdn.com/filter/overlay?src0=https%3A%2F%2Fi.vimeocdn.com%2Fvideo%2F745007830-f5095f5e2fae5c525df29357175a15b9167689dc518320b9c624f36fd3160b47-d_200x150%3F%26region%3Dus&src1=http%3A%2F%2Ff.vimeocdn.com%2Fp%2Fimages%2Fcrawler_play.png"},{"width":295,"height":166,"link":"https://i.vimeocdn.com/video/745007830-f5095f5e2fae5c525df29357175a15b9167689dc518320b9c624f36fd3160b47-d_295x166?&r=pad&region=us","link_with_play_button":"https://i.vimeocdn.com/filter/overlay?src0=https%3A%2F%2Fi.vimeocdn.com%2Fvideo%2F745007830-f5095f5e2fae5c525df29357175a15b9167689dc518320b9c624f36fd3160b47-d_295x166%3F%26region%3Dus&src1=http%3A%2F%2Ff.vimeocdn.com%2Fp%2Fimages%2Fcrawler_play.png"},{"width":640,"height":360,"link":"https://i.vimeocdn.com/video/745007830-f5095f5e2fae5c525df29357175a15b9167689dc518320b9c624f36fd3160b47-d_640x360?&r=pad&region=us","link_with_play_button":"https://i.vimeocdn.com/filter/overlay?src0=https%3A%2F%2Fi.vimeocdn.com%2Fvideo%2F745007830-f5095f5e2fae5c525df29357175a15b9167689dc518320b9c624f36fd3160b47-d_640x360%3F%26region%3Dus&src1=http%3A%2F%2Ff.vimeocdn.com%2Fp%2Fimages%2Fcrawler_play.png"},{"width":960,"height":540,"link":"https://i.vimeocdn.com/video/745007830-f5095f5e2fae5c525df29357175a15b9167689dc518320b9c624f36fd3160b47-d_960x540?&r=pad&region=us","link_with_play_button":"https://i.vimeocdn.com/filter/overlay?src0=https%3A%2F%2Fi.vimeocdn.com%2Fvideo%2F745007830-f5095f5e2fae5c525df29357175a15b9167689dc518320b9c624f36fd3160b47-d_960x540%3F%26region%3Dus&src1=http%3A%2F%2Ff.vimeocdn.com%2Fp%2Fimages%2Fcrawler_play.png"},{"width":1280,"height":720,"link":"https://i.vimeocdn.com/video/745007830-f5095f5e2fae5c525df29357175a15b9167689dc518320b9c624f36fd3160b47-d_1280x720?&r=pad&region=us","link_with_play_button":"https://i.vimeocdn.com/filter/overlay?src0=https%3A%2F%2Fi.vimeocdn.com%2Fvideo%2F745007830-f5095f5e2fae5c525df29357175a15b9167689dc518320b9c624f36fd3160b47-d_1280x720%3F%26region%3Dus&src1=http%3A%2F%2Ff.vimeocdn.com%2Fp%2Fimages%2Fcrawler_play.png"},{"width":1920,"height":1080,"link":"https://i.vimeocdn.com/video/745007830-f5095f5e2fae5c525df29357175a15b9167689dc518320b9c624f36fd3160b47-d_1920x1080?&r=pad&region=us","link_with_play_button":"https://i.vimeocdn.com/filter/overlay?src0=https%3A%2F%2Fi.vimeocdn.com%2Fvideo%2F745007830-f5095f5e2fae5c525df29357175a15b9167689dc518320b9c624f36fd3160b47-d_1920x1080%3F%26region%3Dus&src1=http%3A%2F%2Ff.vimeocdn.com%2Fp%2Fimages%2Fcrawler_play.png"}]},"metadata":{"connections":{"users":{"total":20},"videos":{"total":15}}}},{"channel_id":"386141","uri":"/channels/386141","name":"Soccer","link":"https://vimeo.com/channels/386141","pictures":{"sizes":[{"width":100,"height":75,"link":"https://i.vimeocdn.com/video/335768753-d71602f0d2b9f8ffc8fc207c08f567e9f1aca2a191cec2f5c790d66602d07761-d_100x75?&r=pad&region=us","link_with_play_button":"https://i.vimeocdn.com/filter/overlay?src0=https%3A%2F%2Fi.vimeocdn.com%2Fvideo%2F335768753-d71602f0d2b9f8ffc8fc207c08f567e9f1aca2a191cec2f5c790d66602d07761-d_100x75%3F%26region%3Dus&src1=http%3A%2F%2Ff.vimeocdn.com%2Fp%2Fimages%2Fcrawler_play.png"},{"width":200,"height":150,"link":"https://i.vimeocdn.com/video/335768753-d71602f0d2b9f8ffc8fc207c08f567e9f1aca2a191cec2f5c790d66602d07761-d_200x150?&r=pad&region=us","link_with_play_button":"https://i.vimeocdn.com/filter/overlay?src0=https%3A%2F%2Fi.vimeocdn.com%2Fvideo%2F335768753-d71602f0d2b9f8ffc8fc207c08f567e9f1aca2a191cec2f5c790d66602d07761-d_200x150%3F%26region%3Dus&src1=http%3A%2F%2Ff.vimeocdn.com%2Fp%2Fimages%2Fcrawler_play.png"},{"width":295,"height":166,"link":"https://i.vimeocdn.com/video/335768753-d71602f0d2b9f8ffc8fc207c08f567e9f1aca2a191cec2f5c790d66602d07761-d_295x166?&r=pad&region=us","link_with_play_button":"https://i.vimeocdn.com/filter/overlay?src0=https%3A%2F%2Fi.vimeocdn.com%2Fvideo%2F335768753-d71602f0d2b9f8ffc8fc207c08f567e9f1aca2a191cec2f5c790d66602d07761-d_295x166%3F%26region%3Dus&src1=http%3A%2F%2Ff.vimeocdn.com%2Fp%2Fimages%2Fcrawler_play.png"},{"width":640,"height":360,"link":"https://i.vimeocdn.com/video/335768753-d71602f0d2b9f8ffc8fc207c08f567e9f1aca2a191cec2f5c790d66602d07761-d_640x360?&r=pad&region=us","link_with_play_button":"https://i.vimeocdn.com/filter/overlay?src0=https%3A%2F%2Fi.vimeocdn.com%2Fvideo%2F335768753-d71602f0d2b9f8ffc8fc207c08f567e9f1aca2a191cec2f5c790d66602d07761-d_640x360%3F%26region%3Dus&src1=http%3A%2F%2Ff.vimeocdn.com%2Fp%2Fimages%2Fcrawler_play.png"},{"width":960,"height":540,"link":"https://i.vimeocdn.com/video/335768753-d71602f0d2b9f8ffc8fc207c08f567e9f1aca2a191cec2f5c790d66602d07761-d_960x540?&r=pad&region=us","link_with_play_button":"https://i.vimeocdn.com/filter/overlay?src0=https%3A%2F%2Fi.vimeocdn.com%2Fvideo%2F335768753-d71602f0d2b9f8ffc8fc207c08f567e9f1aca2a191cec2f5c790d66602d07761-d_960x540%3F%26region%3Dus&src1=http%3A%2F%2Ff.vimeocdn.com%2Fp%2Fimages%2Fcrawler_play.png"},{"width":1280,"height":720,"link":"https://i.vimeocdn.com/video/335768753-d71602f0d2b9f8ffc8fc207c08f567e9f1aca2a191cec2f5c790d66602d07761-d_1280x720?&r=pad&region=us","link_with_play_button":"https://i.vimeocdn.com/filter/overlay?src0=https%3A%2F%2Fi.vimeocdn.com%2Fvideo%2F335768753-d71602f0d2b9f8ffc8fc207c08f567e9f1aca2a191cec2f5c790d66602d07761-d_1280x720%3F%26region%3Dus&src1=http%3A%2F%2Ff.vimeocdn.com%2Fp%2Fimages%2Fcrawler_play.png"},{"width":1920,"height":1080,"link":"https://i.vimeocdn.com/video/335768753-d71602f0d2b9f8ffc8fc207c08f567e9f1aca2a191cec2f5c790d66602d07761-d_1920x1080?&r=pad&region=us","link_with_play_button":"https://i.vimeocdn.com/filter/overlay?src0=https%3A%2F%2Fi.vimeocdn.com%2Fvideo%2F335768753-d71602f0d2b9f8ffc8fc207c08f567e9f1aca2a191cec2f5c790d66602d07761-d_1920x1080%3F%26region%3Dus&src1=http%3A%2F%2Ff.vimeocdn.com%2Fp%2Fimages%2Fcrawler_play.png"}]}}]},"_note":"Response truncated for documentation purposes"}
Search Channel — CODE SNIPPETS

curl --location --request GET 'https://zylalabs.com/api/9897/vimeo+content+capture+api/18638/search+channel?query=soccer' --header 'Authorization: Bearer YOUR_API_KEY' 


    
Request

Retrieve detailed Vimeo channel information including name, URL, header image, video count, followers, moderator status, and complete owner profile data.

Endpoint ID: 18641
GET https://zylalabs.com/api/9897/vimeo+content+capture+api/18641/channel+details
INPUT PARAMETERS

Channel Details — Endpoint Features

Object Description
channel_id Required Enter the name of a channel

Free test requests remaining: 3 of 3.


INPUT PARAMETERS

channel_id
API EXAMPLE RESPONSE
JSON
{"Example Response":"No response example available for now."}
Channel Details — CODE SNIPPETS

curl --location --request GET 'https://zylalabs.com/api/9897/vimeo+content+capture+api/18641/channel+details?channel_id=dpcgsoccer14' --header 'Authorization: Bearer YOUR_API_KEY' 


    
Request

Returns a list of Vimeo channels owned or followed by a user, including IDs, titles, links, thumbnails, video counts, and followers.

Endpoint ID: 18644
GET https://zylalabs.com/api/9897/vimeo+content+capture+api/18644/user+channels
INPUT PARAMETERS

User Channels — Endpoint Features

Object Description
username Required Enter a username

Free test requests remaining: 3 of 3.


INPUT PARAMETERS

username
API EXAMPLE RESPONSE
JSON
{"Example Response":"No response example available for now."}
User Channels — CODE SNIPPETS

curl --location --request GET 'https://zylalabs.com/api/9897/vimeo+content+capture+api/18644/user+channels?username=motigi' --header 'Authorization: Bearer YOUR_API_KEY' 


    
Request

Retrieve Vimeo user videos with IDs, titles, links, thumbnails, durations, resolutions, categories, metadata, creator profiles, and playback configuration details.

Endpoint ID: 18645
GET https://zylalabs.com/api/9897/vimeo+content+capture+api/18645/user+videos
INPUT PARAMETERS

User videos — Endpoint Features

Object Description
username Required Enter the name of the channel

Free test requests remaining: 3 of 3.


INPUT PARAMETERS

username
API EXAMPLE RESPONSE
JSON
{"status":"ok","request_id":"ce634b21-af34-45e1-a79e-9f74e192df2f","message":null,"data":{"videos":[],"cursor":null}}
User videos — CODE SNIPPETS

curl --location --request GET 'https://zylalabs.com/api/9897/vimeo+content+capture+api/18645/user+videos?username=ufc' --header 'Authorization: Bearer YOUR_API_KEY' 


    
Request

Retrieve complete Vimeo user profile information including identity, membership, profile images, location details, activity statistics, discovery preferences, verification status, and metadata.

Endpoint ID: 18646
GET https://zylalabs.com/api/9897/vimeo+content+capture+api/18646/user+details
INPUT PARAMETERS

User Details — Endpoint Features

Object Description
username Required Enter the name of the channel

Free test requests remaining: 3 of 3.


INPUT PARAMETERS

username
API EXAMPLE RESPONSE
JSON
{"status":"ok","request_id":"120b1b0a-4112-4171-8935-6bf6e103c07f","message":null,"data":{"user":[]}}
User Details — CODE SNIPPETS

curl --location --request GET 'https://zylalabs.com/api/9897/vimeo+content+capture+api/18646/user+details?username=ufc' --header 'Authorization: Bearer YOUR_API_KEY' 


    
Request

Search Vimeo users by query, returning profiles with names, usernames, links, profile images, follower counts, video totals, locations, and listed skills.

Endpoint ID: 18647
GET https://zylalabs.com/api/9897/vimeo+content+capture+api/18647/search+users
INPUT PARAMETERS

Search Users — Endpoint Features

Object Description
query Required Enter the name of the channel

Free test requests remaining: 3 of 3.


INPUT PARAMETERS

query
API EXAMPLE RESPONSE
JSON
{"status":"ok","request_id":"6eb5baec-aaf6-40b0-8156-530f93f77be8","message":null,"data":{"users":[],"cursor":null}}
Search Users — CODE SNIPPETS

curl --location --request GET 'https://zylalabs.com/api/9897/vimeo+content+capture+api/18647/search+users?query=ufc' --header 'Authorization: Bearer YOUR_API_KEY' 


    
Request

Search Vimeo videos by keyword, returning video IDs, titles, links, durations, creation dates, thumbnails, playback links, and related metadata for results.

Endpoint ID: 18648
GET https://zylalabs.com/api/9897/vimeo+content+capture+api/18648/search+videos
INPUT PARAMETERS

Search Videos — Endpoint Features

Object Description
query Required Indicates a keyword

Free test requests remaining: 3 of 3.


INPUT PARAMETERS

query
API EXAMPLE RESPONSE
JSON
{"Example Response":"No response example available for now."}
Search Videos — CODE SNIPPETS

curl --location --request GET 'https://zylalabs.com/api/9897/vimeo+content+capture+api/18648/search+videos?query=ufc' --header 'Authorization: Bearer YOUR_API_KEY' 


    

API Access Key & Authentication

After signing up, every developer is assigned a personal API access key, a unique combination of letters and digits provided to access to our API endpoint. To authenticate with the Vimeo Content Capture API simply include your bearer token in the Authorization header.

Headers
Header Description
Authorization Required Should be Bearer access_key. See "Your API Access Key" above when you are subscribed.

No long-term commitment. Upgrade, downgrade, or cancel anytime. Free Trial includes up to 50 requests.

(Save 2 months with annual billing 🎉)

🚀 Enterprise Plan

Starts at
$ 10,000/Year


  • Custom Volume
  • Custom Rate Limit
  • Specialized Customer Support
  • Real-Time API Monitoring

Overview

This API provides access to detailed, structured information about users of an online content platform, offering essential data for developers and applications that need to integrate user profiles efficiently and securely. With this API, you can obtain basic user information, such as their name, gender, account creation date, and activity status, as well as direct links to their profile and public content. It also provides access to data related to memberships and subscriptions, including membership type and any badges or special recognition awarded by the platform.

The API also includes details about profile images in multiple resolutions, allowing the display to be adapted to the needs of each application, from small thumbnails to high-resolution images. Developers can obtain information about the user's location, including city, state, and country, as well as precise geographic coordinates, facilitating geolocation-based features.

In summary, this API provides reliable, structured, and comprehensive access to platform user information, combining profile data, activity, location, and preferences, facilitating its use in multiple development and digital analysis contexts.

Vimeo Content Capture API FAQs

Each endpoint returns structured data related to Vimeo channels, users, and videos. For example, the GET User Details endpoint provides user identity, membership, profile images, and activity statistics, while the GET Search Videos endpoint returns video IDs, titles, links, and metadata.

Key fields vary by endpoint. For GET User Details, fields include name, profile images, location, and verification status. For GET Search Videos, fields include video IDs, titles, durations, and creation dates, allowing for comprehensive integration.

Response data is organized in JSON format, with each endpoint returning a structured object. For instance, the GET User Channels endpoint returns an array of channel objects, each containing IDs, titles, links, and thumbnails, making it easy to parse and utilize.

Parameters vary by endpoint. For GET Search Users, you can use a query string to filter results by name or username. GET User Videos may allow filtering by categories or metadata, enabling tailored data requests based on specific needs.

Typical use cases include building applications that display user profiles, aggregating video content for platforms, or analyzing user engagement metrics. For example, developers can create dashboards showcasing user activity or curate video playlists based on user preferences.

Data accuracy is maintained through regular updates from Vimeo's platform, ensuring that user profiles, video statistics, and channel information reflect the latest changes. This helps developers rely on the data for real-time applications and analytics.

Users can utilize returned data by integrating it into their applications for enhanced user experiences. For example, using profile images from GET User Details can personalize user interfaces, while video metadata from GET User Videos can enhance search functionalities.

Standard data patterns include consistent naming conventions for fields across endpoints, such as "id," "title," and "link." Users can expect structured arrays for lists, like channels or videos, facilitating straightforward data manipulation and display in applications.

General FAQs

To obtain your API key, first sign in to your account and navigate to the API you want to use. From the API's Pricing section, choose a plan and complete the subscription process. Once subscribed, return to the API page and you will see your API Access Key displayed at the top of the documentation page. You can use this key to authenticate your requests.

You can’t switch APIs during the free trial. If you subscribe to a different API, your trial will end and the new subscription will start as a paid plan.

The free trial lasts for 7 days and allows you to make up to 50 API requests.

No, the free trial is available only once, so we recommend using it on the API that interests you the most. Most of our APIs offer a free trial, but some may not include this option.

Yes. If the API offers a free trial, you will see a "Free 7-Day Trial" option in its Pricing section. The trial lasts for 7 days and allows up to 50 API requests, enabling you to evaluate the API before subscribing to a paid plan.

Zyla API Hub is like a big store for APIs, where you can find thousands of them all in one place. We also offer dedicated support and real-time monitoring of all APIs. Once you sign up, you can pick and choose which APIs you want to use. Just remember, each API needs its own subscription. But if you subscribe to multiple ones, you'll use the same key for all of them, making things easier for you.

Prices are listed in USD (United States Dollar), EUR (Euro), CAD (Canadian Dollar), AUD (Australian Dollar), and GBP (British Pound). We accept all major debit and credit cards. Our payment system uses the latest security technology and is powered by Stripe, one of the world's most reliable payment companies. If you have any trouble paying by card, just contact us at [email protected]

Additionally, if you already have an active subscription in any of these currencies (USD, EUR, CAD, AUD, GBP), that currency will remain for subsequent subscriptions. You can change the currency at any time as long as you don't have any active subscriptions.
The local currency shown on the pricing page is based on the country of your IP address and is provided for reference only. The actual prices are in USD (United States Dollar). When you make a payment, the charge will appear on your card statement in USD, even if you see the equivalent amount in your local currency on our website. This means you cannot pay directly with your local currency.
Occasionally, a bank may decline the charge due to its fraud protection settings. We suggest reaching out to your bank initially to check if they are blocking our charges. Also, you can access the Billing Portal and change the card associated to make the payment. If these does not work and you need further assistance, please contact our team at [email protected]
Prices are determined by a recurring monthly or yearly subscription, depending on the chosen plan.
API calls are deducted from your plan based on successful requests. Each plan comes with a specific number of calls that you can make per month. Only successful calls, indicated by a Status 200 response, will be counted against your total. This ensures that failed or incomplete requests do not impact your monthly quota.
Zyla API Hub works on a recurring monthly subscription system. Your billing cycle will start the day you purchase one of the paid plans, and it will renew the same day of the next month. So be aware to cancel your subscription beforehand if you want to avoid future charges.
To upgrade your current subscription plan, simply go to the pricing page of the API and select the plan you want to upgrade to. The upgrade will be instant, allowing you to immediately enjoy the features of the new plan. Please note that any remaining calls from your previous plan will not be carried over to the new plan, so be aware of this when upgrading. You will be charged the full amount of the new plan.
To check how many API calls you have left for the current month, refer to the 'X-Zyla-API-Calls-Monthly-Remaining' field in the response header. For example, if your plan allows 1,000 requests per month and you've used 100, this field in the response header will indicate 900 remaining calls.

You can monitor your API usage through the response headers included with every request:

x-zyla-api-calls-monthly-used: Shows the total number of API requests you have used during the current billing period.
x-zyla-api-calls-monthly-remaining: Shows the number of API requests you have remaining for the current billing period.

The 'X-Zyla-RateLimit-Reset' header shows the number of seconds until your rate limit resets. This tells you when your request count will start fresh. For example, if it displays 3,600, it means 3,600 seconds are left until the limit resets.

Yes, you can cancel your subscription at any time. Simply go to the Pricing section of the API you're subscribed to and click the "Unsubscribe" button.

Please note that upgrades, downgrades, and cancellations take effect immediately. Once your subscription is canceled, access to the service will end immediately, regardless of any remaining API calls in your quota.

After 7 days, you will be charged the full amount for the plan you were subscribed to during the trial. Therefore, it's important to cancel before the trial period ends. Refund requests for forgetting to cancel on time are not accepted.
When you subscribe to an API free trial, you can make up to 50 API calls. If you wish to make additional API calls beyond this limit, the API will prompt you to perform an "Start Your Paid Plan." You can find the "Start Your Paid Plan" button in your profile under Subscription -> Choose the API you are subscribed to -> Pricing tab.
You can contact us through our chat channel to receive immediate assistance. We are always online from 8 am to 5 pm (EST). If you reach us after that time, we will get back to you as soon as possible. Additionally, you can contact us via email at [email protected]

Please have a look at our Refund Policy: https://zylalabs.com/terms#refund


Related APIs