Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DT-6188: Information about quota restrictions #257

Merged
merged 2 commits into from
Dec 19, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/pages/en/developers/api-registration/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,4 +28,4 @@ An API key can be included either as a URL parameter or as a header. The paramet
We have deprecated and removed some old API endpoints that are no longer needed. The list of these deprecations can be found [here](../deprecations). We will update that page and inform users via email in the future when there are any new deprecations or removals.

## Quota and rate limiting
In the future, we will enforce rate and quota limiting. The limits should only restrict misuse of the APIs, not normal use. We will inform the registered users about these limits before we will enforce them.
Starting 31.1.2024, we will enforce rate and quota limiting. The limits should only restrict misuse of the APIs, not normal use.
2 changes: 1 addition & 1 deletion src/pages/en/developers/apis/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ title: APIs

The APIs hosted at api.digitransit.fi are publicly available but registration and use of API keys is required. More information is available [here](../api-registration). See [terms of use](./6-terms-of-use) for license information.

The APIs currently have no rate limiting, but you should avoid doing more than 10 requests per second. In the future, we will enforce rate and quota limits but the limits should only restrict misuse of the APIs, not normal use. We will inform the registered users about these limits before we will enforce them. If you need to make large amount of requests, you might want to [host the API locally](../architecture/x-apis/1-routing-api/#hosting-the-api-locally).
The APIs currently have no rate limiting, but you should avoid doing more than 10 requests per second. Starting 31.1.2024, we will enforce rate and quota limits but the limits should only restrict misuse of the APIs, not normal use. If you need to make a large amount of requests, you might want to [host the API locally](../architecture/x-apis/1-routing-api/#hosting-the-api-locally).

If you want to improve or modify the APIs in some way, you can either contribute to the projects through https://github.com/HSLdevcom or host your own APIs based on those sources.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ available.

## Hosting the API locally

If you need to make large amount of requests (e.g. requesting schedules from all stops) to the API, you might want to host the API locally.
If you need to make a large amount of requests (e.g. requesting schedules from all stops) to the API, you might want to host the API locally.
To run OpenTripPlanner with Docker, use command:
```
docker run --rm --name otp-hsl -p 9080:8080 -e ROUTER_NAME=hsl -e JAVA_OPTS=-Xmx5g -e ROUTER_DATA_CONTAINER_URL=https://api.digitransit.fi/routing-data/v2/hsl hsldevcom/opentripplanner:prod
Expand Down
8 changes: 8 additions & 0 deletions src/pages/en/developers/changes/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,18 @@
title: Changes
order: -10
---
## 31.1.2024

- Quota restrictions take place. [More information](../api-registration/#quota-and-rate-limiting)

## 13.12.2023

- Updated list of available feeds in [the Digitransit MQTT broker and Waltti vehicle positions.](../apis/4-realtime-api/vehicle-positions/)

## 12.12.2023

- We informed users about upcoming quota restrictions via email.

## 2.5.2023

- Added documentation about [the Digitransit MQTT broker and Waltti vehicle positions.](../apis/4-realtime-api/vehicle-positions/)
Expand Down
Loading