Spain Cost of Living API

Navigate the nuances of living costs in Spain with the Spain Cost of Living API. Explore essentials like housing, groceries, transportation, and entertainment. Gain insights into salaries and purchasing power, empowering your decisions in the dynamic realm of Spanish living.

About the API:

Embark on a comprehensive exploration of living costs in Spain with the Spain Cost of Living API. This powerful tool delves into the intricate details of essentials, including housing, groceries, transportation, and entertainment. By providing insights into average salaries and purchasing power, the API becomes an invaluable resource for individuals contemplating a move to Spain, businesses evaluating expansion opportunities, or investors seeking to understand the economic landscape.

Whether you are planning a relocation, a business expansion, or real estate investment in Spain, this API serves as a strategic guide. It enables expatriates to make informed decisions about their move, businesses to optimize budgets and employee compensation, and investors to assess the economic feasibility of various locations within Spain.

For travelers, the API becomes a valuable asset for budgeting purposes, ensuring that trips to Spain are not only enjoyable but also well-planned financially. HR professionals and recruiters can utilize the Spain Cost of Living API for salary benchmarking, ensuring that compensation packages align with the local cost of living, ultimately attracting and retaining top talent.

In essence, the Spain Cost of Living API opens a window into the economic heartbeat of Spain, facilitating data-driven decisions for a wide range of scenarios within the dynamic realm of living costs in this vibrant and diverse country.

 

What your API receives and what your API provides (input/output)?

This API will receive the city name and it will deliver a different range of prices for different goods and services. Check income and average prices. 

 

What are the most common uses cases of this API?

 

  • Expat Decision Support: The Spain Cost of Living API assists individuals contemplating a move to Spain by providing detailed insights into essential living costs, allowing them to make informed decisions about relocation.

  • Business Expansion Planning in Spain: Businesses planning to expand operations in Spain can utilize the API to assess the economic landscape, aiding in strategic decision-making regarding budgeting, compensation, and overall feasibility.

  • Real Estate Investment in Spain: Investors in Spanish real estate can leverage the API to analyze the cost of living, housing prices, and local purchasing power, facilitating data-driven decisions for successful real estate investments.

  • Travel Budgeting for Spain: Travelers planning trips to Spain can use the API to budget effectively by exploring costs related to accommodation, food, transportation, and entertainment, ensuring a well-managed and enjoyable travel experience.

  • HR Salary Benchmarking in Spain: HR professionals and recruiters can benefit from the API by benchmarking salaries in Spain. This ensures that compensation packages align with the local cost of living, aiding in the attraction and retention of top talent for businesses operating in the country.

 

 

Are there any limitations to your plans?

The only limitation is the number of API calls you can make per month that support each plan. 

API Documentation

Endpoints


Get a list of all the supported cities within the USA. 



                                                                            
GET https://www.zylalabs.com/api/3441/spain+cost+of+living+api/3746/get+cities
                                                                            
                                                                        

Get Cities - Endpoint Features

Object Description
Test Endpoint

