{"id":21269597,"url":"https://github.com/alpacatravel/graphql-docs","last_synced_at":"2025-07-11T05:31:11.927Z","repository":{"id":45021477,"uuid":"329159609","full_name":"AlpacaTravel/graphql-docs","owner":"AlpacaTravel","description":"Build travel applications and websites with list, trip and trail functionality","archived":false,"fork":false,"pushed_at":"2023-06-05T02:52:05.000Z","size":2013,"stargazers_count":5,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2023-08-07T17:44:45.246Z","etag":null,"topics":["api","directions-api","graphql","itinerary","itinerary-builder","itinerary-planner","maps","places-api","travel","trip"],"latest_commit_sha":null,"homepage":"https://www.alpaca.travel/","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/AlpacaTravel.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-01-13T01:30:45.000Z","updated_at":"2023-08-07T17:44:45.247Z","dependencies_parsed_at":"2023-02-16T01:31:21.645Z","dependency_job_id":null,"html_url":"https://github.com/AlpacaTravel/graphql-docs","commit_stats":null,"previous_names":[],"tags_count":0,"template":null,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AlpacaTravel%2Fgraphql-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AlpacaTravel%2Fgraphql-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AlpacaTravel%2Fgraphql-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AlpacaTravel%2Fgraphql-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/AlpacaTravel","download_url":"https://codeload.github.com/AlpacaTravel/graphql-docs/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":225693748,"owners_count":17509227,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api","directions-api","graphql","itinerary","itinerary-builder","itinerary-planner","maps","places-api","travel","trip"],"created_at":"2024-11-21T08:09:17.567Z","updated_at":"2024-11-21T08:09:18.029Z","avatar_url":"https://github.com/AlpacaTravel.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"[//]: # \"Title: GraphQL\"\n[//]: # \"Forward: true\"\n[//]: # \"Weight: 1\"\n\n\u003cdiv align=\"center\"\u003e\n  \u003cimg alt=\"Developer Documentation\" src=\"https://developer.alpacamaps.com/_media/logo.svg\" height=\"75\" width=\"75\" /\u003e\n\u003c/div\u003e\n\n# Alpaca Travel GraphQL API\n\n\u003e The [Alpaca Travel](https://alpaca.travel) GraphQL API provides developers\n\u003e with easy access to the platform's itinerary content for use in interactive\n\u003e applications and user interfaces.\n\n- Easily access and manipulate itinerary data through a GraphQL API\n\n- Incorporate platform's itinerary content into custom interactive applications\n  and user interfaces such as travel itinerary planners and trip planning\n  websites.\n\n- Retrieve and display itinerary information, including maps, routes, places and\n  uploaded content, in desired format.\n\n- Engage with your audience and offer personalized travel experience by\n  providing basic itinerary planning features.\n\n- Convenient tool for including platform's itinerary content in your project,\n  and for providing your users the ability to create and update itineraries.\n\nThe Alpaca Travel platform supports a wide range of itineraries, including:\n\n- Road-trips\n\n- Walking and hiking trails\n\n- Flights and other modes of transportation\n\n- Top-10 lists and other types of curated content\n\nThe Alpaca Travel platform offers more than just itinerary management, it also\nincludes features such as guide and directory creation, location search and\nplace information loading to enhance the functionality of your travel-related\napplication or website.\n\n## Documentation Overview\n\nThe Alpaca Travel Platform is accessed using GraphQL, a powerful and easily\nintegrated techology for your website or application. You can read some\nsupporting information on GraphQL and why it is used below.\n\n- **[Getting Started](#getting-started)** Starting guides for developers around\n  the Alpaca Travel GraphQL API.\n\n- **[Example Operations](/example-operations)** We have put together concrete\n  examples of typical calls to the API in our\n  [example operations](/example-operations) section. These will assist you\n  become familiar with GraphQL as well as the capabilities of the platform.\n\n- **[Example Applications](#example-applications)** We have provided some\n  working examples of apps for you to play and adapt that demonstrates the\n  technology in use.\n\n- **[Mapping](https://github.com/AlpacaTravel/mapping-docs)** In addition to the\n  GraphQL API, we also provide hosted mapping services for accessing and\n  presenting data on maps. You can access these services by visiting our\n  [mapping documentation](https://github.com/AlpacaTravel/mapping-docs) for more\n  information.\n\n### GraphQL Endpoint\n\nIn order to interact with the Alpaca Travel API, you will need to use GraphQL.\nThe GraphQL endpoint for the Alpaca Travel API is:\n\n    https://graphql.withalpaca.travel/?accessToken=\u003cYOUR_API_KEY\u003e\n\nWhen using the root endpoint, it is important to authenticate via providing your\n`accessToken` (which is your API Key) as a query parameter.\n\n- **[Token Authorization](/topics/graphql/Token%20Authorization/)** Understand\n  more about Alpaca Travel API Keys and Tokens\n\n- **[GraphQL Topics](/topics/graphql/)** Getting started with GraphQL\n\n- **[Apollo Sandbox](/topics/graphql/Apollo%20Sandbox/)** Use the GraphQL\n  Sandbox in order to explore and execute queries and mutations against the\n  Alpaca GraphQL API from your web browser\n\n- **[Schema Reference](/reference)** Generated documentation based on the Alpaca\n  Travel GraphQL Scheme to assist with understanding data types and operations\n\n## Getting Started\n\n### Itinerary\n\nIf you are new to the Alpaca Travel GraphQL API, we have created a series of\nguides that can familiarize you with the GraphQL API based on some common\nstarting points developers have.\n\n\u003e We recommend you start with the following guides to familiarize yourself with\n\u003e the queries and mutations available with the GraphQL API\n\n- **[Reading from Itineraries](/getting-started/itinerary/Reading%20from%20Itineraries/)**\n  Read and access content from itineraries created on the Alpaca Platform\n\n- **[Managing a List](/getting-started/itinerary/Managing%20a%20List/)** Create,\n  update and manage a curated list of locations for users\n\n- **[Managing a Trip](/getting-started/itinerary/Managing%20a%20Trip/)** Create\n  and manage a trip with routes and directions between locations\n\n- **[Example Itinerary Operations](/example-operations/itinerary/)** A series of\n  GraphQL documents that provide examples for working with itinerary operations\n\n- **[Specific Topics](/topics/itinerary/)** Specific reference topics for\n  working with itineraries\n\n### Collections\n\nCollections support the ability to create groups of places or itineraries to\npower your website or application.\n\n- **[Working with Collections](topics/collection)** Understand how to manage\n  collections and your place library\n\n- **[Example Collection Operations](/example-operations/collection/)** A series\n  of GraphQL documents that provide examples for working with collection and\n  collection location operations\n\n### Places / Place Information\n\nWe support working with various place providers on the platform, to access place\ninformation and keep your place information up to date.\n\n- **[Working with Places](topics/places)** Understand how to work with places on\n  Alpaca, including integration with various place provides such as OSM,\n  Australian Tourism Data Warehouse (ATDW), and Facebook Pages. Learn how to\n  access opening hours or other place attributes.\n\n### Other References\n\n- **[GraphQL Topics](/topics/graphql)** Get started with GraphQL and understand\n  some specific related topics\n\n- **[Example Operations](/example-operations/)** Example operations across the\n  full Alpaca Travel GraphQL API\n\n- **[Working with Media](topics/media)** Upload media and query media to display\n  in your application or website\n\n- **[Working with Positions](/topics/places/Position%20attributes/)** Access\n  global information about a position, such as region, time-zone or ISO data, or\n  local data such as information about a location from the ABS dataset\n\n- **[Working with Icons](topics/profile/Managing%20profile%20icons/)** Manage\n  profile icons sets and associate them with Itineraries\n\n### JavaScript\n\nAny GraphQL client can be used with JavaScript but the below guides may assist\nyou getting started with JavaScript.\n\n- **[References](https://alpaca.travel/reference)** Examples of displaying\n  content in the browser\n\n- **[Making GraphQL Calls](topics/graphql/Making%20GraphQL%20Calls/)** Simple\n  methods for executing GraphQL using JavaScript\n\n- **[React Apollo Client](topics/graphql/Making%20GraphQL%20Calls/Apollo%20Client/)**\n  Get started with React and Apollo Client to access an itinerary\n\n- **[Alpaca GraphQL JavaScript SDK](https://github.com/AlpacaTravel/graph-sdk)**\n  (New) SDKs based on popular JavaScript development environments, including\n  `React`, `Vue`, `Svelte` and `Stencil`. The SDK provides options for\n  developers such as leveraging `urql`, `graphql-request`, `react-query` and\n  `apollo`.\n\n## Example Applications\n\nWe have included some example stand-alone code that you can use to build upon in\norder to display content from the Alpaca Travel service.\n\nThese are provided as working examples you can modify for your own uses.\n\n- **[Browser Examples](https://alpaca.travel/reference)** We have some examples\n  of interactive maps that display in your browser.\n\n- **[React/Apollo Load Itinerary](https://codesandbox.io/s/alpaca-travel-react-apollo-client-itinerary-t37bg9)**\n  Simple example of a react application loading an itinerary using the\n  \"itinerary\" operation.\n\n- **[React Place Slider](https://codesandbox.io/s/alpaca-travel-collection-location-sliding-cards-2kpjt?file=/src/components/Slider.js)**\n  Example loading a \"slider\" of location cards from a collection pulling in\n  information from Australian Tourism Data Warehouse (ATDW). You can customise\n  and run this in browser as a demo (code sandbox).\n\n- **[React Opening Hours](https://codesandbox.io/s/alpaca-travel-graphql-opening-hours-cggl9?file=/src/opening-hours/opening-hours.tsx)**\n  Example loading of a place opening hours, demonstrating some presentation of\n  current status or schedule for a series of dates.\n\nMore examples to come\n\n## Example Operations\n\nA catalogue of example [GraphQL queries and mutations](/example-operations) are\nprovided as example gists for you to refer to for specific functionality.\n\n## Support :thumbsup:\n\nAlpaca Travel offers support for API clients. Clients are provided access to\nBasecamp to manage integration projects, or alternatively questions can be\ndirected to \u003csayhello@alpaca.travel\u003e.\n\n## Contributing\n\nWe are happy to accept pull-requests, suggestions and corrections.\n\nWe have quality control mechanisms to assist in keeping the documentation is\nkept maintained. This includes GitHub actions to validate site links as well as\nvalid GraphQL examples (in both .graphql files and featuring in markdown).\n\nSections such as the [reference](reference/README.md) is managed external to\nthis repository and can't be changed. In that case, please describe the change\nto us in an Issue, and we will resolve.\n\n### Quick Edits\n\nYou can make quick edits through GitHub by using the pencil :pencil2: edit\nprocess and submit a pull request.\n\n### Further Edits\n\nAlternatively, you can pull down the git repo to make your changes. You can\ncheck your changes by using the following commands:\n\n    npm i\n    npm test\n\nNote: This documentation package is validated against GraphQL and we check to\nmake sure we don't have dead links. Please check against mistakes using\n`npm test` above.\n\n## Legal Statement\n\nCopyright © 2020-2022 Alpaca Travel. All rights reserved.\n\nPlease be aware that use of this API is subject to an services agreement with\nAlpaca Travel.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falpacatravel%2Fgraphql-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Falpacatravel%2Fgraphql-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falpacatravel%2Fgraphql-docs/lists"}