XAP Download URL API V1

Guidance and examples for accessing the XAP Download URL API V1

This Download URL API allows a user to request a secure, one-use URL to download a requested version of a Static Data Download file.

Endpoint

Method	Endpoint
GET	https://apim.expedia.com/feed/v1/download-url

Required Headers

Key:	Expedia API key
Authorization:	Expedia API Authorization String
Accept:	application/vnd.exp-lodging.v1+json
Partner-Transaction-Id:	Partner TransactionID String

Next Steps

Use returned URL to download requested data file.

Request Message

Parameter Name	Example	Type	Required	Default	Deprecated	Description
type	?type=SUMMARY	String	Yes	None	No	Refers to which data file you are trying to download: (only one parameter may be included per query) List of types: DESTINATION (Deprecated) VENDORLOGO SUMMARY LISTINGS IMAGES AMENITIES LOCATIONS DESCRIPTIONS POLICIES GUEST_REVIEW VACATION_RENTAL ALL_REGIONS BOUNDING_POLYGON HOTEL_TO_REGION_HIERARCHY ROOM_DETAILS
locale	?locale=en-US	String	No	en-US	No	The value default to 'en-US'. The locale value for the language that you would like to download. You may only request one language per Download API request. For the feed files that support localization, Use this parameter to help filter out the localization files you want to download. If not using this parameter, then this API will return the files with en-US locale for specified type. If the specified type of file is not supported localization, there is no file will be returned.
pointOfSupply	?pointOfSupply=CA	String	No	None	No	The point of supply means a country generally. The downloadable files provided after specifying will only contain properties' information for that country. You may only request one pointOfSupply per Download API request. Values may only be one of the pintOfSupply listed below: US AT BR CA FR DE GR IT JP KR MX PT ES TR AE GB
lodgingType	?lodgingType=CL	String	No	None	No	The lodging type also means structure type, it only can be `CL`(Conventional Lodging) and `VR`(Vacation Rental). The downloadable files provided after specifying will only contain property information for that lodging type. You may only request one lodgingType per Download API request. Values may only be one of the lodgingTypes listed below: CL VR
brand	?brand=VRBO	String	No	None	No	The downloadable files provided after specifying will only contain property information for that brand. You may only request one brand per Download API request. Values may only be one of the brands listed below VRBO HCOM BEX
includeOtherFileOptions	includeOtherFileOptions=true	Boolean	No	false	No	Controls whether or not otherFileOptions are included in the response, default value is 'false' because this is not required for most of the partners so we use it to control it by using a parameter.

Response Message

Warning Response - No Results

SectionName		Example	Type	Nullable	Description
TransactionId		38dc7269-12b1-58c9-a381-4963c274cdfe	String	No	Unique identifier for each API response or the echo of the Partner-Transaction-Id given in the request header.
Warning				No	Container for warning messages.
	Code	NOT_FOUND_FILES	String	No	Warning message code.
Description	No files found that match the requested parameters. Please change the parameter(s) to get the required file.	String	No	Warning message description.

Warning Response - No Permission

SectionName		Example	Type	Nullable	Description
TransactionId		4f6eee5e-b173-4f71-b3d4-cd69a5c7d12f	String	No	Unique identifier for each API response or the echo of the Partner-Transaction-Id given in the request header.
Warning				No	Container for warning messages.
	Code	FEED_FILE_ACCESS_RESTRICTED	String	No	Warning message code.
Description	You do not have permission to access this file type. Please contact your account manager or support team.	String	No	Warning message description.

Error Response - Server Error

SectionName		Example	Type	Nullable	Description
TransactionId		38dc7269-12b1-58c9-a381-4963c274cdfe	String	No	Unique identifier for each API response or the echo of the Partner-Transaction-Id given in the request header.
Error				No	Container for error messages.
	Code	SERVER_ERROR	String	No	Error message code.
Description	An error has occurred while processing the request.	String	No	Error message description.

Success Response

SectionName	Example	Type	Nullable	Description
TransactionId	38dc7269-12b1-58c9-a381-4963c274cdfe	String	No	Unique identifier for each API response or the echo of the Partner-Transaction-Id given in the request header.
BestMatchedFile	{ "fileContentType": "Summary", "locale": "en-US", "fileName": "lodging-summary-en_us-all.jsonl.zip", "size": { "unit": "MB", "size": 340.66 }, "fileLastUpdated": "Mon Aug 18 15:27:55 UTC 2025", "downloadUrl": "https://feeds.s3.us-west-2.amazonaws.com/lodging-summary-en_us-all.jsonl.zip?X-Amz-Security-Token=...", "downloadUrlExpires": "Mon Aug 18 16:30:12 UTC 2025" }	FileInfo	Yes	Container for the file details.
OtherFileOptions	[ { "fileContentType": "Summary", "locale": "en-US", "fileName": "lodging-summary_vrbo_en_us.jsonl.zip", "size": { "unit": "MB", "size": 282.96 }, "fileLastUpdated": "Thu Aug 14 16:18:02 UTC 2025", "downloadUrl": "https://feeds.s3.us-west-2.amazonaws.com/lodging-summary_vrbo_en_us.jsonl.zip?X-Amz-Security-Token=...", "downloadUrlExpires": "Mon Aug 18 14:49:16 UTC 2025", "filterConditions": { "brand": "VRBO" }, "bestMatchedLink": { "href": "https://apim.expedia.com/feed/v1/download-url?type=SUMMARY&locale=en-US&brand=VRBO", "method": "GET" } } ]	List<FileInfo>	No	Container for the file details about the other file options.

FileInfo

