openapi-directory
Version:
Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS
1 lines • 15 kB
JSON
{"openapi":"3.0.0","info":{"description":"\nBefore using this API, we recommend you read our **[Authorization Guide](https://developers.amadeus.com/self-service/apis-docs/guides/authorization-262)** for more information on how to generate an access token.\n\nPlease also be aware that our test environment is based on a subset of the production, this API in test only returns a few selected cities. You can find the list in our **[data collection](https://github.com/amadeus4dev/data-collection)**.\n","title":"Points of Interest","version":"1.1.1","x-logo":{"url":"https://amadeus.com/images/en/technology/mobile-tablet/mobile-woman-office-city.jpg.transform/medium/img.jpg"},"x-origin":[{"format":"swagger","url":"https://raw.githubusercontent.com/amadeus4dev/amadeus-open-api-specification/main/spec/json/PointsOfInterest_v1_swagger_specification.json","version":"2.0"}],"x-providerName":"amadeus.com","x-release-note":{"1.0":["Initial Version"],"1.0.1":["Move from PointOfInterst to Location definition"],"1.0.2":["New by-square endpoint as secondary resource"],"1.1":["Add an id, self and rank to location resource","Introduce GET by id","add filter parameter for search operation"]},"x-serviceName":"amadeus-points-of-interest","x-status":"validated","x-tags":["#ama-for-dev"]},"paths":{"/reference-data/locations/pois":{"get":{"description":"","operationId":"getPointsOfInterest","parameters":[{"description":"Latitude (decimal coordinates)","in":"query","name":"latitude","required":true,"example":41.397158,"schema":{"type":"number","format":"double"}},{"description":"Longitude (decimal coordinates)","in":"query","name":"longitude","required":true,"example":2.160873,"schema":{"type":"number","format":"double"}},{"description":"radius of the search in Kilometer. Can be from 0 to 20, default value is 1 Km.","in":"query","name":"radius","required":false,"schema":{"type":"integer","minimum":0,"maximum":20,"default":1}},{"$ref":"#/components/parameters/pageLimit"},{"$ref":"#/components/parameters/pageOffset"},{"$ref":"#/components/parameters/categories"}],"responses":{"200":{"$ref":"#/components/responses/points-of-interest"},"400":{"$ref":"#/components/responses/400"},"default":{"$ref":"#/components/responses/500"}},"summary":"Returns points of interest for a given location and radius.","tags":["Search"]}},"/reference-data/locations/pois/by-square":{"get":{"description":"","operationId":"getPointsOfInterestBySquare","parameters":[{"description":"Latitude north of bounding box (decimal coordinates)","in":"query","name":"north","required":true,"example":41.397158,"schema":{"type":"number","format":"double"}},{"description":"Longitude west of bounding box (decimal coordinates)","in":"query","name":"west","required":true,"example":2.160873,"schema":{"type":"number","format":"double"}},{"description":"Latitude south of bounding box (decimal coordinates)","in":"query","name":"south","required":true,"example":41.394582,"schema":{"type":"number","format":"double"}},{"description":"Longitude east of bounding box (decimal coordinates)","in":"query","name":"east","required":true,"example":2.177181,"schema":{"type":"number","format":"double"}},{"$ref":"#/components/parameters/pageLimit"},{"$ref":"#/components/parameters/pageOffset"},{"$ref":"#/components/parameters/categories"}],"responses":{"200":{"$ref":"#/components/responses/points-of-interest"},"400":{"$ref":"#/components/responses/400"},"default":{"$ref":"#/components/responses/500"}},"summary":"Returns points of interest for a given area","tags":["Search"]}},"/reference-data/locations/pois/{poisId}":{"get":{"description":"","operationId":"getPointOfInterest","responses":{"200":{"$ref":"#/components/responses/point-of-interest"},"400":{"$ref":"#/components/responses/400"},"404":{"$ref":"#/components/responses/404"},"default":{"$ref":"#/components/responses/500"}},"summary":"Retieve one point of interest by its Id.","tags":["Retrieve"]},"parameters":[{"$ref":"#/components/parameters/poisId"}]}},"x-generatedAt":"2025-04-15T13:49:53.306Z","servers":[{"url":"https://test.api.amadeus.com/v1"}],"components":{"parameters":{"categories":{"description":"category of the location. \n\nMultiple value can be selected using a comma i.e. SIGHTS, SHOPPING\n","in":"query","name":"categories","required":false,"style":"form","explode":false,"schema":{"type":"array","items":{"enum":["SIGHTS","NIGHTLIFE","RESTAURANT","SHOPPING"],"type":"string"}}},"pageLimit":{"description":"maximum items in one page","in":"query","name":"page[limit]","required":false,"schema":{"type":"integer","default":10}},"pageOffset":{"description":"start index of the requested page","in":"query","name":"page[offset]","required":false,"schema":{"type":"integer","default":0}},"poisId":{"description":"identifier of the pois","in":"path","name":"poisId","required":true,"example":"9CB40CB5D0","schema":{"type":"string"}}},"responses":{"400":{"description":"code | title \n------- | ------------------------------------- \n477 | INVALID FORMAT\n572 | INVALID OPTION\n4926 | INVALID DATA RECEIVED \n32171 | MANDATORY DATA MISSING \t \n","content":{"application/vnd.amadeus+json":{"schema":{"$ref":"#/components/schemas/Error_400"}}}},"404":{"description":"Not Found","content":{"application/vnd.amadeus+json":{"schema":{"$ref":"#/components/schemas/Error_404"}}}},"500":{"description":"Unexpected Error","content":{"application/vnd.amadeus+json":{"schema":{"$ref":"#/components/schemas/Error_500"}}}},"point-of-interest":{"description":"Successful Operation","content":{"application/vnd.amadeus+json":{"schema":{"example":{"data":{"category":"SIGHTS","geoCode":{"latitude":41.39165,"longitude":2.164772},"id":"9CB40CB5D0","name":"Casa Batlló","rank":1,"self":{"href":"https://test.api.amadeus.com/v1/reference-data/locations/pois/9CB40CB5D0","methods":["GET"]},"subType":"POINT_OF_INTEREST","tags":["sightseeing","sights","museum","landmark","tourguide","restaurant","attraction","activities","commercialplace","shopping","souvenir"],"type":"location"}},"properties":{"data":{"$ref":"#/components/schemas/Location"},"meta":{"$ref":"#/components/schemas/Collection_Meta"}},"required":["data"],"title":"Success"}}}},"points-of-interest":{"description":"Successful Operation","content":{"application/vnd.amadeus+json":{"schema":{"example":{"data":[{"category":"SIGHTS","geoCode":{"latitude":41.39165,"longitude":2.164772},"id":"9CB40CB5D0","name":"Casa Batlló","rank":5,"self":{"href":"https://test.api.amadeus.com/v1/reference-data/locations/pois/9CB40CB5D0","methods":["GET"]},"subType":"POINT_OF_INTEREST","tags":["sightseeing","sights","museum","landmark","tourguide","restaurant","attraction","activities","commercialplace","shopping","souvenir"],"type":"location"},{"category":"RESTAURANT","geoCode":{"latitude":41.397987,"longitude":2.161159},"id":"4690B83DCA","name":"La Pepita","rank":30,"self":{"href":"https://test.api.amadeus.com/v1/reference-data/locations/pois/4690B83DCA","methods":["GET"]},"subType":"POINT_OF_INTEREST","tags":["restaurant","tapas","pub","bar","sightseeing","commercialplace"],"type":"location"},{"category":"RESTAURANT","geoCode":{"latitude":41.38827,"longitude":2.161604},"id":"3EF139D861","name":"Brunch & Cake","rank":30,"self":{"href":"https://test.api.amadeus.com/v1/reference-data/locations/pois/3EF139D861","methods":["GET"]},"subType":"POINT_OF_INTEREST","tags":["vegetarian","restaurant","breakfast","shopping","bakery","transport","patio","garden"],"type":"location"},{"category":"RESTAURANT","geoCode":{"latitude":41.392376,"longitude":2.160919},"id":"AB3F122E3E","name":"Cervecería Catalana","rank":30,"self":{"href":"https://test.api.amadeus.com/v1/reference-data/locations/pois/AB3F122E3E","methods":["GET"]},"subType":"POINT_OF_INTEREST","tags":["restaurant","tapas","sightseeing","traditionalcuisine","bar","activities","commercialplace"],"type":"location"},{"category":"RESTAURANT","geoCode":{"latitude":41.40043,"longitude":2.15463},"id":"752402FCA2","name":"Botafumeiro","rank":30,"self":{"href":"https://test.api.amadeus.com/v1/reference-data/locations/pois/752402FCA2","methods":["GET"]},"subType":"POINT_OF_INTEREST","tags":["restaurant","seafood","sightseeing","professionalservices","transport","commercialplace"],"type":"location"},{"category":"SIGHTS","geoCode":{"latitude":41.39148,"longitude":2.164981},"id":"5F1CED3994","name":"Casa Amatller","rank":100,"self":{"href":"https://test.api.amadeus.com/v1/reference-data/locations/pois/5F1CED3994","methods":["GET"]},"subType":"POINT_OF_INTEREST","tags":["sightseeing","sights","museum","landmark","restaurant","tourguide","historicplace","historic","attraction","commercialplace","activities","shopping","events"],"type":"location"},{"category":"RESTAURANT","geoCode":{"latitude":41.390785,"longitude":2.167414},"id":"30601A1A90","name":"Tapas 24","rank":100,"self":{"href":"https://test.api.amadeus.com/v1/reference-data/locations/pois/30601A1A90","methods":["GET"]},"subType":"POINT_OF_INTEREST","tags":["restaurant","tapas","traditionalcuisine","sightseeing","commercialplace","transport","patio","garden","activities","bar"],"type":"location"},{"category":"NIGHTLIFE","geoCode":{"latitude":41.392677,"longitude":2.153942},"id":"15C8B8148C","name":"Dry Martini","rank":100,"self":{"href":"https://test.api.amadeus.com/v1/reference-data/locations/pois/15C8B8148C","methods":["GET"]},"subType":"POINT_OF_INTEREST","tags":["bar","restaurant","nightlife","club","sightseeing","attraction","activities"],"type":"location"},{"category":"RESTAURANT","geoCode":{"latitude":41.399193,"longitude":2.159853},"id":"BD29CF2CCD","name":"Con Gracia","rank":100,"self":{"href":"https://test.api.amadeus.com/v1/reference-data/locations/pois/BD29CF2CCD","methods":["GET"]},"subType":"POINT_OF_INTEREST","tags":["restaurant","sightseeing","commercialplace","professionalservices","activities"],"type":"location"},{"category":"RESTAURANT","geoCode":{"latitude":41.390198,"longitude":2.156974},"id":"24DE6CE737","name":"Osmosis","rank":100,"self":{"href":"https://test.api.amadeus.com/v1/reference-data/locations/pois/24DE6CE737","methods":["GET"]},"subType":"POINT_OF_INTEREST","tags":["restaurant","shopping","transport","professionalservices"],"type":"location"}],"meta":{"count":120,"links":{"first":"https://test.api.amadeus.com/v1/reference-data/locations/pois?latitude=41.397158&longitude=2.160873&page[offset]=0&page[limit]=10","last":"https://test.api.amadeus.com/v1/reference-data/locations/pois?latitude=41.397158&longitude=2.160873&page[offset]=120&page[limit]=10","next":"https://test.api.amadeus.com/v1/reference-data/locations/pois?latitude=41.397158&longitude=2.160873&page[offset]=10&page[limit]=10","self":"https://test.api.amadeus.com/v1/reference-data/locations/pois?latitude=41.397158&longitude=2.160873","up":"https://test.api.amadeus.com/v1/reference-data/locations/pois?latitude=41.397158&longitude=2.160873"}}},"properties":{"data":{"items":{"$ref":"#/components/schemas/Location"},"type":"array"},"meta":{"$ref":"#/components/schemas/Collection_Meta"}},"required":["data"],"title":"Success"}}}}},"schemas":{"Collection_Meta":{"properties":{"count":{"example":1,"type":"integer"},"links":{"example":{"self":"https://test.api.amadeus.com/v1/area/resources?param=value"},"properties":{"first":{"example":"https://test.api.amadeus.com/v1/area/resources?...","format":"uri","type":"string"},"last":{"example":"https://test.api.amadeus.com/v1/area/resources?...","format":"uri","type":"string"},"next":{"example":"https://test.api.amadeus.com/v1/area/resources?...","format":"uri","type":"string"},"previous":{"example":"https://test.api.amadeus.com/v1/area/resources?...","format":"uri","type":"string"},"self":{"example":"https://test.api.amadeus.com/v1/area/resources?...","format":"uri","type":"string"},"up":{"example":"https://test.api.amadeus.com/v1/area/resources?...","format":"uri","type":"string"}},"title":"CollectionLinks"}},"title":"Collection_Meta"},"Error_400":{"example":{"errors":[{"code":477,"detail":"invalid query parameter format","source":{"example":"CDG","parameter":"airport"},"status":400,"title":"INVALID FORMAT"}]},"properties":{"errors":{"items":{"$ref":"#/components/schemas/Issue"},"type":"array"}},"required":["errors"]},"Error_404":{"example":{"errors":[{"code":1797,"detail":"no response found for this query parameter","source":{"parameter":"airport"},"status":404,"title":"NOT FOUND"}]},"properties":{"errors":{"items":{"$ref":"#/components/schemas/Issue"},"type":"array"}},"required":["errors"]},"Error_500":{"example":{"errors":[{"code":141,"status":500,"title":"SYSTEM ERROR HAS OCCURRED"}]},"properties":{"errors":{"items":{"$ref":"#/components/schemas/Issue"},"type":"array"}},"required":["errors"]},"GeoCode":{"properties":{"latitude":{"description":"latitude of the location","example":43.580418,"format":"double","type":"number"},"longitude":{"description":"longitude of the location","example":7.125102,"format":"double","type":"number"}}},"Issue":{"properties":{"code":{"description":"an application-specific error code","format":"int64","type":"integer"},"detail":{"description":"explanation of the error","type":"string"},"source":{"description":"an object containing references to the source of the error","maxProperties":1,"properties":{"example":{"description":"a string indicating an example of the right value","type":"string"},"parameter":{"description":"a string indicating which URI query parameter caused the issue","type":"string"},"pointer":{"description":"a JSON Pointer [RFC6901] to the associated entity in the request document","type":"string"}},"title":"Issue_Source","type":"object"},"status":{"description":"the HTTP status code applicable to this error","type":"integer"},"title":{"description":"a short summary of the error","type":"string"}}},"Links":{"example":{"href":"string"},"properties":{"href":{"format":"uri","type":"string"},"methods":{"items":{"enum":["GET","PUT","DELETE","POST","PATCH"],"type":"string"},"type":"array"}}},"Location":{"properties":{"category":{"description":"category of the location","enum":["SIGHTS","BEACH_PARK","HISTORICAL","NIGHTLIFE","RESTAURANT","SHOPPING"],"example":"HISTORICAL","type":"string"},"geoCode":{"$ref":"#/components/schemas/GeoCode"},"id":{"description":"id of the ressource","type":"string"},"name":{"description":"short name of the location","example":"Paris CDG","type":"string"},"rank":{"description":"the rank is the position compared to other locations based on how famous is a place. 1 being the highest.","example":1,"type":"string"},"self":{"$ref":"#/components/schemas/Links"},"subType":{"description":"location sub type","enum":["AIRPORT","CITY","POINT_OF_INTEREST","DISTRICT"],"example":"AIRPORT","type":"string"},"tags":{"description":"list of tags related to the location","items":{"example":["grocery","japanese","cafe"],"type":"string"},"type":"array"},"type":{"description":"the resource name","example":"location","type":"string"}}}}}}