Skip to content

Commit

Permalink
Added Walibi Belgium, Walibi Holland, Efteling, Toverland, Disneyland…
Browse files Browse the repository at this point in the history
… Paris, Phantasialand, Bellewaerde and Parc Asterix

The parks Walibi Belgium, Walibi Holland, Efteling, Toverland, Disneyland Paris, Phantasialand, Bellewaerde and Parc Asterix were added.

The readme was also updated and some improvements were made to the API and documentation
  • Loading branch information
timyboy12345 committed Mar 14, 2021
1 parent 5393b3c commit df576c2
Show file tree
Hide file tree
Showing 88 changed files with 32,800 additions and 850 deletions.
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,8 @@ lerna-debug.log*
*.launch
.settings/
*.sublime-workspace
.graphqlconfig
schema.graphql

# IDE - VSCode
.vscode/*
Expand Down
110 changes: 101 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,30 @@
# Themeparks API
# 🎡 Themeparks API 🎡

Using this API, you can request waiting times from theme parks all around the world. It communicates with public API's that the parks use internally for their apps.

Feel free to add new parks.

## Example
To view the API, please go to [the example API](https://tp.arendz.nl/api) at https://tp.arendz.nl. This API is always up-to-date with the latest master-branch of this repo.

### Supported parks
In the table below you will find the parks that are currently supported and the functions that they support. This list of included and non-included functions is also included in the API.

| Park | Ride Support | Restaurants Support | Shows Support |
| ------------- | ------------- | ------------- | ------------- |
| Bellewaerde | Yes | Yes | Yes |
| Disneyland Paris | Yes | Yes | Yes |
| Disneyland Studios Park | Yes | Yes | Yes |
| Efteling | Yes | Yes | No |
| Parc Asterix | Yes | Yes | Yes |
| Phantasialand | Yes | Yes | Yes |
| Portaventura Park | Yes | Yes | No |
| Ferrariland | Yes | Yes | No |
| Toverland | Yes | Yes | No |
| Walibi Holland | Yes | No | No |
| Walibi Holland | Yes | Yes | Yes |


## Description

This API was build using the [Nest](https://github.com/nestjs/nest) framework. Find the docs at the [NestJS Documentation](https://docs.nestjs.com/)
Expand Down Expand Up @@ -40,16 +61,87 @@ $ npm run test:e2e
$ npm run test:cov
```

## Support
## License

Nest is an MIT-licensed open source project. It can grow thanks to the sponsors and support by the amazing backers. If you'd like to join them, please [read more here](https://docs.nestjs.com/support).
Nest is [MIT licensed](LICENSE).

## Stay in touch
## Formats
The API returns parks, restaurants, rides and others points of interest (POIs) in a standardized way, these are detailed below.
### Park Format
```typescript
export interface ThemePark {
id: string;
name: string;
description: string;
image: string;
countryCode: string;
supports?: ThemeParkSupports;
}
```

- Author - [Kamil Myśliwiec](https://kamilmysliwiec.com)
- Website - [https://nestjs.com](https://nestjs.com/)
- Twitter - [@nestframework](https://twitter.com/nestframework)
### Poi Format
```typescript
export interface Poi {
id: string;
category: PoiCategory;
rideCategory?: RideCategory;
original_category?: string;
title: string;
subTitle?: string;
description?: string;
area?: string;
createdAt?: string;
location?: {
lat: number,
lng: number
},
entrance?: {
id?: string,
world?: {
lat: number,
lng: number
},
map?: {
lat: number,
lng: number
}
};
exit?: {
id?: string,
world?: {
lat: number,
lng: number
},
map?: {
lat: number,
lng: number
}
};
maxAge?: string;
maxSize?: string;
minAge?: number;
minSize?: number;
minSizeEscort?: number;
tags?: string[];
image_url?: string;
website_url?: string;
fastpass?: boolean;
singlerider?: boolean;
featured?: boolean;
photoPoint?: boolean;

images?: string[];

waitingTimes?: WaitingTimes;

showTimes?: ShowTimes;

openingTimes?: PoiOpeningTime[];

original: any;
}

## License
```

Nest is [MIT licensed](LICENSE).
### Api URLS
Since the data of themeparks is copyrighted, API url's aren't included in this documentation. These can be retrieved by doing some research on your own.
Loading

0 comments on commit df576c2

Please sign in to comment.