API EXAMPLE RESPONSE

       
                                                                                                        
                                                                                                                                                                                                                            [{"id":2213,"country":"united-states","name":"Aberdeen, SD, United States","city":"aberdeen-sd","url":"\/country\/united-states\/city\/aberdeen-sd\/cost-of-living","iso3":"usa"},{"id":2214,"country":"united-states","name":"Aberdeen, WA, United States","city":"aberdeen-wa","url":"\/country\/united-states\/city\/aberdeen-wa\/cost-of-living","iso3":"usa"},{"id":2215,"country":"united-states","name":"Abilene, TX, United States","city":"abilene-tx","url":"\/country\/united-states\/city\/abilene-tx\/cost-of-living","iso3":"usa"},{"id":2216,"country":"united-states","name":"Abingdon, MD, United States","city":"abingdon-md","url":"\/country\/united-states\/city\/abingdon-md\/cost-of-living","iso3":"usa"},{"id":2217,"country":"united-states","name":"Adelanto, CA, United States","city":"adelanto-ca","url":"\/country\/united-states\/city\/adelanto-ca\/cost-of-living","iso3":"usa"},{"id":2218,"country":"united-states","name":"Akron, OH, United States","city":"akron-oh","url":"\/country\/united-states\/city\/akron-oh\/cost-of-living","iso3":"usa"},{"id":2219,"country":"united-states","name":"Alamogordo, NM, United States","city":"alamogordo-nm","url":"\/country\/united-states\/city\/alamogordo-nm\/cost-of-living","iso3":"usa"},{"id":2220,"country":"united-states","name":"Albany, GA, United States","city":"albany-ga","url":"\/country\/united-states\/city\/albany-ga\/cost-of-living","iso3":"usa"},{"id":2221,"country":"united-states","name":"Albany, NY, United States","city":"albany-ny","url":"\/country\/united-states\/city\/albany-ny\/cost-of-living","iso3":"usa"},{"id":2222,"country":"united-states","name":"Albany, OR, United States","city":"albany-or","url":"\/country\/united-states\/city\/albany-or\/cost-of-living","iso3":"usa"},{"id":2223,"country":"united-states","name":"Albert Lea, MN, United States","city":"albert-lea-mn","url":"\/country\/united-states\/city\/albert-lea-mn\/cost-of-living","iso3":"usa"},{"id":2224,"country":"united-states","name":"Albuquerque, NM, United States","city":"albuquerque-nm","url":"\/country\/united-states\/city\/albuquerque-nm\/cost-of-living","iso3":"usa"},{"id":2225,"country":"united-states","name":"Alexandria, LA, United States","city":"alexandria-la","url":"\/country\/united-states\/city\/alexandria-la\/cost-of-living","iso3":"usa"},{"id":2226,"country":"united-states","name":"Alexandria, MN, United States","city":"alexandria-mn","url":"\/country\/united-states\/city\/alexandria-mn\/cost-of-living","iso3":"usa"},{"id":2227,"country":"united-states","name":"Alexandria, VA, United States","city":"alexandria-va","url":"\/country\/united-states\/city\/alexandria-va\/cost-of-living","iso3":"usa"},{"id":2228,"country":"united-states","name":"Allen, TX, United States","city":"allen-tx","url":"\/country\/united-states\/city\/allen-tx\/cost-of-living","iso3":"usa"},{"id":2229,"country":"united-states","name":"Allentown, PA, United States","city":"allentown-pa","url":"\/country\/united-states\/city\/allentown-pa\/cost-of-living","iso3":"usa"},{"id":2230,"country":"united-states","name":"Alpena, MI, United States","city":"alpena-mi","url":"\/country\/united-states\/city\/alpena-mi\/cost-of-living","iso3":"usa"},{"id":2231,"country":"united-states","name":"Alpharetta, GA, United States","city":"alpharetta-ga","url":"\/country\/united-states\/city\/alpharetta-ga\/cost-of-living","iso3":"usa"},{"id":2232,"country":"united-states","name":"Alton, IL, United States","city":"alton-il","url":"\/country\/united-states\/city\/alton-il\/cost-of-living","iso3":"usa"},{"id":2233,"country":"united-states","name":"Amarillo, TX, United States","city":"amarillo-tx","url":"\/country\/united-states\/city\/amarillo-tx\/cost-of-living","iso3":"usa"},{"id":2234,"country":"united-states","name":"Ames, IA, United States","city":"ames-ia","url":"\/country\/united-states\/city\/ames-ia\/cost-of-living","iso3":"usa"},{"id":2235,"country":"united-states","name":"Anaheim, CA, United States","city":"anaheim-ca","url":"\/country\/united-states\/city\/anaheim-ca\/cost-of-living","iso3":"usa"},{"id":2236,"country":"united-states","name":"Anchorage, AK, United States","city":"anchorage-ak","url":"\/country\/united-states\/city\/anchorage-ak\/cost-of-living","iso3":"usa"},{"id":2237,"country":"united-states","name":"Anderson, SC, United States","city":"anderson-sc","url":"\/country\/united-states\/city\/anderson-sc\/cost-of-living","iso3":"usa"},{"id":2238,"country":"united-states","name":"Andover, MA, United States","city":"andover-ma","url":"\/country\/united-states\/city\/andover-ma\/cost-of-living","iso3":"usa"},{"id":2239,"country":"united-states","name":"Ann Arbor, MI, United States","city":"ann-arbor-mi","url":"\/country\/united-states\/city\/ann-arbor-mi\/cost-of-living","iso3":"usa"},{"id":2240,"country":"united-states","name":"Annapolis, MD, United States","city":"annapolis-md","url":"\/country\/united-states\/city\/annapolis-md\/cost-of-living","iso3":"usa"},{"id":2241,"country":"united-states","name":"Apple Valley, CA, United States","city":"apple-valley-ca","url":"\/country\/united-states\/city\/apple-valley-ca\/cost-of-living","iso3":"usa"},{"id":2242,"country":"united-states","name":"Appleton, WI, United States","city":"appleton-wi","url":"\/country\/united-states\/city\/appleton-wi\/cost-of-living","iso3":"usa"},{"id":2243,"country":"united-states","name":"Arlington, TX, United States","city":"arlington-tx","url":"\/country\/united-states\/city\/arlington-tx\/cost-of-living","iso3":"usa"},{"id":2244,"country":"united-states","name":"Arlington, VA, United States","city":"arlington-va","url":"\/country\/united-states\/city\/arlington-va\/cost-of-living","iso3":"usa"},{"id":2245,"country":"united-states","name":"Asheville, NC, United States","city":"asheville-nc","url":"\/country\/united-states\/city\/asheville-nc\/cost-of-living","iso3":"usa"},{"id":2246,"country":"united-states","name":"Ashland, MA, United States","city":"ashland-ma","url":"\/country\/united-states\/city\/ashland-ma\/cost-of-living","iso3":"usa"},{"id":2247,"country":"united-states","name":"Ashland, OH, United States","city":"ashland-oh","url":"\/country\/united-states\/city\/ashland-oh\/cost-of-living","iso3":"usa"},{"id":2248,"country":"united-states","name":"Aspen, CO, United States","city":"aspen-co","url":"\/country\/united-states\/city\/aspen-co\/cost-of-living","iso3":"usa"},{"id":2249,"country":"united-states","name":"Astoria, NY, United States","city":"astoria-ny","url":"\/country\/united-states\/city\/astoria-ny\/cost-of-living","iso3":"usa"},{"id":2250,"country":"united-states","name":"Astoria, OR, United States","city":"astoria-or","url":"\/country\/united-states\/city\/astoria-or\/cost-of-living","iso3":"usa"},{"id":2251,"country":"united-states","name":"Athens, GA, United States","city":"athens-ga","url":"\/country\/united-states\/city\/athens-ga\/cost-of-living","iso3":"usa"},{"id":2252,"country":"united-states","name":"Athens, OH, United States","city":"athens-oh","url":"\/country\/united-states\/city\/athens-oh\/cost-of-living","iso3":"usa"},{"id":2253,"country":"united-states","name":"Atlanta, GA, United States","city":"atlanta-ga","url":"\/country\/united-states\/city\/atlanta-ga\/cost-of-living","iso3":"usa"},{"id":2254,"country":"united-states","name":"Atlantic City, NJ, United States","city":"atlantic-city-nj","url":"\/country\/united-states\/city\/atlantic-city-nj\/cost-of-living","iso3":"usa"},{"id":2255,"country":"united-states","name":"Auburn, AL, United States","city":"auburn-al","url":"\/country\/united-states\/city\/auburn-al\/cost-of-living","iso3":"usa"},{"id":2256,"country":"united-states","name":"Augusta, GA, United States","city":"augusta-ga","url":"\/country\/united-states\/city\/augusta-ga\/cost-of-living","iso3":"usa"},{"id":2257,"country":"united-states","name":"Augusta, ME, United States","city":"augusta-me","url":"\/country\/united-states\/city\/augusta-me\/cost-of-living","iso3":"usa"},{"id":2258,"country":"united-states","name":"Aurora, IL, United States","city":"aurora-il","url":"\/country\/united-states\/city\/aurora-il\/cost-of-living","iso3":"usa"},{"id":2259,"country":"united-states","name":"Austin, TX, United States","city":"austin-tx","url":"\/country\/united-states\/city\/austin-tx\/cost-of-living","iso3":"usa"},{"id":2260,"country":"united-states","name":"Avon, CO, United States","city":"avon-co","url":"\/country\/united-states\/city\/avon-co\/cost-of-living","iso3":"usa"},{"id":2261,"country":"united-states","name":"Avondale, AZ, United States","city":"avondale-az","url":"\/country\/united-states\/city\/avondale-az\/cost-of-living","iso3":"usa"},{"id":2262,"country":"united-states","name":"Bakersfield, CA, United States","city":"bakersfield-ca","url":"\/country\/united-states\/city\/bakersfield-ca\/cost-of-living","iso3":"usa"},{"id":2263,"country":"united-states","name":"Baltimore, MD, United States","city":"baltimore-md","url":"\/country\/united-states\/city\/baltimore-md\/cost-of-living","iso3":"usa"},{"id":2264,"country":"united-states","name":"Baton Rouge, LA, United States","city":"baton-rouge-la","url":"\/country\/united-states\/city\/baton-rouge-la\/cost-of-living","iso3":"usa"},{"id":2265,"country":"united-states","name":"Battle Creek, MI, United States","city":"battle-creek-mi","url":"\/country\/united-states\/city\/battle-creek-mi\/cost-of-living","iso3":"usa"},{"id":2266,"country":"united-states","name":"Bayonne, NJ, United States","city":"bayonne-nj","url":"\/country\/united-states\/city\/bayonne-nj\/cost-of-living","iso3":"usa"},{"id":2267,"country":"united-states","name":"Beaumont, TX, United States","city":"beaumont-tx","url":"\/country\/united-states\/city\/beaumont-tx\/cost-of-living","iso3":"usa"},{"id":2268,"country":"united-states","name":"Beaverton, OR, United States","city":"beaverton-or","url":"\/country\/united-states\/city\/beaverton-or\/cost-of-living","iso3":"usa"},{"id":2269,"country":"united-states","name":"Beckley, WV, United States","city":"beckley-wv","url":"\/cou...
                                                                                                                                                                                                                    
                                                                                                    

Get Cities - CODE SNIPPETS


curl --location --request GET 'https://zylalabs.com/api/3441/spain+cost+of+living+api/3746/get+cities' --header 'Authorization: Bearer YOUR_API_KEY' 

    

Pass the USA city to check its prices and other relevant information. 



                                                                            
GET https://www.zylalabs.com/api/3441/spain+cost+of+living+api/3747/get+prices
                                                                            
                                                                        

Get Prices - Endpoint Features

Object Description
city [Required] City to lookup. Retrieved on "supported cities" endpoint.
Test Endpoint

API EXAMPLE RESPONSE

       
                                                                                                        
                                                                                                                                                                                                                            {"Version":1,"Status":200,"Success":true,"City Name":"houston-tx","Meal, Inexpensive Restaurant":"20.00\u00a0$","Meal for 2 People, Mid-range Restaurant, Three-course":"85.00\u00a0$","McMeal at McDonalds (or Equivalent Combo Meal)":"10.50\u00a0$","Domestic Beer (1 pint draught)":"6.00\u00a0$","Imported Beer (12 oz small bottle)":"3.64\u00a0$","Cappuccino (regular)":"6.29\u00a0$","Coke\/Pepsi (12 oz small bottle)":"3.23\u00a0$","Water (12 oz small bottle)":"2.56\u00a0$","Milk (regular), (1 gallon)":"4.13\u00a0$","Loaf of Fresh White Bread (1 lb)":"3.20\u00a0$","Rice (white), (1 lb)":"2.35\u00a0$","Eggs (regular) (12)":"5.09\u00a0$","Local Cheese (1 lb)":"7.78\u00a0$","Chicken Fillets (1 lb)":"6.48\u00a0$","Beef Round (1 lb) (or Equivalent Back Leg Red Meat)":"8.92\u00a0$","Apples (1 lb)":"2.31\u00a0$","Banana (1 lb)":"0.67\u00a0$","Oranges (1 lb)":"1.79\u00a0$","Tomato (1 lb)":"1.50\u00a0$","Potato (1 lb)":"1.37\u00a0$","Onion (1 lb)":"1.15\u00a0$","Lettuce (1 head)":"1.91\u00a0$","Water (1.5 liter bottle)":"2.40\u00a0$","Bottle of Wine (Mid-Range)":"15.00\u00a0$","Domestic Beer (0.5 liter bottle)":"2.24\u00a0$","Cigarettes 20 Pack (Marlboro)":"8.84\u00a0$","One-way Ticket (Local Transport)":"2.00\u00a0$","Monthly Pass (Regular Price)":"117.00\u00a0$","Taxi Start (Normal Tariff)":"5.00\u00a0$","Taxi 1 mile (Normal Tariff)":"5.00\u00a0$","Taxi 1hour Waiting (Normal Tariff)":"60.00\u00a0$","Gasoline (1 gallon)":"3.26\u00a0$","Volkswagen Golf 1.4 90 KW Trendline (Or Equivalent New Car)":"28,250.00\u00a0$","Toyota Corolla Sedan 1.6l 97kW Comfort (Or Equivalent New Car)":"26,259.31\u00a0$","Basic (Electricity, Heating, Cooling, Water, Garbage) for 915 sq ft Apartment":"265.93\u00a0$","Mobile Phone Monthly Plan with Calls and 10GB+ Data":"87.23\u00a0$","Internet (60 Mbps or More, Unlimited Data, Cable\/ADSL)":"94.65\u00a0$","Fitness Club, Monthly Fee for 1 Adult":"98.88\u00a0$","Tennis Court Rent (1 Hour on Weekend)":"36.08\u00a0$","Cinema, International Release, 1 Seat":"17.00\u00a0$","Preschool (or Kindergarten), Full Day, Private, Monthly for 1 Child":"1,848.59\u00a0$","International Primary School, Yearly for 1 Child":"37,666.67\u00a0$","1 Pair of Jeans (Levis 501 Or Similar)":"66.81\u00a0$","1 Summer Dress in a Chain Store (Zara, H&M, ...)":"79.53\u00a0$","1 Pair of Nike Running Shoes (Mid-Range)":"125.17\u00a0$","1 Pair of Men Leather Business Shoes":"173.48\u00a0$","Apartment (1 bedroom) in City Centre":"1,844.91\u00a0$","Apartment (1 bedroom) Outside of Centre":"1,590.40\u00a0$","Apartment (3 bedrooms) in City Centre":"3,851.70\u00a0$","Apartment (3 bedrooms) Outside of Centre":"2,589.72\u00a0$","Price per Square Feet to Buy Apartment in City Centre":"710.46\u00a0$","Price per Square Feet to Buy Apartment Outside of Centre":"459.27\u00a0$","Average Monthly Net Salary (After Tax)":"5,138.86\u00a0$","Mortgage Interest Rate in Percentages (%), Yearly, for 20 Years Fixed-Rate":"7.00"}
                                                                                                                                                                                                                    
                                                                                                    

Get Prices - CODE SNIPPETS


curl --location --request GET 'https://zylalabs.com/api/3441/spain+cost+of+living+api/3747/get+prices?city=madrid' --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 Spain Cost of Living API REST 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.

Simple Transparent Pricing

No long term commitments. One click upgrade/downgrade or cancellation. No questions asked.

πŸš€ Enterprise

Starts at
$ 10,000/Year


  • Custom Volume
  • Dedicated account manager
  • Service-level agreement (SLA)

Customer favorite features

  • βœ”οΈŽ Only Pay for Successful Requests
  • βœ”οΈŽ Free 7-Day Trial
  • βœ”οΈŽ Multi-Language Support
  • βœ”οΈŽ One API Key, All APIs.
  • βœ”οΈŽ Intuitive Dashboard
  • βœ”οΈŽ Comprehensive Error Handling
  • βœ”οΈŽ Developer-Friendly Docs
  • βœ”οΈŽ Postman Integration
  • βœ”οΈŽ Secure HTTPS Connections
  • βœ”οΈŽ Reliable Uptime

The Spain Cost of Living API is a data service providing detailed information on the prices of goods and services in cities across Spain. It covers a spectrum of expenses, including housing, groceries, transportation, and entertainment.

To access the API, make HTTP requests to the designated endpoint with parameters specifying the city or region of interest. The API will respond with comprehensive data on various expenses.

The API includes information on diverse cost categories, encompassing housing, groceries, transportation, entertainment, and more. Users can retrieve granular data to understand the complete economic landscape of a particular location.

The API aims to provide up-to-date information, but the frequency of updates may vary. Users should refer to the API documentation for details on data update intervals and ensure the relevance of the retrieved data.

Absolutely. The API is designed to support comparisons between different cities, allowing users to analyze and contrast the cost of living indices, average salaries, and purchasing power across various locations.

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, look at the β€˜X-Zyla-API-Calls-Monthly-Remaining’ header. For example, if your plan allows 1000 requests per month and you've used 100, this header will show 900.

To see the maximum number of API requests your plan allows, check the β€˜X-Zyla-RateLimit-Limit’ header. For instance, if your plan includes 1000 requests per month, this header will display 1000.

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 3600, it means 3600 seconds are left until the limit resets.

Yes, you can cancel your plan anytime by going to your account and selecting the cancellation option on the Billing page. Please note that upgrades, downgrades, and cancellations take effect immediately. Additionally, upon cancellation, you will no longer have access to the service, even if you have remaining calls left in your quota.

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]

To let you experience our APIs without any commitment, we offer a 7-day free trial that allows you to make API calls at no cost during this period. Please note that you can only use this trial once, so make sure to use it with the API that interests you the most. Most of our APIs provide a free trial, but some may not support it.

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 trial, you can make only 25% of the calls allowed by that plan. For example, if the API plan offers 1000 calls, you can make only 250 during the trial. To access the full number of calls offered by the plan, you will need to subscribe to the full plan.

 Service Level
100%
 Response Time
317ms

Category:


Related APIs