SectionName		Example	Type	Nullable	Description
FileContentType		Summary	String	Yes	The type associated with the file content. List of types: Amenities Descriptions Images Listings Locations Policies Regions Reviews Summary VacationRental AllRegions BoundingPolygon HotelToRegionHierarchy RoomDetails
Locale		en-US	String	Yes	The locale associated with the file content.
FileName		expedia-lodging-summary-en_us-all.jsonl.zip	String	No	File name.
FileSize			Object	No	The information about the file size.
	Unit	MB	String	No	Size unit, support list: KB MB GB
Value	61.32	Double	No	File size.
FileLastUpdated		Thu Aug 14 16:18:02 UTC 2025	String	No	Time with file last updated.
DownloadUrl		https://feeds.s3.us-west-2.amazonaws.com/lodging-summary-en_us-all.jsonl.zip?X-Amz-Security-Token=...	String	No	Pre-signed URL is a self signed URL generated for a resource in S3 with a set expiration time.
DownloadUrlExpires		Mon Aug 18 15:26:41 UTC 2025	String	No	Time with the download Url expires.
FilterConditions			Object	No	Container filter condition for the filtered file.
	PointOfSupply	AT	String	Yes	List of filter condition for PointOfSupplies: US AT BR CA FR DE GR IT JP KR MX PT ES TR AE GB
Brand	VRBO	String	Yes	List of filter condition for Brands: VRBO HCOM BEX
StructureType	VR	String	Yes	List of filter condition for StructureTypes: VR CONVENTIONAL
bestMatchedLink			Object	Yes	Contains link information, including link address, request method. Only provided if FileInfo is in OtherFileOptions.
	Href	https://apim.expedia.com/feed/v1/download-url?type=SUMMARY&locale=en-US&brand=VRBO	String	No	a link address.
Method	GET	String	No	Request method.

Example Request and Response

Example 1

Get Static File Download URL request

https://apim.expedia.com/feed/v1/download-url?type=SUMMARY&locale=en-GB

Note: Non-functional credentials are included for demonstration only.

Get Static File Download URL response

{
  "transactionId": "c3f9fce0-1bc5-4d6f-b83e-33178ea9ac66",
  "bestMatchedFile": {
    "fileContentType": "Summary",
    "locale": "en-GB",
    "fileName": "lodging-summary-en_gb-all.jsonl.zip",
    "size": {
      "unit": "MB",
      "size": 340.9
    },
    "fileLastUpdated": "Thu Aug 14 15:22:59 UTC 2025",
    "downloadUrl": "https://feeds.s3.us-west-2.amazonaws.com/lodging-summary-en_gb-all.jsonl.zip?X-Amz-Security-Token=...",
    "downloadUrlExpires": "Mon Aug 18 15:45:32 UTC 2025"
    }
}

Example 2

Get Static File Download URL request

https://apim.expedia.com/feed/v1/download-url?type=SUMMARY

Note: Non-functional credentials are included for demonstration only.

Get Static File Download URL response

{
    "transactionId": "c3f9fce0-1bc5-4d6f-b83e-33178ea9ac66",
    "bestMatchedFile": {
        "fileContentType": "Summary",
        "locale": "en-US",
        "fileName": "lodging-summary-en_us-all.jsonl.zip",
        "size": {
            "unit": "MB",
            "size": 342.54
        },
        "fileLastUpdated": "Thu Aug 14 16:18:02 UTC 2025",
        "downloadUrl": "https://feeds.s3.us-west-2.amazonaws.com/lodging-summary-en_us-all.jsonl.zip?X-Amz-Security-Token=...",
        "downloadUrlExpires": "Mon Aug 18 15:46:22 UTC 2025"
    }
}

Error Responses

Common Error Codes

HTTP Status Code	Error Code	Error Response	Cause
400	INVALID_TYPE_ATTR	Invalid type provided.	The type parameter is out of our support list of the type. The type list of what we support: DESTINATION VENDORLOGO SUMMARY LISTINGS IMAGES AMENITIES LOCATIONS DESCRIPTIONS POLICIES GUEST_REVIEW VACATION_RENTAL ALL_REGIONS BOUNDING_POLYGON HOTEL_TO_REGION_HIERARCHY ROOM_DETAILS
400	INVALID_BRAND_ATTR	Invalid Brand provided.	Its value only can be one of BEX, HCOM, VRBO.
400	INVALID_POINT_OF_SUPPLY_ATTR	Invalid PointOfSupply provided.	Its value only can be one of US, AT, BR, CA, FR, DE, GR, IT, JP, KR, MX, PT, ES, TR, AE, GB.
400	INVALID_LODGING_TYPE_ATTR	Invalid LodgingType provided.	Its value only can be one of VR, CL.
401	None	Unauthorized or Invalid authentication credentials.	Unauthorized or Invalid authentication credentials.
403	None	You cannot consume this service.	Cannot consume this service.
403	FEED_FILE_ACCESS_RESTRICTED	You do not have permission to access this file type. Please contact your account manager or support team.	Don't have permission to access this file type.
404	None	no Route matched with those values.	No Route matched.
404	NOT_FOUND_FILES	No files found that match the requested parameters. Please change the parameter(s) to get the required file.	No files found that match the requested parameters.
429	None	API rate limit exceeded.	API rate limit exceeded. If you need to adjust it, pelase refer to the following to create a request: https://expediamanagement.zendesk.com/hc/en-us/articles/115015994888
500	SERVER_ERROR	An error has occurred while processing the request.	There is a server-side issue that has resulted in a failure.
503	None	name resolution failed.	Service unavailable.

Here, you can explore the endpoint definitions for this API, then go to the API Explorer to try out all the XAP endpoints, download OpenAPI specs, or download our Postman collections. Testing with one or all of these options will give you an understanding of how the examples and schema definitions compare to the actual output.