Mrixs/trip-planner
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Initial docs

Browse Source
This commit is contained in:
Vladimir Zagainov
2026-08-13 18:26:15 +03:00
parent 8b7b988141
commit c78bf00f7a
12 changed files with 5128 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

157
docs/deployment.md Normal file
View File

@@ -0,0 +1,157 @@
# Дополнение к ТЗ: Инфраструктура, CI/CD и развертывание
---
## 1. Архитектура развертывания
Развертывание системы осуществляется в контейнеризованной среде с использованием **Docker Compose**. Это обеспечивает простоту управления зависимостями (БД, кэш) и изоляцию компонентов приложения.
### 1.1 Компоненты Docker Compose
Среда развертывания включает следующие сервисы:
1. **API Service (Go)** — основной HTTP-сервер.
2. **Cron Service (Go)** — фоновые задачи (обновление справочников, проверка статуса). *Может быть объединен с API в один бинарник/контейнер, если используется встроенный планировщик, но рекомендуется запускать отдельным процессом.*
3. **PostgreSQL** — база данных со справочниками и маршрутами (используется официальный образ, данные хранятся в Docker Volumes).
4. **Redis** — кэш-слой для API Яндекс.Расписаний.
5. **Watchtower** — сервис для автоматического обновления контейнеров.
### 1.2 Использование Watchtower
Для реализации автоматического деплоя (CD) на сервере разворачивается образ `nickfedor/watchtower`.
Он регулярно опрашивает Docker Registry (или ожидает webhook) и, при появлении нового образа приложения с тегом `latest` (или другим заданным), автоматически скачивает его, корректно останавливает старый контейнер и запускает новый с теми же параметрами окружения.
---
## 2. Процесс CI/CD (Gitea Actions)
Весь процесс непрерывной интеграции и доставки управляется встроенным механизмом **Gitea Actions** и запускается автоматически при любом `push` в ветку `master`.
### 2.1 Этапы пайплайна (Pipeline Steps)
Пайплайн описывается в файле `.gitea/workflows/deploy.yml` и включает следующие шаги:
1. **Checkout**: Клонирование актуального кода из ветки `master`.
2. **Setup Go**: Установка необходимой версии Go и настройка кэширования модулей (`go mod download`).
3. **Lint & Test**:
- Запуск линтеров (например, `golangci-lint`) для проверки качества кода.
- Запуск unit-тестов (`go test -v ./...`), включая тесты графа маршрутизации с моками вместо реального API.
4. **Build Binaries**: Компиляция исполняемых файлов для Linux/amd64 (API и Cron).
5. **Docker Build & Push**:
- Сборка Docker-образа приложения на основе `Dockerfile` (рекомендуется multi-stage сборка для уменьшения веса финального образа).
- Авторизация в приватном или публичном Docker Registry.
- Пуш собранного образа с тегами `latest` и `{{.CommitID}}`.
### 2.2 Схема автоматического деплоя (CD)
1. Разработчик делает `git push origin master`.
2. Gitea Actions успешно прогоняет тесты и пушит образ `my-registry.com/travel-api:latest`.
3. На production-сервере `nickfedor/watchtower` замечает обновление образа.
4. Watchtower выполняет pull нового образа и перезапускает сервисы приложения без ручного вмешательства.
---
## 3. Примеры конфигурации
### 3.1 Пример `docker-compose.yml` (Production)
```yaml
version: '3.8'
services:
travel-api:
image: my-registry.com/travel-api:latest
restart: always
ports:
- "8080:8080"
environment:
- DB_DSN=postgres://user:pass@db:5432/travel?sslmode=disable
- REDIS_ADDR=redis:6379
- YANDEX_API_KEY=${YANDEX_API_KEY}
depends_on:
- db
- redis
db:
image: postgres:15-alpine
restart: always
environment:
- POSTGRES_USER=user
- POSTGRES_PASSWORD=pass
- POSTGRES_DB=travel
volumes:
- pg_data:/var/lib/postgresql/data
redis:
image: redis:7-alpine
restart: always
volumes:
- redis_data:/data
watchtower:
image: nickfedor/watchtower
restart: always
volumes:
- /var/run/docker.sock:/var/run/docker.sock
# Если используется приватный реестр, прокидываем авторизацию:
# - /root/.docker/config.json:/config.json:ro
command: --interval 60 --cleanup travel-api
# Обновляем только контейнер travel-api, проверяя изменения каждые 60 секунд (или по крону)
volumes:
pg_data:
redis_data:
```
### 3.2 Пример Gitea Actions (`.gitea/workflows/deploy.yml`)
```yaml
name: Build, Test and Publish
on:
push:
branches:
- master
jobs:
build-and-deploy:
runs-on: ubuntu-latest
steps:
- name: Checkout Code
uses: actions/checkout@v3
- name: Set up Go
uses: actions/setup-go@v4
with:
go-version: '1.22'
- name: Go Modules Cache
uses: actions/cache@v3
with:
path: ~/go/pkg/mod
key: ${{ runner.os }}-go-${{ hashFiles('**/go.sum') }}
restore-keys: |
${{ runner.os }}-go-
- name: Run Tests
run: go test -v -race ./...
- name: Set up Docker Buildx
uses: docker/setup-buildx-action@v2
- name: Login to Docker Registry
uses: docker/login-action@v2
with:
registry: my-registry.com
username: ${{ secrets.DOCKER_USERNAME }}
password: ${{ secrets.DOCKER_PASSWORD }}
- name: Build and Push Docker Image
uses: docker/build-push-action@v4
with:
context: .
push: true
tags: my-registry.com/travel-api:latest,my-registry.com/travel-api:${{ gitea.sha }}
```
## 4. Рекомендации по безопасности и отказоустойчивости
1. **Секреты:** Ключи API Яндекс.Расписаний, пароли от БД и доступы к Registry не должны храниться в коде. В Gitea Actions они зашиваются через механизм *Secrets*, а в Docker Compose — через файл `.env` на сервере.
2. **Откаты (Rollback):** Если новая версия `latest` ломает production, откатить версию можно путем изменения тега в `docker-compose.yml` на предыдущий успешный коммит-хэш (например, `image: my-registry.com/travel-api:a1b2c3d`) и ручного перезапуска, либо через revert коммита в `master` (что триггернет Gitea Actions на сборку "исправленного" `latest`).
3. **Downtime:** При базовой настройке Watchtower будет небольшой даунтайм в несколько секунд во время перезапуска контейнера. Для MVP/версии 1.0 это приемлемо. Для zero-downtime в будущем потребуется переход на Docker Swarm / Kubernetes или поднятие прокси (nginx/traefik) с health-чеками и blue/green деплоем.

138
docs/plans/2026-08-13-MVP-Routing-Implementation.md Normal file
View File

@@ -0,0 +1,138 @@
# MVP Routing Implementation
## Overview
Implement the Minimum Viable Product for the multimodal trip planning service, focusing on core routing functionality for single transport mode (trains) with maximum 1 transfer. This foundation will enable subsequent stages adding multimodality, deeper search, and station closure detection.
**Problem it solves**: Users can search for train routes between cities with up to 1 transfer, with basic GeoJSON map visualization and proper API caching to respect Yandex.Schedules API quota limits.
**Key benefits**:
- Core routing engine within API quota constraints
- Cache-aside pattern prevents API overuse
- GeoJSON output enables immediate map visualization
- TDD-guaranteed correctness for critical routing logic
## Context (from discovery)
- **Files/components involved**: `internal/routing` (graph, search algorithm, MCT rules), `internal/yandex` (API client with rate limiter, retries, circuit breaker), `internal/cache` (Redis cache-aside), `cmd/api` (HTTP handlers), `cmd/cron` (station status detection)
- **Related patterns**: Lazy graph expansion with hub stations, BFS/Dijkstra with depth limiting (4-5 transfers max), Pareto-front ranking (time, transfers, cost), cache-aside with multi-layer TTL
- **Dependencies**: PostgreSQL for station/city directories, Redis for cache TTL, Yandex.Schedules API (`/search`, `/schedule`, `/nearest_stations`, `/stations_list`)
## Development Approach
- **Testing approach**: TDD (tests first) - user preference confirmed
- Complete each task fully before moving to the next
- Make small, focused changes with tests
- **CRITICAL: every task MUST include new/updated tests** for code changes in that task
- tests are not optional - they are a required part of the checklist
- write unit tests for new functions/methods
- write unit tests for modified functions/methods
- add new test cases for new code paths
- update existing test cases if behavior changes
- tests cover both success and error scenarios
- **CRITICAL: all tests must pass before starting next task** - no exceptions
- **CRITICAL: update this plan file when scope changes during implementation**
- Run tests after each change
- Maintain backward compatibility
## Testing Strategy
- **Unit tests**: required for every task (see Development Approach above)
- **E2E tests**: project has UI-based e2e tests considerations:
- UI changes → add/update e2e tests in same task as UI code
- Backend changes supporting UI → add/update e2e tests in same task
- Treat e2e tests with same rigor as unit tests (must pass before next task)
- Store e2e tests alongside unit tests (or in designated e2e directory)
## Progress Tracking
- Mark completed items with `[x]` immediately when done
- Add newly discovered tasks with ➕ prefix
- Document issues/blockers with ⚠️ prefix
- Update plan if implementation deviates from original scope
- Keep plan in sync with actual work done
## What Goes Where
- **Implementation Steps** (`[ ]` checkboxes): tasks achievable within this codebase - code changes, tests, documentation updates
- **Post-Completion** (no checkboxes): items requiring external action - manual testing, changes in consuming projects, deployment configs, third-party verifications
- **Checkbox placement**: Checkboxes belong only in Task sections (`### Task N:` or `### Iteration N:`). Do not put checkboxes in Success criteria, Overview, or Context — they cause extra loop iterations.
## Implementation Steps
### Task 1: Set up project structure and dependencies
- [ ] Initialize Go module (`go mod init trip-planner`) if not already done
- [ ] Add dependencies: `github.com/go-redis/redis/v8`, `github.com/jmoiron/sqlx`, `github.com/golang-jason/jason` (or similar)
- [ ] Configure Docker Compose for local development (API, Redis, PostgreSQL)
- [ ] Write basic Go project structure with go.mod, main.go, and internal packages
- [ ] Verify `go fmt ./...` and `go vet ./...` pass
- [ ] Run initial tests - must pass
### Task 2: Implement Yandex API client with rate limiter and circuit breaker
- [ ] Create `internal/yandex/client.go` with Yandex API wrapper
- [ ] Implement token bucket rate limiter (configurable TPS limit)
- [ ] Implement circuit breaker pattern (states: closed, open, half-open)
- [ ] Add retry with exponential backoff for transient errors
- [ ] Write tests for rate limiter (token consumption, refill rate)
- [ ] Write tests for circuit breaker (state transitions, trip to open state)
- [ ] Write tests for retry (success after backoff, exhaustion)
- [ ] Run tests - must pass before task 3
### Task 3: Implement cache-aside layer for reference data and search results
- [ ] Create `internal/cache/store.go` with Redis cache interface
- [ ] Implement cache keys: `cities:{code}`, `stations:{id}`, `search:{from}:{to}:{date}`
- [ ] Implement cache-aside pattern: Redis → miss → Postgres/API → write-back to Redis
- [ ] Set TTL policies: cities/stations 30 days, search near-term 2-6 hours, search far-term 7 days
- [ ] Write tests for cache operations (get, set, invalidate, TTL expiry)
- [ ] Write tests for cache-aside pattern (cache hit, cache miss → API call → cache write)
- [ ] Run tests - must pass before task 4
### Task 4: Implement routing graph and search algorithm (max 1 transfer)
- [ ] Create `internal/routing/graph.go` with Node and Edge types
- [ ] Implement Node types: Station, City; Edge kinds: Flight (real), Synthetic
- [ ] Build graph from station directory (Postgres + Redis cache)
- [ ] Implement BFS/Dijkstra search with 1-transfer depth limit
- [ ] Apply MCT (Minimum Connection Time) rules from transfer_rules table
- [ ] Write tests for graph construction (node/edge creation, directory loading)
- [ ] Write tests for search algorithm (successful 1-transfer route, no-route case, 2-transfer rejected)
- [ ] Write tests for MCT rule application (different node types, city tiers, check-in types)
- [ ] Run tests - must pass before task 5
### Task 5: Implement API handlers for MVP endpoints
- [ ] Create `cmd/api/handlers.go` with HTTP handlers
- [ ] Implement `GET /v1/cities?query=` - city autocomplete from cached directory
- [ ] Implement `GET /v1/cities/{id}/stations` - city stations including neighbors if main closed
- [ ] Implement `POST /v1/routes/search` - body: from_city_id, to_city_id, date; response: Pareto-optimal routes (time, transfers)
- [ ] Implement `GET /v1/routes/{search_id}/{route_id}/geojson` - geometry for map visualization
- [ ] Implement `GET /v1/stations/{id}/status` - current station status
- [ ] Write handlers tests (success cases, error cases, input validation)
- [ ] Write integration tests (handler → cache → routing → API client flow)
- [ ] Run tests - must pass before task 6
### Task 6: Implement cron job for station status detection
- [ ] Create `cmd/cron/station_status.go` daily cron job
- [ ] Query `/schedule` for each monitored station, count flights on upcoming dates
- [ ] Implement closure detection: N consecutive days of zero trips (N=3 recommended) → status `closed`
- [ ] Implement reactivation: status `active` when >0 trips appear
- [ ] Write tests for cron logic (status transition, zero-flight detection, reactivation)
- [ ] Run tests - must pass before task 7
### Task 7: End-to-end integration and full test suite
- [ ] Write integration tests connecting all components: API → cache → routing → Yandex client
- [ ] Write synthetic timetable fixtures for routing tests (no real API calls)
- [ ] Run full test suite: `go test ./... -cover`
- [ ] Verify coverage meets project standard (80%+)
- [ ] Fix any failing tests
- [ ] Run `go fmt ./...` and `go vet ./...` - all issues must be fixed
- [ ] Final verification: manual API endpoint testing with curl or Postman
## Post-Completion
*Items requiring manual intervention or external systems - no checkboxes, informational only*
**Manual verification**:
- Test API endpoints with sample requests
- Verify GeoJSON output format for map visualization
- Test cache hit/miss scenarios
- Test station status cron job behavior
**External system updates**:
- Docker Compose setup for local development (`docker-compose up -d`)
- Gitea Actions workflow `.gitea/workflows/deploy.yml` CI/CD pipeline
- Docker image build and push configuration
- Watchtower configuration for auto-updates
*Note: ralphex automatically moves completed plans to `docs/plans/completed/`*

21
docs/yandex-api-docs/api-access.md Normal file
View File

@@ -0,0 +1,21 @@
# Доступ к API
Чтобы работать с API, необходимо:
- Сформировать ключ в Кабинете разработчика.
- Пройти процедуру активации ключа.
- Использовать ключ в каждом запросе к API.
## Формирование ключа
Авторизируйтесь в Кабинете разработчика, используя любой имеющийся у вас логин на Яндексе (если логина нет, зарегистрируйте новый). Для формирования ключа укажите:
- Название ключа (например, название вашего проекта).
- Название сервиса — «API Яндекс Расписаний».
Ключ, привязанный к сервису API Яндекс Расписаний, будет сгенерирован.
## Использование ключа
Инструкция по активации будет отправлена на адрес вашей Яндекс Почты (<ваш логин на Яндексе>@yandex.ru). Пройдя процедуру активации, ожидайте письмо с ее подтверждением.
Каждый запрос к API должен содержать: ключ, который может быть передан в качестве значения параметра apikey запроса или в HTTP-заголовке Authorization (параметр apikey имеет более высокий приоритет).

783
docs/yandex-api-docs/list-stations-route.md Normal file
View File

@@ -0,0 +1,783 @@
Список станций следования
# Список станций следования
- [Синтаксис запроса](https://yandex.ru/dev/rasp/doc/ru/reference/list-stations-route#format)
- [Структура ответа](https://yandex.ru/dev/rasp/doc/ru/reference/list-stations-route#emails-detailed)
- [Станция](https://yandex.ru/dev/rasp/doc/ru/reference/list-stations-route#stanciya)
- [Нитка](https://yandex.ru/dev/rasp/doc/ru/reference/list-stations-route#nitka)
- [Интервальная нитка](https://yandex.ru/dev/rasp/doc/ru/reference/list-stations-route#intervalnaya-nitka)
Запрос позволяет получить список _станций_ следования _нитки_ по указанному идентификатору нитки, информацию о каждой нитке и о промежуточных станциях нитки.
Идентификатор нитки можно получить в ответах на запросы: [Расписание рейсов между станциями](https://yandex.ru/dev/rasp/doc/ru/reference/schedule-point-point), [Расписание рейсов по станции](https://yandex.ru/dev/rasp/doc/ru/reference/schedule-on-station).
## Синтаксис запроса
```
https://api.rasp.yandex-net.ru/v3.0/thread/ ?
apikey=<ключ>
& uid=<идентификатор нитки>
& [from=<код станции отправления>]
& [to=<код станции прибытия>]
& [format=<формат>]
& [lang=<язык>]
& [date=<дата>]
& [show_systems=<коды в ответе>]
```
Пример запроса:
```
https://api.rasp.yandex-net.ru/v3.0/thread/?apikey={ключ}&format=json&uid=038AA_tis&lang=ru_RU&show_systems=all
```
Входные параметры:
**Обязательные параметры**
| | |
| --- | --- |
| **Параметр** | **Описание** |
| `apikey` | [Ключ доступа](https://yandex.ru/dev/rasp/doc/ru/concepts/access) к API.<br>Параметр можно не передавать, если ключ доступа указан в заголовке `Authorization`, например:<br>```<br>Authorization: 1eb31582-941a-3ac8-a61f-041c344495ab<br>``` |
| `uid` | Идентификатор нитки в Яндекс Расписаниях.<br>Идентификатор нитки может меняться со временем. Поэтому перед каждым запросом станций нитки необходимо получать актуальный идентификатор запросом [расписания рейсов между станциями](https://yandex.ru/dev/rasp/doc/ru/reference/schedule-point-point) или [расписания рейсов по станции](https://yandex.ru/dev/rasp/doc/ru/reference/schedule-on-station). |
**Необязательные параметры**
| | |
| --- | --- |
| **Параметр** | **Описание** |
| `from` | Код станции отправления. Должен быть указан в [системе кодирования](https://yandex.ru/dev/rasp/doc/ru/concepts/coding-system).<br>При использовании системы кодирования Яндекс Расписаний в данном параметре также можно указать код населенного пункта.<br>Код населенного пункта или код станции можно получить из адресной строки, пользуясь Яндекс Расписаниями. Например, из адресной строки:<br>- «http://rasp.yandex.ru/station/9600213» — код станции «s9600213» (к числовому значению кода добавляется латинская буква «s»);<br>- «http://rasp.yandex.ru/city/146» — код населенного пункта «c146» (к числовому значению кода добавляется латинская буква «c»). |
| `to` | Код станции прибытия. Должен быть указан в [системе кодирования](https://yandex.ru/dev/rasp/doc/ru/concepts/coding-system).<br>При использовании системы кодирования Яндекс Расписаний в данном параметре также можно указать код населенного пункта.<br>Код населенного пункта или код станции можно получить из адресной строки, пользуясь Яндекс Расписаниями. Например, из адресной строки:<br>- «https://rasp.yandex.ru/station/9600213» — код станции «s9600213» («s» от сокращенного «station»).<br>- «https://rasp.yandex.ru/city/146» — код населенного пункта «c146» («c» от сокращенного «city»). |
| `format` | Формат ответа. Поддерживаемые значения:<br>- `json` (по умолчанию);<br>- `xml`. |
| `lang` | Язык возвращаемой информации, в формате <код языка>\_<код страны>. Поддерживаемые коды языка описаны стандартом [ISO 639](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2), коды стран — стандартом [ISO 3166](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).<br>По умолчанию ответ возвращается для значения `ru_RU`.<br>Поддерживаемые коды языков:<br>- `ru` — русский;<br>- `uk` — украинский.<br>Поддерживаемые коды стран:<br>- `RU` — Россия;<br>- `UA` — Украина. |
| `date` | Дата, на которую необходимо получить список станций следования. Должна быть указана в формате, соответствующем стандарту [ISO 8601](https://ru.wikipedia.org/wiki/ISO_8601). Например, YYYY-MM-DD.<br>По умолчанию возвращается список станций следования на первую дату хождения нитки. |
| `show_systems` | [Cистеме кодирования](https://yandex.ru/dev/rasp/doc/ru/concepts/coding-system), в которой необходимо получить коды станций (в элементе ответа `codes`, вложенном в элемент `station`).<br>Возможные значения:<br>- `yandex` — система кодирования Яндекс Расписаний;<br>- `esr` — коды железнодорожных станций СНГ и стран Балтии из базы [ЕСР](https://ru.wikipedia.org/wiki/%D0%95%D0%B4%D0%B8%D0%BD%D0%B0%D1%8F_%D1%81%D0%B5%D1%82%D0%B5%D0%B2%D0%B0%D1%8F_%D1%80%D0%B0%D0%B7%D0%BC%D0%B5%D1%82%D0%BA%D0%B0);<br>- `all` — коды всех поддерживаемых систем кодирования.<br>По умолчанию элемент `station` не содержит элемента `codes`. |
## Структура ответа
Ответ представляет собой список станций следования нитки. Содержит подробную информацию о нитке, о всех промежуточных станциях нитки.
Возможные форматы ответа: JSON, XML.
Пример ответа в формате JSON
Пример ответа в формате XML
```
{
"except_days": "",
"arrival_date": null,
"from": null,
"uid":"038AA_tis",
"title": "Москва - Санкт-Петербург",
"interval":
{
"density": "автобус раз в 10-15 минут",
"end_time": "2017-06-10T22:30:00",
"begin_time": "2017-06-10T06:00:00"
},
"departure_date": null,
"start_time": "00:44",
"number": "038А",
"short_title": "Москва - Санкт-Петербург",
"days": "ежедневно, кроме вс",
"to": null,
"carrier":
{ /* hide:carrier */
"code": 112,
"offices": [],
"codes":
{
"icao": null,
"sirena": null,
"iata": null
},
"title": "РЖД/ФПК",
},
"transport_type": "train",
"stops":
[\
{\
"arrival": null,\
"departure": "2017-02-20T00:44:00+03:00",\
"terminal": null,\
"platform": "",\
"station":\
{ /* hide:station */\
"codes":\
{\
"express": "2006004",\
"yandex": "s2006004",\
"esr": "060073 "\
},\
"title": "Москва (Ленинградский вокзал)",\
"popular_title": "Ленинградский вокзал",\
"short_title": "М-Ленинградск",\
"code": "s2006004",\
"type": "station"\
},\
"stop_time": null,\
"duration": 0.0\
},\
{\
"arrival": "2017-02-20T02:34:00",\
...\
}\
]
"vehicle": null,
"start_date": "2017-03-22",
"transport_subtype":
{ /* hide:transport_subtype */
"color": "#FF7F44",
"code": "suburban",
"title": "Пригородный поезд"
},
"express_type": null
}
```
#### Описание элементов JSON
| | | |
| --- | --- | --- |
| **Элемент JSON** | **Тип** | **Описание** |
| `except_days` | Строка | Дни, в которые нитка не курсирует (даже если они входят в множество, описанное элементом `days`). |
| `arrival_date` | Строка | Дата прибытия на станцию, указанную в параметре `to`.<br>Включается в ответ, только если нитка не является _интервальной_. |
| `from` | Строка | Пункт отправления, указанный в параметре `from`. |
| `uid` | Строка (не более 100 символов) | Идентификатор нитки, принятый в Яндекс Расписаниях. |
| `title` | Строка | Название нитки, составленное из полных названий первой и последней станций следования. |
| `interval` | Объект | Информация о движении по интервальной нитке. |
| `departure_date` | Строка | Дата отправления со станции, указанной в параметре `from`.<br>Включается в ответ, только если нитка не является _интервальной_. |
| `start_time` | Строка | Время отправления с первой станции следования по местному времени станции.<br>Включается в ответ, только если нитка не является _интервальной_. |
| `number` | Строка | Номер [рейса](https://yandex.ru/dev/rasp/doc/ru/concepts/termin#schedule). |
| `short_title` | Строка | Название нитки, составленное из коротких названий первой и последней станций следования. |
| `days` | Строка | Дни курсирования нитки. |
| `to` | Строка | Пункт прибытия, указанный в параметре `to`. |
| `carrier` | Объект | Информация о [перевозчике](https://yandex.ru/dev/rasp/doc/ru/concepts/termin#carrier). |
| `transport_type` | Строка | Тип транспорта. Возможные значения:<br>- `plane` — самолет;<br>- `train` — поезд;<br>- `suburban` — электричка;<br>- `bus` — автобус;<br>- `water` — водный транспорт;<br>- `helicopter` — вертолет. |
| `stops` | Массив | Список станций следования. |
| `vehicle` | Строка | Название транспортного средства. |
| `start_date` | Строка | Дата отправления с первой станции следования. |
| `transport_subtype` | Объект | Информация о подтипе транспортного средства. |
| `express_type` | Строка | Признак экспресса или аэроэкспресса. Значение по умолчанию — `null`.<br>Если тип транспорта — электричка (ключ `transport_type` возвращен со значением `suburban`), принимает одно из значений:<br>- `express` — экспресс-рейс;<br>- `aeroexpress` — рейс, курсирующий между городом и аэропортом. |
**Элементы объекта**`interval`
| | | |
| --- | --- | --- |
| **Элемент JSON** | **Тип** | **Описание** |
| `density` | Строка | Описание периодичности движения в свободной форме. |
| `end_time` | Строка | Дата и время окончания движения по нитке. Всегда указывается в часовом поясе станции отправления.<br>Могут быть указаны в одном из двух форматов:<br>- `YYYY-MM-DD`, если в запросе не был передан параметр `date`.<br>- `YYYY-MM-DDTHH:MM:SS`, если параметр `date` был передан. |
| `begin_time` | Число | Дата и время начала движения по нитке. Всегда указывается в часовом поясе станции отправления.<br>Могут быть указаны в одном из двух форматов:<br>- `YYYY-MM-DD`, если в запросе не был передан параметр `date`.<br>- `YYYY-MM-DDTHH:MM:SS`, если параметр `date` был передан. |
**Элементы объекта**`stops`
| | | |
| --- | --- | --- |
| **Элемент JSON** | **Тип** | **Описание** |
| `arrival` | Строка | Время прибытия, в формате ISO 8601 (YYYY-MM-DDThh:mm:ss±hh:mm).<br>Если параметр `result_timezone` не был передан, указывается в часовом поясе станции. |
| `departure` | Строка | Время отправления, в формате ISO 8601 (YYYY-MM-DDThh:mm:ss±hh:mm).<br>Если параметр `result_timezone` не был передан, указывается в часовом поясе станции. |
| `duration` | Число | Время в пути между станциями (в секундах). |
| `stop_time` | Число | Продолжительность остановки (в секундах). |
| `station` | Объект | Информация о станции следования. |
| `terminal` | Строка | Терминал аэропорта (например, «D»).<br>Принимает значение `null`, если информации о терминале нет. |
| `platform` | Строка | Платформа или путь, с которого отправляется рейс (например, «3 путь»).<br>Пустая строка значит, что информации о платформе или пути нет. |
**Элементы объекта**`station`
| | | |
| --- | --- | --- |
| **Элемент JSON** | **Тип** | **Описание** |
| `codes` | Объект | Список кодов станции в других [системах кодирования](https://yandex.ru/dev/rasp/doc/ru/concepts/coding-system), поддерживаемый Яндекс Расписаниями. |
| `title` | Строка | Название станции. |
| `station_type` | Строка | Тип станции.<br>- `station` — станция;<br>- `platform` — платформа;<br>- `stop` — остановочный пункт;<br>- `checkpoint` — блок-пост;<br>- `post` — пост;<br>- `crossing` — разъезд;<br>- `overtaking_point` — обгонный пункт;<br>- `train_station` — вокзал;<br>- `airport` — аэропорт;<br>- `bus_station` — автовокзал;<br>- `bus_stop` — автобусная остановка;<br>- `unknown` — станция без типа;<br>- `port` — порт;<br>- `port_point` — портпункт;<br>- `wharf` — пристань;<br>- `river_port` — речной вокзал;<br>- `marine_station` — морской вокзал. |
| `station_type_name` | Строка | Название типа станции, зависит от языка ответа. Возможные значения на русском — в списке значений ключа `station_type`. |
| `popular_title` | Строка | Общепринятое название станции. |
| `short_title` | Строка | Короткое название станции. |
| `code` | Строка | Код станции в системе кодирования Яндекс Расписаний. |
| `type` | Строка | Вид станции. Для запроса расписания по станции возможно только одно значение — `station`. |
**Элементы объекта**`codes`
| | | |
| --- | --- | --- |
| **Элемент JSON** | **Тип** | **Описание** |
| `express` | Строка | Код станции в системе кодирования [Экспресс-3](http://www.express-3.ru/). |
| `yandex` | Строка | Код станции в системе кодирования Яндекс Расписаний. |
| `esr` | Строка | Код станции в системе кодирования [ЕСР](https://ru.wikipedia.org/wiki/%D0%95%D0%B4%D0%B8%D0%BD%D0%B0%D1%8F_%D1%81%D0%B5%D1%82%D0%B5%D0%B2%D0%B0%D1%8F_%D1%80%D0%B0%D0%B7%D0%BC%D0%B5%D1%82%D0%BA%D0%B0). |
**Элементы объекта**`carrier`
| | | |
| --- | --- | --- |
| **Элемент JSON** | **Тип** | **Описание** |
| `code` | Число | Код перевозчика в системе кодирования Яндекс Расписаний. |
| `codes` | Объект | Список кодов перевозчика в других системах кодирования, поддерживаемый Яндекс Расписаниями. |
| `title` | Строка | Название перевозчика. |
**Элементы объекта**`codes`
| | | |
| --- | --- | --- |
| **Элемент JSON** | **Тип** | **Описание** |
| `icao` | Строка | Код перевозчика в системе кодирования [ICAO](https://ru.wikipedia.org/wiki/%D0%9C%D0%B5%D0%B6%D0%B4%D1%83%D0%BD%D0%B0%D1%80%D0%BE%D0%B4%D0%BD%D0%B0%D1%8F_%D0%BE%D1%80%D0%B3%D0%B0%D0%BD%D0%B8%D0%B7%D0%B0%D1%86%D0%B8%D1%8F_%D0%B3%D1%80%D0%B0%D0%B6%D0%B4%D0%B0%D0%BD%D1%81%D0%BA%D0%BE%D0%B9_%D0%B0%D0%B2%D0%B8%D0%B0%D1%86%D0%B8%D0%B8). |
| `sirena` | Строка | Код перевозчика в системе кодирования [Sirena](http://ru.wikipedia.org/wiki/%D0%A1%D0%B8%D1%80%D0%B5%D0%BD%D0%B0_(%D1%81%D0%B5%D1%82%D1%8C)). |
| `iata` | Строка | Код перевозчика в системе кодирования [IATA](https://ru.wikipedia.org/wiki/%D0%9C%D0%B5%D0%B6%D0%B4%D1%83%D0%BD%D0%B0%D1%80%D0%BE%D0%B4%D0%BD%D0%B0%D1%8F_%D0%B0%D1%81%D1%81%D0%BE%D1%86%D0%B8%D0%B0%D1%86%D0%B8%D1%8F_%D0%B2%D0%BE%D0%B7%D0%B4%D1%83%D1%88%D0%BD%D0%BE%D0%B3%D0%BE_%D1%82%D1%80%D0%B0%D0%BD%D1%81%D0%BF%D0%BE%D1%80%D1%82%D0%B0). |
**Элементы объекта**`transport_subtype`
| | | |
| --- | --- | --- |
| **Элемент JSON** | **Тип** | **Описание** |
| `color` | Строка | Основной цвет транспортного средства в шестнадцатеричном формате. |
| `code` | Строка | Код подтипа транспорта для типа, указанного в элементе `transport_type`. Подтип может совпадать с типом (например, для обычной электрички указывается тип `suburban` и подтип `suburban`).<br>Другие возможные значения:<br>- `helicopter` — вертолет (для типа `plane`)<br>- `rex` — экспресс РЭКС (для типа `suburban`)<br>- `sputnik` — «Спутник» (для типа `suburban`)<br>- `skiarrow` — «Лыжная стрела» (для типа `suburban`)<br>- `shezh` — «Снежинка» (для типа `suburban`)<br>- `skirus` — «Лыжня России» (для типа `suburban`)<br>- `city` — городская электричка (для типа `suburban`)<br>- `kalina` — «Калина красная» (для типа `suburban`)<br>- `vostok` — «Восток» (для типа `suburban`)<br>- `prostoryaltaya` — «Просторы Алтая» (для типа `suburban`)<br>- `14vag` — состав из 14 вагонов (для типа `suburban`)<br>- `last` — «Ласточка» (для типа `suburban`)<br>- `exprdal` — экспресс с билетами на конкретные места (для типа `suburban`)<br>- `volzhex` — «Волжский экспресс» (для типа `suburban`)<br>- `stdplus` — электрички типа «стандарт плюс» (для типа `suburban`)<br>- `express` — экспресс (для типа `suburban`)<br>- `skor` — ускоренный поезд (для типа `suburban`)<br>- `fiztekh` — Физтех.Электричка (для типа `suburban`)<br>- `vag6` — состав из 6 вагонов (для типа `suburban`);<br>- `river` — речной транспорт (для типа `water`);<br>- `sea` — морской транспорт (для типа `water`). |
| `title` | Строка | Описание подтипа транспорта на естественном языке. |
```
<response>
<except_days>18 марта</except_days>
<from>xsi:nil="true"</from>
<uid>038AA_tis</uid>
<start_date>2017-03-19</start_date>
<title>Москва - Санкт-Петербург</title>
<interval>
<begin_time>2017-06-10T06:00:00</begin_time>
<end_time>2017-06-10T22:30:00</end_time>
<density>автобус раз в 10-15 минут</density>
</interval>
<start_time>22:41</start_time>
<number>038А</number>
<short_title>Москва - Санкт-Петербург</short_title>
<days>ежедневно, кроме вс</days>
<to>xsi:nil="true"</to>
<carrier>
<code{carrier}>112</code>
<title{carrier}>РЖД/ФПК</title>
<codes{carrier}>
<iata/>
<icao/>
<sirena/>
</codes>
</carrier>
<transport_type>train</transport_type>
<stop>
<arrival/>
<duration>0.0</duration>
<platform/>
<terminal/>
<departure>2014-02-20T00:44:00+03:00</departure>
<stop_time/>
<station>
<code{station}>s2006004</code>
<type>station</type>
<codes{station}>
<esr>060073</esr>
<yandex>s2006004</yandex>
<express>2006004</express>
</codes>
<title{station}>Москва (Ленинградский вокзал)</title>
<short_title>М-Ленинградск</short_title>
<popular_title>Ленинградский вокзал</popular_title>
</station>
</stop>
<stop>
...
</stop>
...
<vehicle>xsi:nil="true"</vehicle>
<transport_subtype>
<color>#FF7F44</color>
<code>suburban</code>
<title>Пригородный поезд</title>
</transport_subtype>
<express_type>xsi:nil="true"</express_type>
</response>
```
#### Описание элементов XML
| | | |
| --- | --- | --- |
| **Элемент XML** | **Тип** | **Описание** |
| `except_days` | Строка | Дни, в которые нитка не курсирует (даже если они входят в множество, описанное элементом `days`). |
| `arrival_date` | Строка | Дата прибытия на станцию, указанную в параметре `to`.<br>Включается в ответ только если нитка не является _интервальной_. |
| `from` | Строка | Пункт отправления, указанный в параметре `from`. |
| `uid` | Строка (не более 100 символов) | Идентификатор нитки, принятый в Яндекс Расписаниях. |
| `interval` | Информация о движении по интервальной нитке. | |
| `start_time` | Строка | Время отправления с первой станции следования по местному времени станции. |
| `number` | Строка | Номер рейса. |
| `stops` | Массив | Элемент, описывающий станцию следования. |
| `express_type` | Строка | Признак экспресса или аэроэкспресса. Значение по умолчанию — `null`.<br>Если тип транспорта — электричка (ключ `transport_type` возвращен со значением `suburban`), принимает одно из значений:<br>- `express` — экспресс-рейс;<br>- `aeroexpress` — рейс, курсирующий между городом и аэропортом. |
| `title` | Строка | Название нитки, составленное из полных названий первой и последней станций следования. |
| `departure_date` | Строка | Дата отправления со станции, указанной в параметре `from`.<br>Включается в ответ, только если нитка не является _интервальной_. |
| `days` | Строка | Дни курсирования нитки. |
| `short_title` | Строка | Название нитки, составленное из коротких названий первой и последней станций следования. |
| `to` | Строка | Пункт прибытия, указанный в параметре `to`. |
| `carrier` | Информация о перевозчике. | |
| `transport_type` | Строка | Тип транспорта. Возможные значения:<br>- `plane` — самолет;<br>- `train` — поезд;<br>- `suburban` — электричка;<br>- `bus` — автобус;<br>- `water` — водный транспорт;<br>- `helicopter` — вертолет. |
| `vehicle` | Строка | Название транспортного средства. |
**Элементы, вложенные в элемент**`interval`
| | | |
| --- | --- | --- |
| **Элемент XML** | **Тип** | **Описание** |
| `begin_time` | Число | Дата и время начала движения по нитке. Всегда указывается в часовом поясе станции отправления.<br>Могут быть указаны в одном из двух форматов:<br>- `YYYY-MM-DD`, если в запросе не был передан параметр `date`.<br>- `YYYY-MM-DDTHH:MM:SS`, если параметр `date` был передан. |
| `end_time` | | Дата и время окончания движения по нитке. Всегда указывается в часовом поясе станции отправления.<br>Могут быть указаны в одном из двух форматов:<br>- `YYYY-MM-DD`, если в запросе не был передан параметр `date`.<br>- `YYYY-MM-DDTHH:MM:SS`, если параметр `date` был передан. |
| `density` | Строка | Описание периодичности движения в свободной форме. |
**Элементы, вложенные в элемент**`stop`
| | | |
| --- | --- | --- |
| **Элемент XML** | **Тип** | **Описание** |
| `arrival` | Строка | Время прибытия, в формате ISO 8601 (YYYY-MM-DDThh:mm:ss±hh:mm).<br>Если параметр `result_timezone` не был передан, указывается в часовом поясе станции. |
| `duration` | Число | Время в пути между станциями (в секундах). |
| `station` | | Элемент, содержащий информацию о станции следования. |
| `departure` | Строка | Время отправления со станции по местному времени станции. |
| `stop_time` | Число | Время остановки (в секундах). |
| `platform` | Строка | Платформа или путь, с которого отправляется рейс (например, «3 путь»).<br>Пустая строка значит, что информации о платформе или пути нет. |
| `terminal` | Строка | Терминал аэропорта (например, «D»).<br>Принимает значение `null`, если информации о терминале нет. |
**Элементы, вложенные в элемент**`station`
| | | |
| --- | --- | --- |
| **Элемент XML** | **Тип** | **Описание** |
| `codes` | | Элемент, содержащий список кодов станции в других системах кодирования, поддерживаемый Яндекс Расписаниями. |
| `title` | Строка | Название станции. |
| `station_type` | Строка | Тип станции:<br>- `station` — станция;<br> <br>- `platform` — платформа;<br> <br>- `stop` — остановочный пункт;<br> <br>- `checkpoint` — блок-пост;<br> <br>- `post` — пост;<br> <br>- `crossing` — разъезд;<br> <br>- `overtaking_point` — обгонный пункт;<br> <br>- `train_station` — вокзал;<br> <br>- `airport` — аэропорт;<br> <br>- `bus_station` — автовокзал;<br> <br>- `bus_stop` — автобусная остановка;<br> <br>- `unknown` — станция без типа;<br> <br>- `port` — порт;<br> <br>- `port_point` — портпункт;<br> <br>- `wharf` — пристань;<br> <br>- `river_port` — речной вокзал;<br> <br>- `marine_station` — морской вокзал. |
| `station_type_name` | Строка | Название типа станции, зависит от языка ответа. Возможные значения на русском — в списке значений элемента `station_type`. |
| `popular_title` | Строка | Общепринятое название станции. |
| `short_title` | Строка | Короткое название станции. |
| `code` | Строка | Код станции в системе кодирования Яндекс Расписаний. |
| `type` | Строка | Вид станции. Для запроса расписания по станции возможно только одно значение — `station`. |
**Элементы, вложенные в элемент**`codes`
| | | |
| --- | --- | --- |
| **Элемент XML** | **Тип** | **Описание** |
| `express` | Строка | Код станции в системе кодирования [Экспресс-3](http://www.express-3.ru/). |
| `yandex` | Строка | Код станции в системе кодирования Яндекс Расписаний. |
| `esr` | Строка | Код станции в системе кодирования [ЕСР](https://ru.wikipedia.org/wiki/%D0%95%D0%B4%D0%B8%D0%BD%D0%B0%D1%8F_%D1%81%D0%B5%D1%82%D0%B5%D0%B2%D0%B0%D1%8F_%D1%80%D0%B0%D0%B7%D0%BC%D0%B5%D1%82%D0%BA%D0%B0). |
**Элементы, вложенные в элемент**`carrier`
| | | |
| --- | --- | --- |
| **Элемент XML** | **Тип** | **Описание** |
| `code` | Число | Код перевозчика в системе кодирования Яндекс Расписаний. |
| `codes` | | Элемент, содержащий список кодов перевозчика в других системах кодирования, поддерживаемый Яндекс Расписаниями. |
| `title` | Строка | Название перевозчика. |
**Элементы, вложенные в элемент**`codes`
| | | |
| --- | --- | --- |
| **Элемент XML** | **Тип** | **Описание** |
| `icao` | Строка | Код перевозчика в системе кодирования [ICAO](https://ru.wikipedia.org/wiki/%D0%9C%D0%B5%D0%B6%D0%B4%D1%83%D0%BD%D0%B0%D1%80%D0%BE%D0%B4%D0%BD%D0%B0%D1%8F_%D0%BE%D1%80%D0%B3%D0%B0%D0%BD%D0%B8%D0%B7%D0%B0%D1%86%D0%B8%D1%8F_%D0%B3%D1%80%D0%B0%D0%B6%D0%B4%D0%B0%D0%BD%D1%81%D0%BA%D0%BE%D0%B9_%D0%B0%D0%B2%D0%B8%D0%B0%D1%86%D0%B8%D0%B8). |
| `sirena` | Строка | Код перевозчика в системе кодирования [Sirena](http://ru.wikipedia.org/wiki/%D0%A1%D0%B8%D1%80%D0%B5%D0%BD%D0%B0_(%D1%81%D0%B5%D1%82%D1%8C)). |
| `iata` | Строка | Код перевозчика в системе кодирования [IATA](https://ru.wikipedia.org/wiki/%D0%9C%D0%B5%D0%B6%D0%B4%D1%83%D0%BD%D0%B0%D1%80%D0%BE%D0%B4%D0%BD%D0%B0%D1%8F_%D0%B0%D1%81%D1%81%D0%BE%D1%86%D0%B8%D0%B0%D1%86%D0%B8%D1%8F_%D0%B2%D0%BE%D0%B7%D0%B4%D1%83%D1%88%D0%BD%D0%BE%D0%B3%D0%BE_%D1%82%D1%80%D0%B0%D0%BD%D1%81%D0%BF%D0%BE%D1%80%D1%82%D0%B0). |
### Станция
Место отправления, прибытия или остановки транспортного средства. Например, автобусная остановка, автовокзал, аэропорт и т. п.
### Нитка
Маршрут и время движения транспортного средства от начальной точки движения до конечной, привязанный к определенной дате.
Каждому рейсу соответствует нитка или набор ниток, определенный для конкретного дня. Например, в будние дни рейс «Москва — Голицыно» может двигаться по ниткам: «Москва — Одинцово», «Одинцово — Голицыно». В выходные дни этот же рейс может двигаться по нитке «Москва — Голицыно».
### Интервальная нитка
Нитка, на остановках которой транспорт останавливается с определенной периодичностью, но без четкого расписания.
[Ключ доступа](https://yandex.ru/dev/rasp/doc/ru/concepts/access) к API.
Параметр можно не передавать, если ключ доступа указан в заголовке `Authorization`, например:
```
Authorization: 1eb31582-941a-3ac8-a61f-041c344495ab
```
Идентификатор нитки в Яндекс Расписаниях.
Идентификатор нитки может меняться со временем. Поэтому перед каждым запросом станций нитки необходимо получать актуальный идентификатор запросом [расписания рейсов между станциями](https://yandex.ru/dev/rasp/doc/ru/reference/schedule-point-point) или [расписания рейсов по станции](https://yandex.ru/dev/rasp/doc/ru/reference/schedule-on-station).
Код станции отправления. Должен быть указан в [системе кодирования](https://yandex.ru/dev/rasp/doc/ru/concepts/coding-system).
При использовании системы кодирования Яндекс Расписаний в данном параметре также можно указать код населенного пункта.
Код населенного пункта или код станции можно получить из адресной строки, пользуясь Яндекс Расписаниями. Например, из адресной строки:
- «http://rasp.yandex.ru/station/9600213» — код станции «s9600213» (к числовому значению кода добавляется латинская буква «s»);
- «http://rasp.yandex.ru/city/146» — код населенного пункта «c146» (к числовому значению кода добавляется латинская буква «c»).
Код станции прибытия. Должен быть указан в [системе кодирования](https://yandex.ru/dev/rasp/doc/ru/concepts/coding-system).
При использовании системы кодирования Яндекс Расписаний в данном параметре также можно указать код населенного пункта.
Код населенного пункта или код станции можно получить из адресной строки, пользуясь Яндекс Расписаниями. Например, из адресной строки:
- «https://rasp.yandex.ru/station/9600213» — код станции «s9600213» («s» от сокращенного «station»).
- «https://rasp.yandex.ru/city/146» — код населенного пункта «c146» («c» от сокращенного «city»).
Формат ответа. Поддерживаемые значения:
- `json` (по умолчанию);
- `xml`.
Язык возвращаемой информации, в формате <код языка>\_<код страны>. Поддерживаемые коды языка описаны стандартом [ISO 639](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2), коды стран — стандартом [ISO 3166](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).
По умолчанию ответ возвращается для значения `ru_RU`.
Поддерживаемые коды языков:
- `ru` — русский;
- `uk` — украинский.
Поддерживаемые коды стран:
- `RU` — Россия;
- `UA` — Украина.
Дата, на которую необходимо получить список станций следования. Должна быть указана в формате, соответствующем стандарту [ISO 8601](https://ru.wikipedia.org/wiki/ISO_8601). Например, YYYY-MM-DD.
По умолчанию возвращается список станций следования на первую дату хождения нитки.
[Cистеме кодирования](https://yandex.ru/dev/rasp/doc/ru/concepts/coding-system), в которой необходимо получить коды станций (в элементе ответа `codes`, вложенном в элемент `station`).
Возможные значения:
- `yandex` — система кодирования Яндекс Расписаний;
- `esr` — коды железнодорожных станций СНГ и стран Балтии из базы [ЕСР](https://ru.wikipedia.org/wiki/%D0%95%D0%B4%D0%B8%D0%BD%D0%B0%D1%8F_%D1%81%D0%B5%D1%82%D0%B5%D0%B2%D0%B0%D1%8F_%D1%80%D0%B0%D0%B7%D0%BC%D0%B5%D1%82%D0%BA%D0%B0);
- `all` — коды всех поддерживаемых систем кодирования.
По умолчанию элемент `station` не содержит элемента `codes`.
**Тип**
Объект
**Описание**
Информация о станции отправления рейса.
**Тип**
Строка
**Описание**
Код пункта прибытия в системе кодирования Яндекс Расписаний.
**Тип**
Строка
**Описание**
Вид пункта отправления.
Возможные значения:
- `station` — станция;
- `settlement` — поселение.
**Тип**
Строка
**Описание**
Название пункта отправления.
**Тип**
Строка
**Описание**
Время прибытия, в формате ISO 8601 (YYYY-MM-DDThh:mm:ss±hh:mm).
Если параметр `result_timezone` не был передан, указывается в часовом поясе станции.
**Тип**
Строка
**Описание**
Тип отправляющегося транспортного средства.
Возможные значения:
- `plane` — самолет;
- `train` — поезд;
- `suburban` — электричка;
- `bus` — автобус;
- `water` — водный транспорт;
- `helicopter` — вертолет.
**Тип**
Объект
**Описание**
Код перевозчика в системе кодирования [ICAO](https://ru.wikipedia.org/wiki/%D0%9C%D0%B5%D0%B6%D0%B4%D1%83%D0%BD%D0%B0%D1%80%D0%BE%D0%B4%D0%BD%D0%B0%D1%8F_%D0%BE%D1%80%D0%B3%D0%B0%D0%BD%D0%B8%D0%B7%D0%B0%D1%86%D0%B8%D1%8F_%D0%B3%D1%80%D0%B0%D0%B6%D0%B4%D0%B0%D0%BD%D1%81%D0%BA%D0%BE%D0%B9_%D0%B0%D0%B2%D0%B8%D0%B0%D1%86%D0%B8%D0%B8).
**Тип**
Строка
**Описание**
Код перевозчика в системе кодирования [Sirena](http://ru.wikipedia.org/wiki/%D0%A1%D0%B8%D1%80%D0%B5%D0%BD%D0%B0_(%D1%81%D0%B5%D1%82%D1%8C)).
**Тип**
Строка
**Описание**
Код перевозчика в системе кодирования [IATA](https://ru.wikipedia.org/wiki/%D0%9C%D0%B5%D0%B6%D0%B4%D1%83%D0%BD%D0%B0%D1%80%D0%BE%D0%B4%D0%BD%D0%B0%D1%8F_%D0%B0%D1%81%D1%81%D0%BE%D1%86%D0%B8%D0%B0%D1%86%D0%B8%D1%8F_%D0%B2%D0%BE%D0%B7%D0%B4%D1%83%D1%88%D0%BD%D0%BE%D0%B3%D0%BE_%D1%82%D1%80%D0%B0%D0%BD%D1%81%D0%BF%D0%BE%D1%80%D1%82%D0%B0).
**Тип**
Объект
**Описание**
Информация о подтипе транспортного средства.
**Тип**
Строка
**Описание**
Основной цвет транспортного средства в шестнадцатеричном формате.
**Тип**
Строка
**Описание**
Название транспортного средства.
**Тип**
Строка
**Описание**
Признак экспресса или аэроэкспресса. Значение по умолчанию — `null`.
Если тип транспорта — электричка (ключ `transport_type` возвращен со значением `suburban`), принимает одно из значений:
- `express` — экспресс-рейс;
- `aeroexpress` — рейс, курсирующий между городом и аэропортом.
**Тип**
Строка
**Описание**
Время отправления, в формате ISO 8601 (YYYY-MM-DDThh:mm:ss±hh:mm).
Если параметр `result_timezone` не был передан, указывается в часовом поясе станции.
**Тип**
Строка
**Описание**
Дни, в которые нитка не курсирует (даже если они входят в множество, описанное элементом days).
**Тип**
Объект
**Описание**
Информация о перевозчике.
**Тип**
Строка
**Описание**
Платформа или путь, с которого отправляется рейс (например, «3 путь»).
Пустая строка значит, что информации о платформе или пути нет.
**Тип**
Строка
**Описание**
Дни, в которые нитка не курсирует (даже если они входят в множество, описанное элементом days).
**Тип**
Строка
**Описание**
Терминал аэропорта (например, «D»).
Принимает значение `null`, если информации о терминале нет.
**Тип**
Объект
**Описание**
Информация об указанной в запросе станции.
**Тип**
Строка
**Описание**
Код станции в системе кодирования Яндекс Расписаний.
**Тип**
Строка
**Описание**
Код станции в системе кодирования [ЕСР](https://ru.wikipedia.org/wiki/%D0%95%D0%B4%D0%B8%D0%BD%D0%B0%D1%8F_%D1%81%D0%B5%D1%82%D0%B5%D0%B2%D0%B0%D1%8F_%D1%80%D0%B0%D0%B7%D0%BC%D0%B5%D1%82%D0%BA%D0%B0).
**Тип**
Строка (не более 100 символов)
**Описание**
Идентификатор нитки, принятый в Яндекс Расписаниях.
**Тип**
Строка
**Описание**
Дата отправления с первой станции следования.
**Тип**
Объект
**Описание**
Информация о движении по интервальной нитке.
**Тип**
Число
**Описание**
Дата и время начала движения по нитке. Всегда указывается в часовом поясе станции отправления.
Могут быть указаны в одном из двух форматов:
- `YYYY-MM-DD`, если в запросе не был передан параметр `date`.
- `YYYY-MM-DDTHH:MM:SS`, если параметр `date` был передан.
**Тип**
Строка
**Описание**
Дата и время окончания движения по нитке. Всегда указывается в часовом поясе станции отправления.
Могут быть указаны в одном из двух форматов:
- `YYYY-MM-DD`, если в запросе не был передан параметр `date`.
- `YYYY-MM-DDTHH:MM:SS`, если параметр `date` был передан.
**Тип**
Строка
**Описание**
Описание периодичности движения в свободной форме.
**Тип**
Строка
**Описание**
Время отправления с первой станции следования по местному времени станции.
Включается в ответ только если нитка не является [интервальной](https://yandex.ru/dev/rasp/doc/ru/concepts/termin#intervalthread).
**Тип**
Строка
**Описание**
Название нитки, составленное из коротких названий первой и последней станций следования.
**Тип**
Строка
**Описание**
Пункт прибытия, указанный в параметре `to`.
**Тип**
Число
**Описание**
Время в пути между станциями (в секундах).
**Тип**
Число
**Описание**
Продолжительность остановки (в секундах).
**Тип**
Строка
**Описание**
Код станции в системе кодирования [Экспресс-3](http://www.express-3.ru/).
**Тип**
Строка
**Описание**
Общепринятое название станции.

210
docs/yandex-api-docs/nearest-settlement.md Normal file
View File

@@ -0,0 +1,210 @@
Ближайший город
# Ближайший город
- [Синтаксис запроса](https://yandex.ru/dev/rasp/doc/ru/reference/nearest-settlement#format)
- [Структура ответа](https://yandex.ru/dev/rasp/doc/ru/reference/nearest-settlement#emails-detailed)
Запрос позволяет получить информацию о ближайшем к указанной точке городе. Точка определяется географическими координатами (широтой и долготой) согласно [WGS84](http://ru.wikipedia.org/wiki/WGS_84). Поиск можно ограничить определенным радиусом (по умолчанию — 10 километров, но не больше 50).
## Синтаксис запроса
```
https://api.rasp.yandex-net.ru/v3.0/nearest_settlement/ ?
apikey=<ключ>
& lat=<широта>
& lng=<долгота>
& [distance=<радиус охвата>]
& [lang=<язык>]
& [format=<формат>]
```
Пример запроса:
```
https://api.rasp.yandex-net.ru/v3.0/nearest_settlement/?apikey={ключ}&format=json&lat=50.440046&lng=40.4882367&distance=50&lang=ru_RU
```
Входные параметры:
**Обязательные параметры**
| | |
| --- | --- |
| **Параметр** | **Описание** |
| `apikey` | [Ключ доступа](https://yandex.ru/dev/rasp/doc/ru/concepts/access) к API.<br>Параметр можно не передавать, если ключ доступа указан в заголовке `Authorization`, например:<br>```<br>Authorization: 1eb31582-941a-3ac8-a61f-041c344495ab<br>``` |
| `lat` | Широта согласно [WGS84](http://ru.wikipedia.org/wiki/WGS_84). |
| `lng` | Долгота согласно [WGS84](http://ru.wikipedia.org/wiki/WGS_84). |
**Необязательные параметры**
| | |
| --- | --- |
| **Параметр** | **Описание** |
| `distance` | Радиус, в котором следует искать ближайший город, в километрах. |
| `lang` | Язык возвращаемой информации, в формате <код языка>\_<код страны>. Поддерживаемые коды языка описаны стандартом [ISO 639](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2), коды стран — стандартом [ISO 3166](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).<br>По умолчанию ответ возвращается для значения `ru_RU`.<br>Поддерживаемые коды языков:<br>- `ru` — русский;<br>- `uk` — украинский.<br>Поддерживаемые коды стран:<br>- `RU` — Россия;<br>- `UA` — Украина. |
| `format` | Формат ответа. Поддерживаемые значения:<br>- `json` (по умолчанию);<br>- `xml`. |
## Структура ответа
Ответ представляет собой информацию о ближайшем к указанной точке городе, находящемся внутри указанного радиуса поиска.
Пример ответа в формате JSON
Пример ответа в формате XML
```
{
"distance": 4.981302906703597,
"code": "c22512",
"title": "Пронск",
"popular_title": "Пронск",
"short_title": "Пронск",
"lat": 54.106677,
"lng": 39.601726,
"type": "settlement"
}
```
#### Описание элементов JSON
| | | |
| --- | --- | --- |
| **Элемент JSON** | **Тип** | **Описание** |
| `distance` | Число | Расстояние до найденного города, в километрах. |
| `code` | Строка | Код города в системе кодирования Яндекс Расписаний. |
| `title` | Строка | Название города. |
| `popular_title` | Строка | Общепринятое название города. |
| `short_title` | Строка | Краткое название города. |
| `lat` | Число | Широта, на которой находится город. |
| `lng` | Число | Долгота, на которой находится город. |
| `type` | Строка | Тип транспортного пункта:<br>- `station` — станция;<br> <br>- `settlement` — поселение. |
```
<response>
<distance>4.9813029067</distance>
<code>c22512</code>
<title>Пронск</title>
<lat>54.106677</lat>
<lng>39.601726</lng>
<type>settlement</type>
<popular_title>Пронск</popular_title>
<short_title>Пронск</short_title>
</response>
```
#### Описание элементов XML
| | | |
| --- | --- | --- |
| **Элемент XML** | **Тип** | **Описание** |
| `distance` | Число | Расстояние до найденного города, в километрах. |
| `code` | Строка | Код города в системе кодирования Яндекс Расписаний. |
| `title` | Строка | Название города. |
| `popular_title` | Строка | Общепринятое название города. |
| `short_title` | Строка | Краткое название города. |
| `lat` | Число | Широта, на которой находится город. |
| `lng` | Число | Долгота, на которой находится город. |
| `type` | Строка | Тип транспортного пункта:<br>- `station` — станция;<br> <br>- `settlement` — поселение. |
[Ключ доступа](https://yandex.ru/dev/rasp/doc/ru/concepts/access) к API.
Параметр можно не передавать, если ключ доступа указан в заголовке `Authorization`, например:
```
Authorization: 1eb31582-941a-3ac8-a61f-041c344495ab
```
Широта согласно [WGS84](http://ru.wikipedia.org/wiki/WGS_84).
Долгота согласно [WGS84](http://ru.wikipedia.org/wiki/WGS_84).
Радиус, в котором следует искать ближайший город, в километрах.
Язык возвращаемой информации, в формате <код языка>\_<код страны>. Поддерживаемые коды языка описаны стандартом [ISO 639](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2), коды стран — стандартом [ISO 3166](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).
По умолчанию ответ возвращается для значения `ru_RU`.
Поддерживаемые коды языков:
- `ru` — русский;
- `uk` — украинский.
Поддерживаемые коды стран:
- `RU` — Россия;
- `UA` — Украина.
Формат ответа. Поддерживаемые значения:
- `json` (по умолчанию);
- `xml`.
**Тип**
Строка
**Описание**
Тип транспортного пункта:
- `station` — станция;
- `settlement` — поселение.
**Тип**
Число
**Описание**
Широта, на которой находится город.
**Тип**
Число
**Описание**
Долгота, на которой находится город.
**Тип**
Число
**Описание**
Расстояние до найденного города, в километрах.
**Тип**
Строка
**Описание**
Код города в системе кодирования Яндекс Расписаний.
**Тип**
Строка
**Описание**
Название города.
**Тип**
Строка
**Описание**
Общепринятое название города.
**Тип**
Строка
**Описание**
Краткое название города.

312
docs/yandex-api-docs/query-carrier.md Normal file
View File

@@ -0,0 +1,312 @@
Синтаксис запроса
# Информация о перевозчике
- [Синтаксис запроса](https://yandex.ru/dev/rasp/doc/ru/reference/query-carrier#query)
- [Структура ответа](https://yandex.ru/dev/rasp/doc/ru/reference/query-carrier#emails-detailed)
Запрос позволяет получить информацию о [перевозчике](https://yandex.ru/dev/rasp/doc/ru/concepts/termin#carrier) по указанному коду перевозчика.
Коды перевозчиков можно получить в публичных справочниках кодов, а также в ответах на запросы: [Расписание рейсов между станциями](https://yandex.ru/dev/rasp/doc/ru/reference/schedule-point-point), [Расписание рейсов по станции](https://yandex.ru/dev/rasp/doc/ru/reference/schedule-on-station), [Список станций следования](https://yandex.ru/dev/rasp/doc/ru/reference/list-stations-route).
## Синтаксис запроса
```
https://api.rasp.yandex-net.ru/v3.0/carrier/ ?
apikey=<ключ>
& code=<код перевозчика>
[& format=<формат>]
[& lang=<язык>]
[& system=<текущая система кодирования>]
```
Пример запроса:
```
https://api.rasp.yandex-net.ru/v3.0/carrier/?format=json&apikey={ключ}&lang=ru_RU&code=TK&system=iata
```
Входные параметры:
**Обязательные параметры**
| | |
| --- | --- |
| **Параметр** | **Описание** |
| `apikey` | [Ключ доступа](https://yandex.ru/dev/rasp/doc/ru/concepts/access) к API.<br>Параметр можно не передавать, если ключ доступа указан в заголовке `Authorization`, например:<br>```<br>Authorization: 1eb31582-941a-3ac8-a61f-041c344495ab<br>``` |
| `code` | Код перевозчика. По умолчанию в системе кодирования Яндекс Расписаний. Чтобы отправить код в другой системе кодирования, укажите параметр `system`.<br>Если код указан в системе кодирования IATA, в ответе могут быть описаны несколько перевозчиков. |
**Необязательные параметры**
| | |
| --- | --- |
| **Параметр** | **Описание** |
| `system` | [Система кодирования](https://yandex.ru/dev/rasp/doc/ru/concepts/coding-system), в которой указывается код перевозчика (параметр `code`) в запросе. Возможные значения:<br>- `yandex` (значение по умолчанию) — система кодирования Яндекс Расписаний;<br>- `iata` — [коды Международной ассоциации воздушного транспорта](https://ru.wikipedia.org/wiki/%D0%9A%D0%BE%D0%B4_%D0%98%D0%90%D0%A2%D0%90);<br>- `sirena` — коды в системах, построенных на базе [сетей «Сирена»](http://ru.wikipedia.org/wiki/%D0%A1%D0%B8%D1%80%D0%B5%D0%BD%D0%B0_(%D1%81%D0%B5%D1%82%D1%8C));<br>- `express` — коды железнодорожных станций СНГ и стран Балтии из базы [Экспресс-3](http://www.express-3.ru/);<br>- `esr` — коды железнодорожных станций СНГ и стран Балтии из базы [ЕСР](https://ru.wikipedia.org/wiki/%D0%95%D0%B4%D0%B8%D0%BD%D0%B0%D1%8F_%D1%81%D0%B5%D1%82%D0%B5%D0%B2%D0%B0%D1%8F_%D1%80%D0%B0%D0%B7%D0%BC%D0%B5%D1%82%D0%BA%D0%B0).<br>Параметр обязателен, если используется система кодирования, отличная от системы кодирования Яндекс Расписаний. |
| `lang` | Язык возвращаемой информации, в формате <код языка>\_<код страны>. Поддерживаемые коды языка описаны стандартом [ISO 639](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2), коды стран — стандартом [ISO 3166](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).<br>По умолчанию ответ возвращается для значения `ru_RU`.<br>Поддерживаемые коды языков:<br>- `ru` — русский;<br>- `uk` — украинский.<br>Поддерживаемые коды стран:<br>- `RU` — Россия;<br>- `UA` — Украина. |
| `format` | Формат ответа. Поддерживаемые значения:<br>- `json` (по умолчанию);<br>- `xml`. |
## Структура ответа
Ответ содержит информацию об указанном в запросе перевозчике. Если код перевозчика в запросе указан в системе кодирования [IATA](https://ru.wikipedia.org/wiki/%D0%9C%D0%B5%D0%B6%D0%B4%D1%83%D0%BD%D0%B0%D1%80%D0%BE%D0%B4%D0%BD%D0%B0%D1%8F_%D0%B0%D1%81%D1%81%D0%BE%D1%86%D0%B8%D0%B0%D1%86%D0%B8%D1%8F_%D0%B2%D0%BE%D0%B7%D0%B4%D1%83%D1%88%D0%BD%D0%BE%D0%B3%D0%BE_%D1%82%D1%80%D0%B0%D0%BD%D1%81%D0%BF%D0%BE%D1%80%D1%82%D0%B0) ответ содержит данные по нескольким перевозчикам (вместо одного элемента `carrier` возвращается массив `carriers`).
Структура ответа в различных форматах показана в примерах.
Пример ответа в формате JSON
Пример ответа в формате XML
```
{
"carriers":
[\
{\
"code": 680,\
"contacts": "Телефон: +7 (1234) 123456",\
"url": "http://www.example.com/",\
"title": "Россия",\
"phone": "",\
"codes":\
{\
"icao": null,\
"sirena": null,\
"iata": "SU"\
},\
"address": "Санкт-Петербург, ул. Строителей, д. 18",\
"logo": "//yastatic.net/rasp/media/data/company/logo/logo_1.jpg",\
"email": ""\
}\
...\
]
}
```
#### Описание элементов JSON
| | | |
| --- | --- | --- |
| **Элемент JSON** | **Тип** | **Описание** |
| `carriers` | Массив | Список перевозчиков.<br>Может быть включен в ответ, если код перевозчика был указан в системе IATA. |
**Элементыобъекта**`carriers`
| | | |
| --- | --- | --- |
| **Элемент JSON** | **Тип** | **Описание** |
| `code` | Число | Код перевозчика в указанной системе кодирования (по умолчанию — в системе Яндекс Расписаний.) |
| `contacts` | Строка | Контактная информация, в свободной форме. |
| `url` | Строка | Ссылка на сайт перевозчика. |
| `title` | Строка | Название перевозчика. |
| `phone` | Строка | Контактный номер телефона перевозчика. |
| `codes` | Объект | Список кодов перевозчика в других системах кодирования, поддерживаемых Яндекс Расписаниями. |
| `address` | Строка | Юридический адрес перевозчика. |
| `logo` | Строка | Ссылка на используемый Яндексом логотип перевозчика в растровом формате. |
| `email` | Строка | Электронный почтовый адрес перевозчика. |
**Элементыобъекта**`codes`
| | | |
| --- | --- | --- |
| **Элемент JSON** | **Тип** | **Описание** |
| `icao` | Строка | Код перевозчика в системе кодирования [ICAO](https://ru.wikipedia.org/wiki/%D0%9C%D0%B5%D0%B6%D0%B4%D1%83%D0%BD%D0%B0%D1%80%D0%BE%D0%B4%D0%BD%D0%B0%D1%8F_%D0%BE%D1%80%D0%B3%D0%B0%D0%BD%D0%B8%D0%B7%D0%B0%D1%86%D0%B8%D1%8F_%D0%B3%D1%80%D0%B0%D0%B6%D0%B4%D0%B0%D0%BD%D1%81%D0%BA%D0%BE%D0%B9_%D0%B0%D0%B2%D0%B8%D0%B0%D1%86%D0%B8%D0%B8). |
| `sirena` | Строка | Код перевозчика в системе кодирования [Sirena](http://ru.wikipedia.org/wiki/%D0%A1%D0%B8%D1%80%D0%B5%D0%BD%D0%B0_(%D1%81%D0%B5%D1%82%D1%8C)). |
| `iata` | Строка | Код перевозчика в системе кодирования [IATA](https://ru.wikipedia.org/wiki/%D0%9C%D0%B5%D0%B6%D0%B4%D1%83%D0%BD%D0%B0%D1%80%D0%BE%D0%B4%D0%BD%D0%B0%D1%8F_%D0%B0%D1%81%D1%81%D0%BE%D1%86%D0%B8%D0%B0%D1%86%D0%B8%D1%8F_%D0%B2%D0%BE%D0%B7%D0%B4%D1%83%D1%88%D0%BD%D0%BE%D0%B3%D0%BE_%D1%82%D1%80%D0%B0%D0%BD%D1%81%D0%BF%D0%BE%D1%80%D1%82%D0%B0). |
```
<response>
<carrier>
<code>680</code>
<title>Turkish Airlines</title>
<url>http://www.thy.com/</url>
<contacts/>
<phone></phone>
<codes>
<icao>xsi:nil="true"</icao>
<sirena>xsi:nil="true"</sirena>
<iata>SU</iata>
</codes>
<address>Москва, Ленинградский пр., д.37, корп.9 </address>
<logo>//yastatic.net/rasp/media/data/company/logo/logo_ru.gif</logo>
<email/>
</carrier>
...
</response>
```
#### Описание элементов XML
| | | |
| --- | --- | --- |
| **Элемент JSON** | **Тип** | **Описание** |
| `carrier` | | Элемент, содержащий контактные данные перевозчика. |
**Элементы, вложенные в**`carriers`
| | | |
| --- | --- | --- |
| **Элемент JSON** | **Тип** | **Описание** |
| `code` | Число | Код перевозчика в указанной системе кодирования (по умолчанию — в системе Яндекс Расписаний.) |
| `title` | Строка | Название перевозчика. |
| `url` | Строка | Ссылка на сайт перевозчика. |
| `contacts` | Строка | Контактная информация, в свободной форме. |
| `phone` | Строка | Контактный номер телефона перевозчика. |
| `codes` | | Список кодов перевозчика в других системах кодирования, поддерживаемых Яндекс Расписаниями. |
| `address` | Строка | Юридический адрес перевозчика. |
| `logo` | Строка | Ссылка на используемый Яндексом логотип перевозчика в растровом формате. |
| `email` | Строка | Электронный почтовый адрес перевозчика. |
**Элементы, вложенные в**`codes`
| | | |
| --- | --- | --- |
| **Элемент JSON** | **Тип** | **Описание** |
| `icao` | Строка | Код перевозчика в системе кодирования [ICAO](https://ru.wikipedia.org/wiki/%D0%9C%D0%B5%D0%B6%D0%B4%D1%83%D0%BD%D0%B0%D1%80%D0%BE%D0%B4%D0%BD%D0%B0%D1%8F_%D0%BE%D1%80%D0%B3%D0%B0%D0%BD%D0%B8%D0%B7%D0%B0%D1%86%D0%B8%D1%8F_%D0%B3%D1%80%D0%B0%D0%B6%D0%B4%D0%B0%D0%BD%D1%81%D0%BA%D0%BE%D0%B9_%D0%B0%D0%B2%D0%B8%D0%B0%D1%86%D0%B8%D0%B8). |
| `sirena` | Строка | Код перевозчика в системе кодирования [Sirena](http://ru.wikipedia.org/wiki/%D0%A1%D0%B8%D1%80%D0%B5%D0%BD%D0%B0_(%D1%81%D0%B5%D1%82%D1%8C)). |
| `iata` | Строка | Код перевозчика в системе кодирования [IATA](https://ru.wikipedia.org/wiki/%D0%9C%D0%B5%D0%B6%D0%B4%D1%83%D0%BD%D0%B0%D1%80%D0%BE%D0%B4%D0%BD%D0%B0%D1%8F_%D0%B0%D1%81%D1%81%D0%BE%D1%86%D0%B8%D0%B0%D1%86%D0%B8%D1%8F_%D0%B2%D0%BE%D0%B7%D0%B4%D1%83%D1%88%D0%BD%D0%BE%D0%B3%D0%BE_%D1%82%D1%80%D0%B0%D0%BD%D1%81%D0%BF%D0%BE%D1%80%D1%82%D0%B0). |
[Ключ доступа](https://yandex.ru/dev/rasp/doc/ru/concepts/access) к API.
Параметр можно не передавать, если ключ доступа указан в заголовке `Authorization`, например:
```
Authorization: 1eb31582-941a-3ac8-a61f-041c344495ab
```
Язык возвращаемой информации, в формате <код языка>\_<код страны>. Поддерживаемые коды языка описаны стандартом [ISO 639](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2), коды стран — стандартом [ISO 3166](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).
По умолчанию ответ возвращается для значения `ru_RU`.
Поддерживаемые коды языков:
- `ru` — русский;
- `uk` — украинский.
Поддерживаемые коды стран:
- `RU` — Россия;
- `UA` — Украина.
Формат ответа. Поддерживаемые значения:
- `json` (по умолчанию);
- `xml`.
Код перевозчика. По умолчанию в системе кодирования Яндекс Расписаний. Чтобы отправить код в другой системе кодирования, укажите параметр `system`.
Если код указан в системе кодирования IATA, в ответе могут быть описаны несколько перевозчиков.
[Система кодирования](https://yandex.ru/dev/rasp/doc/ru/concepts/coding-system), в которой указывается код перевозчика (параметр `code`) в запросе. Возможные значения:
- `yandex` (значение по умолчанию) — система кодирования Яндекс Расписаний;
- `iata` — [коды Международной ассоциации воздушного транспорта](https://ru.wikipedia.org/wiki/%D0%9A%D0%BE%D0%B4_%D0%98%D0%90%D0%A2%D0%90);
- `sirena` — коды в системах, построенных на базе [сетей «Сирена»](http://ru.wikipedia.org/wiki/%D0%A1%D0%B8%D1%80%D0%B5%D0%BD%D0%B0_(%D1%81%D0%B5%D1%82%D1%8C));
- `express` — коды железнодорожных станций СНГ и стран Балтии из базы [Экспресс-3](http://www.express-3.ru/);
- `esr` — коды железнодорожных станций СНГ и стран Балтии из базы [ЕСР](https://ru.wikipedia.org/wiki/%D0%95%D0%B4%D0%B8%D0%BD%D0%B0%D1%8F_%D1%81%D0%B5%D1%82%D0%B5%D0%B2%D0%B0%D1%8F_%D1%80%D0%B0%D0%B7%D0%BC%D0%B5%D1%82%D0%BA%D0%B0).
Параметр обязателен, если используется система кодирования, отличная от системы кодирования Яндекс Расписаний.
**Тип**
Число
**Описание**
Код перевозчика в указанной системе кодирования (по умолчанию — в системе Яндекс Расписаний.)
**Тип**
**Описание**
Элемент, содержащий контактные данные перевозчика.
**Тип**
Строка
**Описание**
Название перевозчика.
**Тип**
Строка
**Описание**
Ссылка на сайт перевозчика.
**Тип**
Строка
**Описание**
Контактная информация, в свободной форме.
**Тип**
Строка
**Описание**
Контактный номер телефона перевозчика.
**Тип**
Объект
**Описание**
Список кодов перевозчика в других системах кодирования, поддерживаемых Яндекс Расписаниями.
**Тип**
Строка
**Описание**
Код перевозчика в системе кодирования [ICAO](https://ru.wikipedia.org/wiki/%D0%9C%D0%B5%D0%B6%D0%B4%D1%83%D0%BD%D0%B0%D1%80%D0%BE%D0%B4%D0%BD%D0%B0%D1%8F_%D0%BE%D1%80%D0%B3%D0%B0%D0%BD%D0%B8%D0%B7%D0%B0%D1%86%D0%B8%D1%8F_%D0%B3%D1%80%D0%B0%D0%B6%D0%B4%D0%B0%D0%BD%D1%81%D0%BA%D0%BE%D0%B9_%D0%B0%D0%B2%D0%B8%D0%B0%D1%86%D0%B8%D0%B8).
**Тип**
Строка
**Описание**
Код перевозчика в системе кодирования [Sirena](http://ru.wikipedia.org/wiki/%D0%A1%D0%B8%D1%80%D0%B5%D0%BD%D0%B0_(%D1%81%D0%B5%D1%82%D1%8C)).
**Тип**
Строка
**Описание**
Код перевозчика в системе кодирования [IATA](https://ru.wikipedia.org/wiki/%D0%9C%D0%B5%D0%B6%D0%B4%D1%83%D0%BD%D0%B0%D1%80%D0%BE%D0%B4%D0%BD%D0%B0%D1%8F_%D0%B0%D1%81%D1%81%D0%BE%D1%86%D0%B8%D0%B0%D1%86%D0%B8%D1%8F_%D0%B2%D0%BE%D0%B7%D0%B4%D1%83%D1%88%D0%BD%D0%BE%D0%B3%D0%BE_%D1%82%D1%80%D0%B0%D0%BD%D1%81%D0%BF%D0%BE%D1%80%D1%82%D0%B0).
**Тип**
Строка
**Описание**
Юридический адрес перевозчика.
**Тип**
Строка
**Описание**
Ссылка на используемый Яндексом логотип перевозчика в растровом формате.
**Тип**
Строка
**Описание**
Электронный почтовый адрес перевозчика.

464
docs/yandex-api-docs/query-nearest-station.md Normal file
View File

@@ -0,0 +1,464 @@
Список ближайших станций
# Список ближайших станций
- [Синтаксис запроса](https://yandex.ru/dev/rasp/doc/ru/reference/query-nearest-station#format)
- [Структура ответа](https://yandex.ru/dev/rasp/doc/ru/reference/query-nearest-station#emails-detailed)
Запрос позволяет получить список [станций](https://yandex.ru/dev/rasp/doc/ru/concepts/termin#station), находящихся в указанном радиусе от указанной точки. Максимальное количество возвращаемых станций — 50.
Точка определяется географическими координатами (широтой и долготой) согласно [WGS84](http://ru.wikipedia.org/wiki/WGS_84).
## Синтаксис запроса
```
https://api.rasp.yandex-net.ru/v3.0/nearest_stations/ ?
apikey=<ключ>
& lat=<широта>
& lng=<долгота>
& distance=<радиус охвата>
& [lang=<язык>]
& [offset=<сдвиг относительно первого рейса в ответе>]
& [limit=<ограничение на количество рейсов в ответе>]
& [station_types=<тип станции>]
& [transport_types=<тип транспортного средства>]
& [format=<формат>]
```
Пример запроса:
```
https://api.rasp.yandex-net.ru/v3.0/nearest_stations/?apikey={ключ}&format=json&lat=50.440046&lng=40.4882367&distance=50&lang=ru_RU
```
Входные параметры:
**Обязательные параметры**
| | |
| --- | --- |
| **Параметр** | **Описание** |
| `apikey` | [Ключ доступа](https://yandex.ru/dev/rasp/doc/ru/concepts/access) к API.<br>Параметр можно не передавать, если ключ доступа указан в заголовке `Authorization`, например:<br>```<br>Authorization: 1eb31582-941a-3ac8-a61f-041c344495ab<br>``` |
| `lat` | Широта согласно [WGS84](http://ru.wikipedia.org/wiki/WGS_84). |
| `lng` | Долгота согласно [WGS84](http://ru.wikipedia.org/wiki/WGS_84). |
| `distance` | Радиус, в котором следует искать станции, в километрах. |
**Необязательные параметры**
| | |
| --- | --- |
| **Параметр** | **Описание** |
| `lang` | Язык возвращаемой информации, в формате <код языка>\_<код страны>. Поддерживаемые коды языка описаны стандартом [ISO 639](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2), коды стран — стандартом [ISO 3166](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).<br>По умолчанию ответ возвращается для значения `ru_RU`.<br>Поддерживаемые коды языков:<br>- `ru` — русский;<br>- `uk` — украинский.<br>Поддерживаемые коды стран:<br>- `RU` — Россия;<br>- `UA` — Украина. |
| `format` | Формат ответа. Поддерживаемые значения:<br>- `json` (по умолчанию);<br>- `xml`. |
| `station_types` | Типы запрашиваемых станций (несколько типов можно перечислить через запятую).<br>Поддерживаемые значения:<br>- `station` — станция;<br>- `platform` — платформа;<br>- `stop` — остановочный пункт;<br>- `checkpoint` — блок-пост;<br>- `post` — пост;<br>- `crossing` — разъезд;<br>- `overtaking_point` — обгонный пункт;<br>- `train_station` — вокзал;<br>- `airport` — аэропорт;<br>- `bus_station` — автовокзал;<br>- `bus_stop` — автобусная остановка;<br>- `unknown` — станция без типа;<br>- `port` — порт;<br>- `port_point` — портпункт;<br>- `wharf` — пристань;<br>- `river_port` — речной вокзал;<br>- `marine_station` — морской вокзал. |
| `transport_types` | Типы транспортного средства, для которых нужно искать станции. Несколько типов одновременно можно указать через запятую, например, plane,train,bus.<br>Поддерживаемые значения:<br>- `plane` — самолет;<br>- `train` — поезд;<br>- `suburban` — электричка;<br>- `bus` — автобус;<br>- `sea` — морской транспорт;<br>- `river` — речной транспорт;<br>- `helicopter` — вертолет. |
| `offset` | Смещение относительно первого результата поиска. Например, если вам не нужны первые 10 результатов поиска, задайте для параметра значение «10».<br>Значение по умолчанию — 0. |
| `limit` | Максимальное количество результатов поиска в ответе.<br>Значение по умолчанию — 100. |
## Структура ответа
Ответ представляет собой список станций, находящихся в указанном радиусе от указанной точки с информацией по каждой станции.
Пример ответа в формате JSON
Пример ответа в формате XML
```
{
"pagination":
{
"total": 35,
"limit": 100,
"offset": 0
},
"stations":
[\
{\
"distance": 24.74255931084455,\
"code": "s9637063",\
"station_type": "bus_station",\
"station_type_name": "автовокзал",\
"type_choices": {\
"schedule": {\
"desktop_url": "https://rasp.yandex.ru/station/9761931/schedule",\
"touch_url": "https://t.rasp.yandex.ru/station/9761931/schedule"\
}\
},\
"title": "Павловск",\
"popular_title": "",\
"short_title": "",\
"transport_type": "bus",\
"lat": 50.4516962252837,\
"lng": 40.1392928134917,\
"type": "station"\
},\
...\
]
}
```
#### Описание элементов JSON
| | | |
| --- | --- | --- |
| **Элемент JSON** | **Тип** | **Описание** |
| `pagination` | Массив | Информация о постраничном выводе. |
| `stations` | Массив | Список станций. |
**Элементыобъекта**`pagination`
| | | |
| --- | --- | --- |
| **Элемент JSON** | **Тип** | **Описание** |
| `total` | Число | Общее количество станций, удовлетворяющих условиям поиска. |
| `limit` | Число | Ограничение на количество станций, которые Яндекс Расписания возвращают в ответ на запрос. Ограничение можно задать в параметре `limit`.<br>Значение по умолчанию — 100. |
| `offset` | Число | Смещение относительно первого результата поиска. Смещение можно задать в параметре `offset`.<br>Значение по умолчанию — 0. |
**Элементыобъекта**`stations`
| | | |
| --- | --- | --- |
| **Элемент JSON** | **Тип** | **Описание** |
| `distance` | Число | Расстояние от указанной в запросе точки до полученной в ответе станции. |
| `code` | Строка | Код станции в системе кодирования Яндекс Расписаний. |
| `station_type` | Строка | Тип станции. Возможные значения:<br>- `station` — станция;<br>- `platform` — платформа;<br>- `stop` — остановочный пункт;<br>- `checkpoint` — блок-пост;<br>- `post` — пост;<br>- `crossing` — разъезд;<br>- `overtaking_point` — обгонный пункт;<br>- `train_station` — вокзал;<br>- `airport` — аэропорт;<br>- `bus_station` — автовокзал;<br>- `bus_stop` — автобусная остановка;<br>- `unknown` — станция без типа;<br>- `port` — порт;<br>- `port_point` — портпункт;<br>- `wharf` — пристань;<br>- `river_port` — речной вокзал;<br>- `marine_station` — морской вокзал. |
| `station_type_name` | Строка | Название типа станции, зависит от языка ответа. Возможные значения на русском — в списке значений ключа `station_type`. |
| `type_choices` | Объект | Типы расписаний, доступные для станции. Каждый тип описывается в отдельном объекте, который содержит ссылки на мобильную и десктопную версию расписания.<br>Доступные типы:<br>- `schedule` — вид расписания по умолчанию;<br>- `tablo` — табло аэропорта;<br>- `train` — расписание железнодорожного вокзала;<br>- `suburban` — расписание электричек;<br>- `aeroex` — расписание аэроэкспрессов. |
| `title` | Строка | Название станции. |
| `popular_title` | Строка | Общепринятое название станции. |
| `short_title` | Строка | Короткое название станции. |
| `majority` | Строка | Целое число, определяющее относительную важность станции в транспортном сообщении региона, где 1 — высшая важность (например, главный вокзал города). |
| `transport_type` | Строка | Основной тип транспорта для данной станции.<br>Возможные значения:<br>- `plane` — самолет;<br>- `train` — поезд;<br>- `suburban` — электричка;<br>- `bus` — автобус;<br>- `water` — водный транспорт;<br>- `helicopter` — вертолет. |
| `lat` | Число | Широта согласно [WGS84](http://ru.wikipedia.org/wiki/WGS_84). |
| `lng` | Число | Долгота согласно [WGS84](http://ru.wikipedia.org/wiki/WGS_84). |
| `type` | Строка | Вид найденного пункта. Возможные значения:<br>- `station` — станция;<br>- `settlement` — поселение. |
**Элементыобъекта**`type_choices`
| | | |
| --- | --- | --- |
| **Элемент JSON** | **Тип** | **Описание** |
| `total` | Число | Общее количество станций, удовлетворяющих условиям поиска. |
| `limit` | Число | Ограничение на количество станций, которые Яндекс Расписания возвращают в ответ на запрос. Ограничение можно задать в параметре `limit`.<br>Значение по умолчанию — 100. |
| `offset` | Число | Смещение относительно первого результата поиска. Смещение можно задать в параметре `offset`.<br>Значение по умолчанию — 0. |
```
<response>
<pagination>
<total>35</total>
<limit>100</limit>
<offset>0</offset>
</pagination>
<station>
<distance>15.8152773714</distance>
<code>s9600215</code>
<title>Внуково</title>
<type_choices>
<tablo>
<desktop_url>https://rasp.yandex.ru/station/9600215/tablo</desktop_url>
<touch_url>https://t.rasp.yandex.ru/station/9600215/tablo</touch_url>
</tablo>
<aeroex>
<desktop_url>https://rasp.yandex.ru/station/9600215/aeroex</desktop_url>
<touch_url>https://t.rasp.yandex.ru/station/9600215/aeroex</touch_url>
</aeroex>
</type_choices>
<station_type>аэропорт</station_type>
<popular_title></popular_title>
<short_title></short_title>
<majority>2</majority>
<transport_type>plane</transport_type>
<lat>55.605817</lat>
<lng>37.288233</lng>
<type>station</type>
</station>
<station>
...
</station>
...
</response>
```
#### Описание элементов XML
| | | |
| --- | --- | --- |
| **Элемент JSON** | **Тип** | **Описание** |
| `pagination` | Объект | Информация о постраничном выводе найденных станций. |
| `station` | Объект | Информация о найденной станции. |
**Элементы, вложенные в**`stations`
| | | |
| --- | --- | --- |
| **Элемент JSON** | **Тип** | **Описание** |
| `distance` | Число | Расстояние от станции до точки с указанными в запросе координатами. |
| `code` | Строка | Код станции в системе кодирования Яндекс Расписаний. |
| `title` | Строка | Название станции. |
| `type_choices` | Строка | Типы расписаний, доступные для станции. Каждый тип описывается в отдельном объекте, который содержит ссылки на мобильную и десктопную версию расписания.<br>Доступные типы:<br>- `schedule` — вид расписания по умолчанию;<br>- `tablo` — табло аэропорта;<br>- `train` — расписание железнодорожного вокзала;<br>- `suburban` — расписание электричек;<br>- `aeroex` — расписание аэроэкспрессов. |
| `station_type` | Строка | Тип станции. Возможные значения:<br>- `station` — станция;<br>- `platform` — платформа;<br>- `stop` — остановочный пункт;<br>- `checkpoint` — блок-пост;<br>- `post` — пост;<br>- `crossing` — разъезд;<br>- `overtaking_point` — обгонный пункт;<br>- `train_station` — вокзал;<br>- `airport` — аэропорт;<br>- `bus_station` — автовокзал;<br>- `bus_stop` — автобусная остановка;<br>- `unknown` — станция без типа;<br>- `port` — порт;<br>- `port_point` — портпункт;<br>- `wharf` — пристань;<br>- `river_port` — речной вокзал;<br>- `marine_station` — морской вокзал. |
| `station_type_name` | Строка | Название типа станции, зависит от языка ответа. Возможные значения на русском — в списке значений ключа station\_type. |
| `popular_title` | Строка | Общепринятое название станции. |
| `short_title` | Строка | Короткое название станции. |
| `majority` | Строка | Целое число, определяющее относительную важность станции в транспортном сообщении региона, где 1 — высшая важность (например, главный вокзал города). |
| `transport_type` | Строка | Основной тип транспорта для данной станции.<br>Возможные значения:<br>- `plane` — самолет;<br>- `train` — поезд;<br>- `suburban` — электричка;<br>- `bus` — автобус;<br>- `water` — водный транспорт;<br>- `helicopter` — вертолет. |
| `lat` | Число | Широта согласно [WGS84](http://ru.wikipedia.org/wiki/WGS_84). |
| `lng` | Число | Долгота согласно [WGS84](http://ru.wikipedia.org/wiki/WGS_84). |
| `type` | Строка | Вид найденного пункта. Возможные значения:<br>- `station` — станция;<br>- `settlement` — поселение. |
[Ключ доступа](https://yandex.ru/dev/rasp/doc/ru/concepts/access) к API.
Параметр можно не передавать, если ключ доступа указан в заголовке `Authorization`, например:
```
Authorization: 1eb31582-941a-3ac8-a61f-041c344495ab
```
Широта согласно [WGS84](http://ru.wikipedia.org/wiki/WGS_84).
Долгота согласно [WGS84](http://ru.wikipedia.org/wiki/WGS_84).
Радиус, в котором следует искать ближайший город, в километрах.
Язык возвращаемой информации, в формате <код языка>\_<код страны>. Поддерживаемые коды языка описаны стандартом [ISO 639](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2), коды стран — стандартом [ISO 3166](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).
По умолчанию ответ возвращается для значения `ru_RU`.
Поддерживаемые коды языков:
- `ru` — русский;
- `uk` — украинский.
Поддерживаемые коды стран:
- `RU` — Россия;
- `UA` — Украина.
Формат ответа. Поддерживаемые значения:
- `json` (по умолчанию);
- `xml`.
Типы запрашиваемых станций (несколько типов можно перечислить через запятую).
Поддерживаемые значения:
- `station` — станция;
- `platform` — платформа;
- `stop` — остановочный пункт;
- `checkpoint` — блок-пост;
- `post` — пост;
- `crossing` — разъезд;
- `overtaking_point` — обгонный пункт;
- `train_station` — вокзал;
- `airport` — аэропорт;
- `bus_station` — автовокзал;
- `bus_stop` — автобусная остановка;
- `unknown` — станция без типа;
- `port` — порт;
- `port_point` — портпункт;
- `wharf` — пристань;
- `river_port` — речной вокзал;
- `marine_station` — морской вокзал.
Типы транспортного средства, для которых нужно искать станции. Несколько типов одновременно можно указать через запятую, например, plane,train,bus.
Поддерживаемые значения:
- `plane` — самолет;
- `train` — поезд;
- `suburban` — электричка;
- `bus` — автобус;
- `sea` — морской транспорт;
- `river` — речной транспорт;
- `helicopter` — вертолет.
Смещение относительно первого результата поиска. Например, если вам не нужны первые 10 результатов поиска, задайте для параметра значение «10».
Значение по умолчанию — 0.
Максимальное количество результатов поиска в ответе.
Значение по умолчанию — 100.
**Тип**
Строка
**Описание**
Код пункта прибытия в системе кодирования Яндекс Расписаний.
**Тип**
Строка
**Описание**
Вид пункта отправления.
Возможные значения:
- `station` — станция;
- `settlement` — поселение.
**Тип**
Строка
**Описание**
Название пункта отправления.
**Тип**
Строка
**Описание**
Тип отправляющегося транспортного средства.
Возможные значения:
- `plane` — самолет;
- `train` — поезд;
- `suburban` — электричка;
- `bus` — автобус;
- `water` — водный транспорт;
- `helicopter` — вертолет.
**Тип**
Объект
**Описание**
Информация об указанной в запросе станции.
**Тип**
Строка
**Описание**
Название нитки, составленное из коротких названий первой и последней станций следования.
**Тип**
Строка
**Описание**
Общепринятое название станции.
**Тип**
Массив
**Описание**
Информация о постраничном выводе.
**Тип**
Число
**Описание**
Общее количество станций, удовлетворяющих условиям поиска.
**Тип**
Число
**Описание**
Ограничение на количество станций, которые Яндекс Расписания возвращают в ответ на запрос. Ограничение можно задать в параметре `limit`.
Значение по умолчанию — 100.
**Тип**
Число
**Описание**
Смещение относительно первого результата поиска. Смещение можно задать в параметре `offset`.
Значение по умолчанию — 0.
**Тип**
Число
**Описание**
Расстояние от указанной в запросе точки до полученной в ответе станции.
**Тип**
Объект
**Описание**
Типы расписаний, доступные для станции. Каждый тип описывается в отдельном объекте, который содержит ссылки на мобильную и десктопную версию расписания.
Доступные типы:
- `schedule` — вид расписания по умолчанию;
- `tablo` — табло аэропорта;
- `train` — расписание железнодорожного вокзала;
- `suburban` — расписание электричек;
- `aeroex` — расписание аэроэкспрессов.
**Тип**
Строка
**Описание**
Тип станции. Возможные значения:
- `station` — станция;
- `platform` — платформа;
- `stop` — остановочный пункт;
- `checkpoint` — блок-пост;
- `post` — пост;
- `crossing` — разъезд;
- `overtaking_point` — обгонный пункт;
- `train_station` — вокзал;
- `airport` — аэропорт;
- `bus_station` — автовокзал;
- `bus_stop` — автобусная остановка;
- `unknown` — станция без типа;
- `port` — порт;
- `port_point` — портпункт;
- `wharf` — пристань;
- `river_port` — речной вокзал;
- `marine_station` — морской вокзал.
**Тип**
Строка
**Описание**
Целое число, определяющее относительную важность станции в транспортном сообщении региона, где 1 — высшая важность (например, главный вокзал города).
**Тип**
Число
**Описание**
Широта согласно [WGS84](http://ru.wikipedia.org/wiki/WGS_84).
**Тип**
Число
**Описание**
Долгота согласно [WGS84](http://ru.wikipedia.org/wiki/WGS_84).

905
docs/yandex-api-docs/schedule-on-station.md Normal file
View File

@@ -0,0 +1,905 @@
Расписание рейсов по станции
# Расписание рейсов по станции
- [Синтаксис запроса](https://yandex.ru/dev/rasp/doc/ru/reference/schedule-on-station#format)
- [Структура ответа](https://yandex.ru/dev/rasp/doc/ru/reference/schedule-on-station#emails-detailed)
Запрос позволяет получить список [рейсов](https://yandex.ru/dev/rasp/doc/ru/concepts/termin#schedule), отправляющихся от указанной [станции](https://yandex.ru/dev/rasp/doc/ru/concepts/termin#station) и информацию по каждому рейсу.
## Синтаксис запроса
```
https://api.rasp.yandex-net.ru/v3.0/schedule/ ?
apikey=<ключ>
& station=<код станции>
& [lang=<язык>]
& [format=<формат>]
& [date=<дата>]
& [transport_types=<тип транспорта>]
& [event=<прибытие или отправление>]
& [system=<система кодирования для параметра station>]
& [show_systems=<коды в ответе>]
& [direction=<направление>]
& [result_timezone=<часовой пояс>]
```
Пример запроса:
```
https://api.rasp.yandex-net.ru/v3.0/schedule/?apikey={ключ}&station=s9600213&transport_types=suburban&direction=на%20Москву
```
Входные параметры:
**Обязательные параметры**
| | |
| --- | --- |
| **Параметр** | **Описание** |
| `apikey` | [Ключ доступа](https://yandex.ru/dev/rasp/doc/ru/concepts/access) к API.<br>Параметр можно не передавать, если ключ доступа указан в заголовке `Authorization`, например:<br>```<br>Authorization: 1eb31582-941a-3ac8-a61f-041c344495ab<br>``` |
| `station` | Код станции. Должен быть указан в [системе кодирования](https://yandex.ru/dev/rasp/doc/ru/concepts/coding-system). |
**Необязательные параметры**
| | |
| --- | --- |
| **Параметр** | **Описание** |
| `lang` | Язык возвращаемой информации, в формате <код языка>\_<код страны>. Поддерживаемые коды языка описаны стандартом [ISO 639](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2), коды стран — стандартом [ISO 3166](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).<br>По умолчанию ответ возвращается для значения `ru_RU`.<br>Поддерживаемые коды языков:<br>- `ru` — русский;<br>- `uk` — украинский.<br>Поддерживаемые коды стран:<br>- `RU` — Россия;<br>- `UA` — Украина. |
| `format` | Формат ответа. Поддерживаемые значения:<br>- `json` (по умолчанию);<br>- `xml`. |
| `date` | Дата, на которую необходимо получить список рейсов. Должна быть указана в формате, соответствующем стандарту [ISO 8601](https://ru.wikipedia.org/wiki/ISO_8601). Например, YYYY-MM-DD.<br>Если в запросе указана конкретная дата, в выдаче будут показаны все будущие рейсы, в том числе с пересадками.<br>Если запрос передан без даты, в выдаче будут показаны только прямые рейсы на все даты. В этом случае рейсы с пересадками не попадут в выдачу. |
| `transport_types` | Тип транспортного средства. Возможные значения:<br>- `plane` — самолет;<br>- `train` — поезд;<br>- `suburban` — электричка;<br>- `bus` — автобус;<br>- `water` — морской транспорт;<br>- `helicopter` — вертолет.<br>По умолчанию возвращается список рейсов по всем типам транспортных средств. |
| `direction` | Код направления, по которому необходимо получить список рейсов электричек по станции (например, «arrival», «all» или «на Москву»).<br>Параметр `direction` игнорируется, если значение параметра `transport_types` отлично от `suburban`.<br>Доступные для станции коды направлений можно получить, запросив расписание на любую дату без параметра `direction`, но с параметром `transport_types=suburban`. Список направлений возвращается в элементе ответа `directions`. |
| `event` | Событие, для которого нужно отфильтровать нитки в расписании.<br>Поддерживаемые значения:<br>- `departure` — включить в ответ только отправляющиеся со станции нитки (по умолчанию);<br>- `arrival` — включить в ответ только прибывающие на станцию нитки. |
| `system` | [Система кодирования](https://yandex.ru/dev/rasp/doc/ru/concepts/coding-system), в которой указывается код станции (параметр `station`) в запросе. Возможные значения:<br>- `yandex` (значение по умолчанию) — система кодирования Яндекс Расписаний;<br>- `iata` — [коды Международной ассоциации воздушного транспорта](https://ru.wikipedia.org/wiki/%D0%9A%D0%BE%D0%B4_%D0%98%D0%90%D0%A2%D0%90);<br>- `sirena` — коды в системах, построенных на базе [сетей «Сирена»](http://ru.wikipedia.org/wiki/%D0%A1%D0%B8%D1%80%D0%B5%D0%BD%D0%B0_(%D1%81%D0%B5%D1%82%D1%8C));<br>- `express` — коды железнодорожных станций СНГ и стран Балтии из базы [Экспресс-3](http://www.express-3.ru/);<br>- `esr` — коды железнодорожных станций СНГ и стран Балтии из базы [ЕСР](https://ru.wikipedia.org/wiki/%D0%95%D0%B4%D0%B8%D0%BD%D0%B0%D1%8F_%D1%81%D0%B5%D1%82%D0%B5%D0%B2%D0%B0%D1%8F_%D1%80%D0%B0%D0%B7%D0%BC%D0%B5%D1%82%D0%BA%D0%B0).<br>Параметр обязателен, если используется система кодирования, отличная от системы кодирования Яндекс Расписаний. |
| `show_systems` | Система кодирования, в которой необходимо получить коды станций (в элементе ответа `codes`, вложенном в элемент `station`).<br>Возможные значения:<br>- `yandex` — система кодирования Яндекс Расписаний;<br>- `esr` — коды железнодорожных станций СНГ и стран Балтии из базы [ЕСР](https://ru.wikipedia.org/wiki/%D0%95%D0%B4%D0%B8%D0%BD%D0%B0%D1%8F_%D1%81%D0%B5%D1%82%D0%B5%D0%B2%D0%B0%D1%8F_%D1%80%D0%B0%D0%B7%D0%BC%D0%B5%D1%82%D0%BA%D0%B0);<br>- `all` — коды всех поддерживаемых систем кодирования.<br>По умолчанию элемент `station` не содержит элемента `codes`. |
| `result_timezone` | Часовой пояс, для которого следует указывать даты и времена в ответе. Если параметр не передан, каждая дата и время в ответе будут указаны в часовом поясе соответствующей станции.<br>Часовые пояса следует указывать с помощью идентификаторов [базы данных tz](https://ru.wikipedia.org/wiki/Tz_database). В английской Википедии приведен список идентификаторов из последней версии этой базы данных (в столбце «TZ» таблицы). |
## Структура ответа
Ответ представляет собой список рейсов с подробным описанием каждого рейса.
Количество рейсов, отображаемых на одной странице — не более 100\. Информация об общем количестве полученных рейсов указана в ответе в элементе `total` элемента `pagination`.
Возможные форматы ответа: JSON, XML.
Структура ответа в различных форматах показана в примерах.
Пример ответа в формате JSON
Пример ответа в формате XML
```
{
"date": "2017-10-28",
"pagination":
{
"total": 210,
"limit": 100,
"offset": 0
},
"station":
{ /* hide:station */
"code": "s9600213",
"title": "Шереметьево",
"station_type": "аэропорт",
"popular_title": "",
"short_title": "",
"transport_type": "train",
"type": "station"
},
"schedule":
[\
{\
"except_days": "6, 7, 8, 9, 13, 14 февраля",\
"arrival": "2017-02-27T00:04:00+03:00",\
"thread":\
{ /* hide:thread */\
"uid":"7303A_9600213_g13_af",\
"title":"аэропорт Шереметьево - Москва (Белорусский вокзал)",\
"number":"7303",\
"short_title":"а/п Шереметьево - Москва (Белорусский вокзал)",\
"carrier":\
{ /* hide:carrier */\
"code": 153,\
"codes": {\
"icao": null,\
"sirena": null,\
"iata": null\
},\
"title": "Центральная пригородная пассажирская компания"\
},\
"transport_type":"suburban",\
"vehicle":null,\
"transport_subtype":\
{ /* hide:transport_subtype */\
"color": "#FF7F44",\
"code": "suburban",\
"title": "Пригородный поезд"\
},\
"express_type":"aeroexpress"\
},\
"is_fuzzy":false,\
"days":"ежедневно",\
"stops":"без остановок",\
"departure": "2017-02-27T00:05:00+03:00",\
"terminal": null,\
"platform": ""\
},\
...\
],
"interval_schedule":
[\
{\
"except_days": null,\
"thread":\
{\
"uid": "502-*28mxt*29_0_f9744758t9744460_r2531_1",\
"title": "Москва (м. Медведково) — Пироговский (Посёлок Пироговский)",\
"interval":\
{\
"density": "маршрутное такси раз в 15-30 минут",\
"end_time": "2017-07-10T21:30:00",\
"begin_time": "2017-07-10T06:00:00"\
},\
"number": "502 (м/т)",\
"short_title": "Москва (м. Медведково) — Пироговский (Посёлок Пироговский)",\
"carrier": null,\
"transport_type": "bus",\
"vehicle": null,\
"transport_subtype":\
{\
"color": "#ff0000",\
"code": "bus",\
"title": "Автобус"\
},\
"express_type": null\
},\
"is_fuzzy": false,\
"days": "ежедневно",\
"stops": "",\
"terminal": null,\
"platform": ""\
},\
...\
],
"schedule_direction":
{
"code": "на Москву",
"title": "на Москву"
},
"directions":
[\
{\
"code": "arrival",\
"title": "прибытие"\
},\
{\
"code": "на Москву",\
"title": "на Москву"\
},\
{\
"code": "all",\
"title": "все направления"\
}\
]
}
```
#### Описание элементов JSON
| | | |
| --- | --- | --- |
| **Элемент JSON** | **Тип** | **Описание** |
| `date` | Строка | Дата, на которую получен список рейсов.<br>Принимает значение `null`, если в запросе не указан параметр `date`. |
| `pagination` | Объект | Информация о постраничном выводе найденных рейсов. |
| `station` | Объект | Информация об указанной в запросе станции. |
| `schedule` | Массив | Список рейсов. |
| `schedule_direction` | Объект | Код и название запрошенного направления рейсов.<br>Элемент включается в ответ, если в запросе указан параметр `direction`. |
| `directions` | Объект | Коды и названия возможных направлений движения электричек по станции.<br>Элемент включается в ответ, если в запросе указан параметр `transport_types` со значением `suburban`. |
**Элементы объекта**`pagination`
| | | |
| --- | --- | --- |
| **Элемент JSON** | **Тип** | **Описание** |
| `total` | Число | Общее количество рейсов, удовлетворяющих условиям поиска. |
| `limit` | Число | Ограничение на количество рейсов, которые Яндекс Расписания возвращают в ответ на запрос (заданное в параметре `limit`).<br>Значение по умолчанию — 100. |
| `offset` | Число | Смещение относительно первого результата поиска, заданное в параметре `offset`.<br>Значение по умолчанию — 0. |
**Элементыобъекта**`station`
| | | |
| --- | --- | --- |
| **Элемент JSON** | **Тип** | **Описание** |
| `code` | Строка | Код станции в системе кодирования Яндекс Расписаний. |
| `station_type` | Строка | Тип станции.<br>Возможные значения:<br>- `station` — станция;<br>- `platform` — платформа;<br>- `stop` — остановочный пункт;<br>- `checkpoint` — блок-пост;<br>- `post` — пост;<br>- `crossing` — разъезд;<br>- `overtaking_point` — обгонный пункт;<br>- `train_station` — вокзал;<br>- `airport` — аэропорт;<br>- `bus_station` — автовокзал;<br>- `bus_stop` — автобусная остановка;<br>- `unknown` — станция без типа;<br>- `port` — порт;<br>- `port_point` — портпункт;<br>- `wharf` — пристань;<br>- `river_port` — речной вокзал;<br>- `marine_station` — морской вокзал. |
| `station_type_name` | Строка | Название типа станции, зависит от языка ответа. Возможные значения на русском — в списке значений ключа `station_type`. |
| `title` | Строка | Название станции. |
| `popular_title` | Строка | Общепринятое название станции. |
| `short_title` | Строка | Короткое название станции. |
| `codes` | Объект | Список кодов станции в системах кодирования, заданных параметром `show_systems`. |
| `transport_type` | Строка | Тип транспорта, обслуживаемый станцией.<br>Возможные значения:<br>- `plane` — самолет;<br>- `train` — поезд;<br>- `suburban` — электричка;<br>- `bus` — автобус;<br>- `water` — водный транспорт;<br>- `helicopter` — вертолет. |
| `type` | Строка | Вид станции. Для запроса расписания по станции возможно только одно значение — `station`. |
**Элементыобъекта**`schedule`
| | | |
| --- | --- | --- |
| **Элемент JSON** | **Тип** | **Описание** |
| `except_days` | Строка | Дни, в которые нитка не курсирует (даже если они входят в множество, описанное элементом days). |
| `arrival` | Строка | Время прибытия, в формате ISO 8601 (YYYY-MM-DDThh:mm:ss±hh:mm).<br>Если параметр `result_timezone` не был передан, указывается в часовом поясе станции. |
| `thread` | Объект | Информация о нитке. |
| `is_fuzzy` | Булевый | Признак неточности времени отправления и времени прибытия. Возможные значения:<br>- `true` — время прибытия и время отправления указаны неточно;<br>- `false` — время прибытия и время отправления указан точно. |
| `days` | Строка | Дни курсирования нитки. |
| `stops` | Строка (не более 1000 символов) | Станции следования рейса, на которых совершается остановка. Описывается в свободной форме. Например, значение `везде` значит, что остановка совершается на всех станциях следования.<br>Пустая строка значит, что нитка нигде не останавливается между начальной и конечной станциями. |
| `departure` | Строка | Время отправления, в формате ISO 8601 (YYYY-MM-DDThh:mm:ss±hh:mm).<br>Если параметр `result_timezone` не был передан, указывается в часовом поясе станции. |
| `terminal` | Строка | Терминал аэропорта (например, «D»).<br>Принимает значение `null`, если информации о терминале нет. |
| `platform` | Строка | Платформа или путь, с которого отправляется рейс (например, «3 путь»).<br>Пустая строка значит, что информации о платформе или пути нет. |
**Элементыобъекта**`codes`
| | | |
| --- | --- | --- |
| **Элемент JSON** | **Тип** | **Описание** |
| `yandex` | Строка | Код станции в системе кодирования Яндекс Расписаний. |
| `esr` | Строка | Код станции в системе кодирования [ЕСР](https://ru.wikipedia.org/wiki/%D0%95%D0%B4%D0%B8%D0%BD%D0%B0%D1%8F_%D1%81%D0%B5%D1%82%D0%B5%D0%B2%D0%B0%D1%8F_%D1%80%D0%B0%D0%B7%D0%BC%D0%B5%D1%82%D0%BA%D0%B0). |
**Элементыобъекта**`schedule_direction`
| | | |
| --- | --- | --- |
| **Элемент JSON** | **Тип** | **Описание** |
| `code` | Строка | Код направления.<br>Может принимать значения:<br>- `arrival` — код направления с названием «прибытие», для рейсов электричек, прибывающих на станцию.<br>- `на Москву` (`на Шалю` и т. д.) — код направления с названием, для электричек курсирующих по такому направлению.<br>- `all` — код направления с названием «все направления», для рейсов, отправляющихся по всем возможным направлениям. |
| `title` | Строка | Название направления.<br>Возможные значения: «прибытие», «все направления», «на Москву», «на Шалю» и т. д. |
**Элементыобъекта**`thread`
| | | |
| --- | --- | --- |
| **Элемент JSON** | **Тип** | **Описание** |
| `uid` | Строка (не более 100 символов) | Идентификатор нитки, принятый в Яндекс Расписаниях. |
| `title` | Строка | Название нитки. Составляется из полных названий первой и последней станций следования. |
| `number` | Строка | Номер рейса. |
| `short_title` | Строка | Короткое название нитки. Составляется из коротких названий первой и последней станций следования. |
| `carrier` | Объект | Информация о перевозчике. |
| `transport_type` | Строка | Тип транспортного средства. Возможные значения:<br>- `plane` — самолет;<br>- `train` — поезд;<br>- `suburban` — электричка;<br>- `bus` — автобус;<br>- `water` — морской транспорт;<br>- `helicopter` — вертолет.<br>По умолчанию возвращается список рейсов по всем типам транспортных средств. |
| `vehicle` | Строка | Название транспортного средства. |
| `transport_subtype` | Строка | Информация о подтипе транспортного средства. |
| `express_type` | Строка | Признак экспресса или аэроэкспресса. Значение по умолчанию — `null`.<br>Если тип транспорта — электричка (ключ transport\_type возвращен со значением suburban), принимает одно из значений:<br>- `express` — экспресс-рейс;<br>- `aeroexpress` — рейс, курсирующий между городом и аэропортом. |
**Элементыобъекта**`codes`
| | | |
| --- | --- | --- |
| **Элемент JSON** | **Тип** | **Описание** |
| `icao` | Строка | Код перевозчика в системе кодирования [ICAO](https://ru.wikipedia.org/wiki/%D0%9C%D0%B5%D0%B6%D0%B4%D1%83%D0%BD%D0%B0%D1%80%D0%BE%D0%B4%D0%BD%D0%B0%D1%8F_%D0%BE%D1%80%D0%B3%D0%B0%D0%BD%D0%B8%D0%B7%D0%B0%D1%86%D0%B8%D1%8F_%D0%B3%D1%80%D0%B0%D0%B6%D0%B4%D0%B0%D0%BD%D1%81%D0%BA%D0%BE%D0%B9_%D0%B0%D0%B2%D0%B8%D0%B0%D1%86%D0%B8%D0%B8). |
| `sirena` | Строка | Код перевозчика в системе кодирования [Sirena](http://ru.wikipedia.org/wiki/%D0%A1%D0%B8%D1%80%D0%B5%D0%BD%D0%B0_(%D1%81%D0%B5%D1%82%D1%8C)). |
| `iata` | Строка | Код перевозчика в системе кодирования [IATA](https://ru.wikipedia.org/wiki/%D0%9C%D0%B5%D0%B6%D0%B4%D1%83%D0%BD%D0%B0%D1%80%D0%BE%D0%B4%D0%BD%D0%B0%D1%8F_%D0%B0%D1%81%D1%81%D0%BE%D1%86%D0%B8%D0%B0%D1%86%D0%B8%D1%8F_%D0%B2%D0%BE%D0%B7%D0%B4%D1%83%D1%88%D0%BD%D0%BE%D0%B3%D0%BE_%D1%82%D1%80%D0%B0%D0%BD%D1%81%D0%BF%D0%BE%D1%80%D1%82%D0%B0). |
**Элементыобъекта**`transport_subtype`
| | | |
| --- | --- | --- |
| **Элемент JSON** | **Тип** | **Описание** |
| `color` | Строка | Основной цвет транспортного средства в шестнадцатеричном формате. |
| `code` | Строка | Код подтипа транспорта для типа, указанного в элементе `transport_type`. Подтип может совпадать с типом (например, для обычной электрички указывается тип `suburban` и подтип `suburban`).<br>Другие возможные значения:<br>- `helicopter` — вертолет (для типа `plane`);<br>- `rex` — экспресс РЭКС (для типа `suburban`);<br>- `sputnik` — «Спутник» (для типа `suburban`);<br>- `skiarrow` — «Лыжная стрела» (для типа `suburban`);<br>- `shezh` — «Снежинка» (для типа `suburban`);<br>- `skirus` — «Лыжня России» (для типа `suburban`);<br>- `city` — городская электричка (для типа `suburban`);<br>- `kalina` — «Калина красная» (для типа `suburban`);<br>- `vostok` — «Восток» (для типа `suburban`);<br>- `prostoryaltaya` — «Просторы Алтая» (для типа `suburban`);<br>- `14vag` — состав из 14 вагонов (для типа `suburban`);<br>- `last` — «Ласточка» (для типа `suburban`);<br>- `exprdal` — экспресс с билетами на конкретные места (для типа `suburban`);<br>- `volzhex` — «Волжский экспресс» (для типа `suburban`);<br>- `stdplus` — электрички типа «стандарт плюс» (для типа `suburban`);<br>- `express` — экспресс (для типа `suburban`);<br>- `skor` — ускоренный поезд (для типа `suburban`);<br>- `fiztekh` — Физтех.Электричка (для типа `suburban`);<br>- `vag6` — состав из 6 вагонов (для типа `suburban`);<br>- `river—` речной транспорт (для типа `water`);<br>- `sea` — морской транспорт (для типа `water`). |
| `title` | Строка | Описание подтипа транспорта на естественном языке. |
**Элементыобъекта**`carrier`
| | | |
| --- | --- | --- |
| **Элемент JSON** | **Тип** | **Описание** |
| `code` | Число | Код перевозчика в системе кодирования Яндекс Расписаний. |
| `codes` | Объект | Список кодов перевозчика в других системах кодирования, поддерживаемых Яндекс Расписаниями. |
| `title` | Строка | Название перевозчика. |
**Элементыобъекта**`directions`
| | | |
| --- | --- | --- |
| **Элемент JSON** | **Тип** | **Описание** |
| `code` | Строка | Код направления. Может указываться в свободной форме, или одним из следующих идентификаторов:<br>- `all` — все направления для указанной станции;<br>- `arrival` — только прибывающие направления;<br>- `departure` — только отправляющиеся направления. |
| `title` | Строка | Название направления (расшифровка кода) в свободной форме. Если значение элемента `code` не является одним из идентификаторов, то название и код направления обычно совпадают (например, «на Москву»). |
```
<response>
<pagination>
<total>162</total>
<limit>100</per_page>
<offset>0</page_count>
</pagination>
<schedule>
<except_days>xsi:nil="true"</except_days>
<arrival>2017-02-27T00:04:00+03:00</arrival>
<thread>
<carrier>
<code>153</code>
<codes>
<icao>xsi:nil="true"</icao>
<sirena>xsi:nil="true"</sirena>
<iata>xsi:nil="true"</iata>
</codes>
<title>Центральная пригородная пассажирская компания</title>
</carrier>
<transport_type>suburban</transport_type>
<uid>6038A_9607404_g13_af</uid>
<title{thread}>Екатеринбург-Пасс. - аэропорт Кольцово</title>
<transport_subtype>
<color>#FF7F44</color>
<code>suburban</code>
<title>Пригородный поезд</title>
</transport_subtype>
<vehicle>xsi:nil="true"</vehicle>
<number>6038</number>
<short_title{thread}>Екатеринбург-Пасс. - а/п Кольцово</short_title>
<express_type/>
</thread>
<platform></platform>
<days>ежедневно</days>
<stops>везде</stops>
<departure>2017-02-27T00:05:00+03:00</departure>
<terminal>xsi:nil="true"</terminal>
<is_fuzzy>false</is_fuzzy>
</schedule>
<schedule_direction>
<code>all</code>
<title>все направления</title>
</schedule_direction>
<direction>
<code>arrival</code>
<title>прибытие</title>
</direction>
<direction>
<code>на Москву</code>
<title>на Москву</title>
</direction>
<direction>
<code>на Можайск</code>
<title>на Можайск</title>
</direction>
<direction>
<code>all</code>
<title>все направления</title>
</direction>
<station>
<codes>
<yandex>s9601728</yandex>
<esr>181704</esr>
</codes>
<title{station}>Кольцово</title>
<station_type>аэропорт</station_type>
<popular_title{station}/>
<short_title{station}/>
<code{station}>s9600370</code>
<transport_type>plane</transport_type>
<type>station</type>
</station>
<date>2017-09-03</date>
</response>
```
#### Описание элементов XML
| | | |
| --- | --- | --- |
| **Элемент XML** | **Тип** | **Описание** |
| `pagination` | | Информация о постраничном выводе найденных рейсов. |
| `schedule` | | Один из найденных рейсов. |
| `schedule_direction` | | Код и название запрошенного направления рейсов.<br>Элемент включается в ответ, если в запросе указан параметр `direction`. |
| `direction` | | Одно из направлений, на котором лежит станция. |
| `station` | | Информация об указанной в запросе станции. |
| `date` | Строка | Дата, на которую получен список рейсов. |
**Элементы, вложенные в**`station`
| | | |
| --- | --- | --- |
| **Элемент XML** | **Тип** | **Описание** |
| `codes` | | Список кодов станции в других системах кодирования, поддерживаемых Яндекс Расписаниями. |
| `title` | Строка | Название станции. |
| `popular_title` | Строка | Общепринятое название станции. |
| `short_title` | Строка | Короткое название станции. |
| `code` | Строка | Код станции в системе кодирования Яндекс Расписаний. |
| `type` | Строка | Вид станции. Для запроса расписания по станции возможно только одно значение — `station`. |
| `station_type` | Строка | Тип станции.<br>Возможные значения:<br>- `station` — станция;<br>- `platform` — платформа;<br>- `stop` — остановочный пункт;<br>- `checkpoint` — блок-пост;<br>- `post` — пост;<br>- `crossing` — разъезд;<br>- `overtaking_point` — обгонный пункт;<br>- `train_station` — вокзал;<br>- `airport` — аэропорт;<br>- `bus_station` — автовокзал;<br>- `bus_stop` — автобусная остановка;<br>- `unknown` — станция без типа;<br>- `port` — порт;<br>- `port_point` — портпункт;<br>- `wharf` — пристань;<br>- `river_port` — речной вокзал;<br>- `marine_station` — морской вокзал. |
| `station_type_name` | Строка | Название типа станции, зависит от языка ответа. Возможные значения на русском — в списке значений ключа `station_type`. |
**Элементы, вложенные в**`codes`
| | | |
| --- | --- | --- |
| **Элемент XML** | **Тип** | **Описание** |
| `express` | Строка | Код станции в системе кодирования [Экспресс-3](http://www.express-3.ru/). |
| `yandex` | Строка | Код станции в системе кодирования Яндекс Расписаний. |
| `esr` | Строка | Код станции в системе кодирования [ЕСР](https://ru.wikipedia.org/wiki/%D0%95%D0%B4%D0%B8%D0%BD%D0%B0%D1%8F_%D1%81%D0%B5%D1%82%D0%B5%D0%B2%D0%B0%D1%8F_%D1%80%D0%B0%D0%B7%D0%BC%D0%B5%D1%82%D0%BA%D0%B0). |
**Элементы, вложенные в**`schedule`
| | | |
| --- | --- | --- |
| **Элемент XML** | **Тип** | **Описание** |
| `days` | Строка | Дни курсирования нитки. |
| `stops` | Строка (не более 1000 символов) | Станции следования рейса, на которых совершается остановка. Описывается в свободной форме. Например, значение `везде` означает, что остановка совершается на всех станциях следования.<br>Пустой элемент означает, что станций следования, на которых совершается остановка, нет. |
| `thread` | | Элемент, содержащий информацию о нитке. |
| `arrival` | Строка | Время прибытия, в формате ISO 8601 (YYYY-MM-DDThh:mm:ss±hh:mm).<br>Если параметр `result_timezone` не был передан, указывается в часовом поясе станции. |
| `is_fuzzy` | Булевый | Признак неточности времени отправления и времени прибытия. Возможные значения:<br>- `true` — время прибытия и время отправления указаны неточно;<br>- `false` — время прибытия и время отправления указан точно. |
| `platform` | Строка | Платформа или путь, с которого отправляется рейс (например, «3 путь»).<br>Пустая строка значит, что информации о платформе или пути нет. |
| `terminal` | Строка | Терминал аэропорта (например, «D»).<br>Принимает значение `null`, если информации о терминале нет. |
| `departure` | Строка | Время отправления, в формате ISO 8601 (YYYY-MM-DDThh:mm:ss±hh:mm).<br>Если параметр `result_timezone` не был передан, указывается в часовом поясе станции. |
| `direction` | Строка (не более 100 символов) | Направление, в котором рейс отправляется от станции согласно расписанию нитки.<br>Принимает значение `прибытие`, если станция — конечная для данной нитки. |
| `except_days` | Строка | Дни, в которые нитка не курсирует (даже если они входят в множество, описанное элементом days). |
**Элементы, вложенные в**`thread`
| | | |
| --- | --- | --- |
| **Элемент XML** | **Тип** | **Описание** |
| `carrier` | | Элемент, содержащий информацию о перевозчике. |
| `transport_type` | Строка | Тип транспорта, обслуживаемый станцией.<br>Возможные значения:<br>- `plane` — самолет;<br>- `train` — поезд;<br>- `suburban` — электричка;<br>- `bus` — автобус;<br>- `water` — водный транспорт;<br>- `helicopter` — вертолет. |
| `uid` | Строка (не более 100 символов) | Идентификатор нитки, принятый в Яндекс Расписаниях. |
| `title` | Строка | Название нитки. |
| `vehicle` | Строка | Название транспортного средства. |
| `number` | Строка | Номер рейса. |
| `short_title` | Строка | Название нитки, состоящее из коротких названий станций первой и последней станций следования. |
| `express_type` | Строка | Признак экспресса или аэроэкспресса. Значение по умолчанию — `null`.<br>Если тип транспорта — электричка (ключ `transport_type` возвращен со значением `suburban`), принимает одно из значений:<br>- `express` — экспресс-рейс;<br>- `aeroexpress` — рейс, курсирующий между городом и аэропортом. |
**Элементы, вложенные в**`carrier`
| | | |
| --- | --- | --- |
| **Элемент XML** | **Тип** | **Описание** |
| `code` | Число | Код перевозчика в системе кодирования Яндекс Расписаний. |
| `codes` | | Элемент, содержащий список кодов перевозчика в других системах кодирования, поддерживаемый Яндекс Расписаниями. |
| `title` | Строка | Название перевозчика. |
**Элементы, вложенные в**`codes`
| | | |
| --- | --- | --- |
| **Элемент XML** | **Тип** | **Описание** |
| `icao` | Строка | Код перевозчика в системе кодирования [ICAO](https://ru.wikipedia.org/wiki/%D0%9C%D0%B5%D0%B6%D0%B4%D1%83%D0%BD%D0%B0%D1%80%D0%BE%D0%B4%D0%BD%D0%B0%D1%8F_%D0%BE%D1%80%D0%B3%D0%B0%D0%BD%D0%B8%D0%B7%D0%B0%D1%86%D0%B8%D1%8F_%D0%B3%D1%80%D0%B0%D0%B6%D0%B4%D0%B0%D0%BD%D1%81%D0%BA%D0%BE%D0%B9_%D0%B0%D0%B2%D0%B8%D0%B0%D1%86%D0%B8%D0%B8). |
| `sirena` | Строка | Код перевозчика в системе кодирования [Sirena](http://ru.wikipedia.org/wiki/%D0%A1%D0%B8%D1%80%D0%B5%D0%BD%D0%B0_(%D1%81%D0%B5%D1%82%D1%8C)). |
| `iata` | Строка | Код перевозчика в системе кодирования [IATA](https://ru.wikipedia.org/wiki/%D0%9C%D0%B5%D0%B6%D0%B4%D1%83%D0%BD%D0%B0%D1%80%D0%BE%D0%B4%D0%BD%D0%B0%D1%8F_%D0%B0%D1%81%D1%81%D0%BE%D1%86%D0%B8%D0%B0%D1%86%D0%B8%D1%8F_%D0%B2%D0%BE%D0%B7%D0%B4%D1%83%D1%88%D0%BD%D0%BE%D0%B3%D0%BE_%D1%82%D1%80%D0%B0%D0%BD%D1%81%D0%BF%D0%BE%D1%80%D1%82%D0%B0). |
**Элементы, вложенные в**`direction`
| | | |
| --- | --- | --- |
| **Элемент XML** | **Тип** | **Описание** |
| `code` | Строка | Код направления.<br>Может принимать значения:<br>- `arrival` — код направления с названием «прибытие».<br> <br> Рейсы электричек, прибывающих на станцию.<br> <br>- `на Москву` (`на Шалю` и т. д.) — код направления с названием «на Москву», «на Шалю» и т. д.<br> <br> Рейсы электричек, отправляющихся по направлению с названием «на Москву» («на Шалю» и т. д.).<br> <br>- `all` — код направления с названием «все направления».<br> <br> Рейсы электричек, отправляющихся по всем возможным направлениям. |
| `title` | Строка | Название направления.<br>Возможные значения: «прибытие», «все направления», «на Москву», «на Шалю» и т. д. |
**Элементы, вложенные в**`directions`
| | | |
| --- | --- | --- |
| **Элемент XML** | **Тип** | **Описание** |
| `code` | Строка | Код направления.<br>Возможные значения:<br>- `arrival` — код направления «прибытие».<br> <br> Необходимо использовать в качестве значения входного параметра [`direction`](https://yandex.ru/dev/rasp/doc/ru/reference/schedule-on-station#format/query-schedule-param-direction) в запросе для выдачи рейсов электричек, прибывающих на станцию.<br> <br>- `на Москву` (`на Шалю` и т. д.) — код направления «на Москву», «на Шалю» и т. д.<br> <br> Необходимо использовать в качестве значения входного параметра [`direction`](https://yandex.ru/dev/rasp/doc/ru/reference/schedule-on-station#format/query-schedule-param-direction) в запросе для выдачи рейсов электричек, отправляющихся по направлению «на Москву» («на Шалю» и т. д.).<br> <br>- `all` — код направления «все направления».<br> <br> Необходимо использовать в качестве значения входного параметра [`direction`](https://yandex.ru/dev/rasp/doc/ru/reference/schedule-on-station#format/query-schedule-param-direction) в запросе для выдачи рейсов электричек, отправляющихся по всем возможным для станции направлениям. |
| `title` | Строка | Название направления в свободной форме.<br>Возможные значения: «прибытие», «все направления», «на Москву», «на Шалю» и т. д. |
[Ключ доступа](https://yandex.ru/dev/rasp/doc/ru/concepts/access) к API.
Параметр можно не передавать, если ключ доступа указан в заголовке `Authorization`, например:
```
Authorization: 1eb31582-941a-3ac8-a61f-041c344495ab
```
Код станции. Должен быть указан в [системе кодирования](https://yandex.ru/dev/rasp/doc/ru/concepts/coding-system).
Язык возвращаемой информации, в формате <код языка>\_<код страны>. Поддерживаемые коды языка описаны стандартом [ISO 639](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes), коды стран — стандартом [ISO 3166](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).
По умолчанию ответ возвращается для значения `ru_RU`.
Поддерживаемые коды языков:
- `ru` — русский;
- `uk` — украинский.
Поддерживаемые коды стран:
- `RU` — Россия;
- `UA` — Украина.
Формат ответа. Поддерживаемые значения:
- `json` (по умолчанию);
- `xml`.
Дата, на которую необходимо получить список рейсов. Должна быть указана в формате, соответствующем стандарту [ISO 8601](https://ru.wikipedia.org/wiki/ISO_8601). Например, YYYY-MM-DD.
Если в запросе указана конкретная дата, в выдаче будут показаны все будущие рейсы, в том числе с пересадками.
Если запрос передан без даты, в выдаче будут показаны только прямые рейсы на все даты. В этом случае рейсы с пересадками не попадут в выдачу.
Тип транспортного средства. Возможные значения:
- `plane` — самолет;
- `train` — поезд;
- `suburban` — электричка;
- `bus` — автобус;
- `water` — морской транспорт;
- `helicopter` — вертолет.
По умолчанию возвращается список рейсов по всем типам транспортных средств.
Событие, для которого нужно отфильтровать нитки в расписании.
Поддерживаемые значения:
- `departure` — включить в ответ только отправляющиеся со станции нитки (по умолчанию);
- `arrival` — включить в ответ только прибывающие на станцию нитки. \|\|
[Система кодирования](https://yandex.ru/dev/rasp/doc/ru/concepts/coding-system), в которой указывается код станции отправления и код станции прибытия (параметры `from`, `to`) в запросе. Возможные значения:
- `yandex` (значение по умолчанию) — система кодирования Яндекс Расписаний;
- `iata` — [коды Международной ассоциации воздушного транспорта](https://ru.wikipedia.org/wiki/%D0%9A%D0%BE%D0%B4_%D0%98%D0%90%D0%A2%D0%90);
- `sirena` — коды в системах, построенных на базе [сетей «Сирена»](http://ru.wikipedia.org/wiki/%D0%A1%D0%B8%D1%80%D0%B5%D0%BD%D0%B0_(%D1%81%D0%B5%D1%82%D1%8C));
- `express` — коды железнодорожных станций СНГ и стран Балтии из базы [Экспресс-3](http://www.express-3.ru/);
- `esr` — коды железнодорожных станций СНГ и стран Балтии из базы [ЕСР](https://ru.wikipedia.org/wiki/%D0%95%D0%B4%D0%B8%D0%BD%D0%B0%D1%8F_%D1%81%D0%B5%D1%82%D0%B5%D0%B2%D0%B0%D1%8F_%D1%80%D0%B0%D0%B7%D0%BC%D0%B5%D1%82%D0%BA%D0%B0).
Параметр обязателен, если используется система кодирования, отличная от системы кодирования Яндекс Расписаний.
Система кодирования, коды которой следует добавить к описанию станций в результатах поиска (элемент codes, вложенный в элементы from и to).
Поддерживаемые значения:
yandex (значение по умолчанию) — система кодирования Яндекс Расписаний;
esr — коды железнодорожных станций СНГ и стран Балтии из базы [ЕСР](https://ru.wikipedia.org/wiki/%D0%95%D0%B4%D0%B8%D0%BD%D0%B0%D1%8F_%D1%81%D0%B5%D1%82%D0%B5%D0%B2%D0%B0%D1%8F_%D1%80%D0%B0%D0%B7%D0%BC%D0%B5%D1%82%D0%BA%D0%B0).
Часовой пояс, для которого следует указывать даты и времена в ответе. Если параметр не передан, каждая дата и время в ответе будут указаны в часовом поясе соответствующей станции.
Часовые пояса следует указывать с помощью идентификаторов [базы данных tz](https://ru.wikipedia.org/wiki/Tz_database). В английской Википедии приведен список идентификаторов из последней версии этой базы данных (в столбце «TZ» таблицы).
Код направления, по которому необходимо получить список рейсов электричек по станции (например, «arrival», «all» или «на Москву»).
Параметр `direction` игнорируется, если значение параметра `transport_types` отлично от `suburban`.
Доступные для станции коды направлений можно получить, запросив расписание на любую дату без параметра `direction`, но с параметром `transport_types=suburban`. Список направлений возвращается в элементе ответа `directions`.
**Тип**
Строка
**Описание**
Код пункта прибытия в системе кодирования Яндекс Расписаний.
**Тип**
Объект
**Описание**
Информация о постраничном выводе найденных рейсов.
**Тип**
Число
**Описание**
Общее количество рейсов, удовлетворяющих условиям поиска.
**Тип**
Число
**Описание**
Ограничение на количество рейсов, которые Яндекс Расписания возвращают в ответ на запрос (заданное в параметре `limit`).
Значение по умолчанию — 100.
**Тип**
Число
**Описание**
Смещение относительно первого результата поиска, заданное в параметре `offset`.
Значение по умолчанию — 0.
**Тип**
Строка
**Описание**
Дата, на которую получен список рейсов, в формате «YYYY-MM-DD».
**Тип**
Строка
**Описание**
Вид пункта отправления.
Возможные значения:
- `station` — станция;
- `settlement` — поселение.
**Тип**
Строка
**Описание**
Название пункта отправления.
**Тип**
Строка
**Описание**
Время прибытия, в формате ISO 8601 (YYYY-MM-DDThh:mm:ss±hh:mm).
Если параметр `result_timezone` не был передан, указывается в часовом поясе станции.
**Тип**
Строка
**Описание**
Тип отправляющегося транспортного средства.
Возможные значения:
- `plane` — самолет;
- `train` — поезд;
- `suburban` — электричка;
- `bus` — автобус;
- `water` — водный транспорт;
- `helicopter` — вертолет.
**Тип**
Объект
**Описание**
Информация о [нитке](https://yandex.ru/dev/rasp/doc/ru/concepts/termin#intervalthread) рейса.
**Тип**
Объект
**Описание**
Список кодов перевозчика в других системах кодирования, поддерживаемых Яндекс Расписаниями.
**Тип**
Объект
**Описание**
Код перевозчика в системе кодирования [ICAO](https://ru.wikipedia.org/wiki/%D0%9C%D0%B5%D0%B6%D0%B4%D1%83%D0%BD%D0%B0%D1%80%D0%BE%D0%B4%D0%BD%D0%B0%D1%8F_%D0%BE%D1%80%D0%B3%D0%B0%D0%BD%D0%B8%D0%B7%D0%B0%D1%86%D0%B8%D1%8F_%D0%B3%D1%80%D0%B0%D0%B6%D0%B4%D0%B0%D0%BD%D1%81%D0%BA%D0%BE%D0%B9_%D0%B0%D0%B2%D0%B8%D0%B0%D1%86%D0%B8%D0%B8).
**Тип**
Строка
**Описание**
Код перевозчика в системе кодирования [Sirena](http://ru.wikipedia.org/wiki/%D0%A1%D0%B8%D1%80%D0%B5%D0%BD%D0%B0_(%D1%81%D0%B5%D1%82%D1%8C)).
**Тип**
Строка
**Описание**
Код перевозчика в системе кодирования [IATA](https://ru.wikipedia.org/wiki/%D0%9C%D0%B5%D0%B6%D0%B4%D1%83%D0%BD%D0%B0%D1%80%D0%BE%D0%B4%D0%BD%D0%B0%D1%8F_%D0%B0%D1%81%D1%81%D0%BE%D1%86%D0%B8%D0%B0%D1%86%D0%B8%D1%8F_%D0%B2%D0%BE%D0%B7%D0%B4%D1%83%D1%88%D0%BD%D0%BE%D0%B3%D0%BE_%D1%82%D1%80%D0%B0%D0%BD%D1%81%D0%BF%D0%BE%D1%80%D1%82%D0%B0).
**Тип**
Объект
**Описание**
Информация о подтипе транспортного средства.
**Тип**
Строка
**Описание**
Основной цвет транспортного средства в шестнадцатеричном формате.
**Тип**
Строка
**Описание**
Название транспортного средства.
**Тип**
Строка
**Описание**
Номер рейса.
**Тип**
Строка
**Описание**
Признак экспресса или аэроэкспресса. Значение по умолчанию — `null`.
Если тип транспорта — электричка (ключ `transport_type` возвращен со значением `suburban`), принимает одно из значений:
- `express` — экспресс-рейс;
- `aeroexpress` — рейс, курсирующий между городом и аэропортом.
**Тип**
Строка
**Описание**
Время отправления, в формате ISO 8601 (YYYY-MM-DDThh:mm:ss±hh:mm).
Если параметр `result_timezone` не был передан, указывается в часовом поясе станции.
**Тип**
Строка (не более 1000 символов)
**Описание**
Станции следования рейса, на которых совершается остановка. Описывается в свободной форме. Например: значение `везде` значит, что остановка совершается на всех станциях следования.
Пустая строка значит, что по пути следования остановок нет.
**Тип**
Массив
**Описание**
Список рейсов.
**Тип**
Строка
**Описание**
Дни, в которые нитка не курсирует (даже если они входят в множество, описанное элементом days).
**Тип**
Объект
**Описание**
Информация о перевозчике.
**Тип**
Строка
**Описание**
Платформа или путь, с которого отправляется рейс (например, «3 путь»).
Пустая строка значит, что информации о платформе или пути нет.
**Тип**
Строка
**Описание**
Дни, в которые нитка не курсирует (даже если они входят в множество, описанное элементом days).
**Тип**
Строка
**Описание**
Терминал аэропорта (например, «D»).
Принимает значение `null`, если информации о терминале нет.
**Тип**
Булевый
**Описание**
Признак неточности времени отправления и времени прибытия. Возможные значения:
- `true` — время прибытия и время отправления указаны неточно;
- `false` — время прибытия и время отправления указан точно.
**Тип**
Объект
**Описание**
Код и название запрошенного направления рейсов.
Элемент включается в ответ, если в запросе указан параметр `direction`.
**Тип**
**Описание**
Одно из направлений, на котором лежит станция.
**Тип**
Объект
**Описание**
Информация об указанной в запросе станции.
**Тип**
Строка
**Описание**
Код станции в системе кодирования Яндекс Расписаний.
**Тип**
Строка
**Описание**
Код станции в системе кодирования [ЕСР](https://ru.wikipedia.org/wiki/%D0%95%D0%B4%D0%B8%D0%BD%D0%B0%D1%8F_%D1%81%D0%B5%D1%82%D0%B5%D0%B2%D0%B0%D1%8F_%D1%80%D0%B0%D0%B7%D0%BC%D0%B5%D1%82%D0%BA%D0%B0).
**Тип**
Строка
**Описание**
Тип станции.
Возможные значения:
- `station` — станция;
- `platform` — платформа;
- `stop` — остановочный пункт;
- `checkpoint` — блок-пост;
- `post` — пост;
- `crossing` — разъезд;
- `overtaking_point` — обгонный пункт;
- `train_station` — вокзал;
- `airport` — аэропорт;
- `bus_station` — автовокзал;
- `bus_stop` — автобусная остановка;
- `unknown` — станция без типа;
- `port` — порт;
- `port_point` — портпункт;
- `wharf` — пристань;
- `river_port` — речной вокзал;
- `marine_station` — морской вокзал.

1340
docs/yandex-api-docs/schedule-point-to-point.md Normal file
View File

File diff suppressed because it is too large Load Diff

623
docs/yandex-api-docs/stations-list.md Normal file
View File

@@ -0,0 +1,623 @@
Список всех доступных станций
# Список всех доступных станций
- [Синтаксис запроса](https://yandex.ru/dev/rasp/doc/ru/reference/stations-list#query)
- [Структура ответа](https://yandex.ru/dev/rasp/doc/ru/reference/stations-list#emails-detailed)
Ресурс содержит полный список станций, информацию о которых предоставляют Яндекс Расписания. Список структурирован географически: ответ содержит список стран со вложенными списками регионов и населенных пунктов, в которых находятся станции.
Размер возвращаемого JSON-документа — около 40 МБ.
## Синтаксис запроса
```
https://api.rasp.yandex-net.ru/v3.0/stations_list/ ?
apikey=<ключ>
[& format=<формат>]
[& lang=<язык>]
```
Пример запроса:
```
https://api.rasp.yandex-net.ru/v3.0/stations_list/?apikey={ключ}&lang=ru_RU&format=json
```
Входные параметры:
**Обязательные параметры**
| | |
| --- | --- |
| **Параметр** | **Описание** |
| `apikey` | [Ключ доступа](https://yandex.ru/dev/rasp/doc/ru/concepts/access) к API.<br>Параметр можно не передавать, если ключ доступа указан в заголовке `Authorization`, например:<br>```<br>Authorization: 1eb31582-941a-3ac8-a61f-041c344495ab<br>``` |
**Необязательные параметры**
| | |
| --- | --- |
| **Параметр** | **Описание** |
| `lang` | Язык возвращаемой информации, в формате <код языка>\_<код страны>. Поддерживаемые коды языка описаны стандартом [ISO 639](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2), коды стран — стандартом [ISO 3166](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).<br>По умолчанию ответ возвращается для значения `ru_RU`.<br>Поддерживаемые коды языков:<br>- `ru` — русский;<br>- `uk` — украинский.<br>Поддерживаемые коды стран:<br>- `RU` — Россия;<br>- `UA` — Украина. |
| `format` | Формат ответа. Поддерживаемые значения:<br>- `json` (по умолчанию);<br>- `xml`. |
## Структура ответа
Ответ оформлен в виде набора вложенных массивов: на верхнем уровне перечислены страны, в описании каждой страны — регионы, в каждом регионе — города, в каждом городе — станции.
Часть ответа в различных форматах показана в примерах.
Пример ответа в формате JSON
Пример ответа в формате XML
```
{
"countries":
[\
{\
"regions":\
[\
{\
"settlements":\
[\
{\
"title": "",\
"codes": {},\
"stations":\
[\
{\
"direction": "",\
"codes":\
{\
"yandex_code": "s9628674"\
},\
"station_type": "аэропорт",\
"title": "Бермуды",\
"longitude": -64.678703,\
"transport_type": "Самолёт",\
"latitude": 32.364041\
}\
]\
}\
],\
"codes": {},\
"title": ""\
}\
],\
"codes":\
{\
"yandex_code": "l21546"\
},\
"title": "Бермудские острова"\
},\
{\
"regions":\
[\
{\
"settlements":\
[\
{\
"title": "Банжул",\
"codes":\
{\
"yandex_code": "c21012"\
},\
"stations":\
[\
{\
"direction": "",\
"codes":\
{\
"yandex_code": "s9628059"\
},\
"station_type": "аэропорт",\
"title": "Юндум",\
"longitude": -16.652222,\
"transport_type": "Самолёт",\
"latitude": 13.338056\
}\
]\
}\
],\
"codes": {},\
"title": ""\
}\
],\
"codes":\
{\
"yandex_code": "l21010"\
},\
"title": "Гамбия"\
}\
{\
"regions":\
[\
{\
"settlements":\
[\
{\
"title": "Новая Уситва",\
"codes":\
{\
"yandex_code": "c54722"\
},\
"stations":\
[\
{\
"direction": "",\
"codes":\
{\
"yandex_code": "s9855938"\
},\
"station_type": "автобусная остановка",\
"title": "Новая Уситва",\
"longitude": 28.1280804651562,\
"transport_type": "Автобус",\
"latitude": 57.4583284320784\
}\
]\
},\
{\
"title": "Касторное",\
"codes":\
{\
"yandex_code": "c22754"\
},\
"stations":\
[\
{\
"direction": "Елецкое",\
"codes":\
{\
"esr_code": "595401",\
"yandex_code": "s9605487"\
},\
"station_type": "станция",\
"title": "Касторная-Новая",\
"longitude": 38.123675,\
"transport_type": "Поезд",\
"latitude": 51.780828\
}\
]\
}\
],\
"codes":\
{\
"yandex_code": "r10705"\
},\
"title": "Курская область"\
}\
],\
"codes":\
{\
"yandex_code": "l225"\
},\
"title": "Россия"\
}\
]
}
```
#### Описание элементов JSON
| | | |
| --- | --- | --- |
| **Элемент JSON** | **Тип** | **Описание** |
| `countries` | Массив | Список стран. |
**Элементыобъекта**`countries`
| | | |
| --- | --- | --- |
| **Элемент JSON** | **Тип** | **Описание** |
| `regions` | Массив | Список регионов страны. |
| `codes` | Объект | Коды страны. На данный момент используется только система кодирования Яндекс Расписаний (`yandex_code`). |
| `title` | Строка | Название страны. |
**Элементыобъекта**`regions`
| | | |
| --- | --- | --- |
| **Элемент JSON** | **Тип** | **Описание** |
| `settlements` | Массив | Список населенных пунктов региона. |
| `codes` | Объект | Коды региона. На данный момент используется только система кодирования Яндекс Расписаний (`yandex_code`). |
| `title` | Строка | Название региона. |
**Элементыобъекта**`settlements`
| | | |
| --- | --- | --- |
| **Элемент JSON** | **Тип** | **Описание** |
| `title` | Строка | Название населенного пункта. |
| `codes` | Объект | Коды населенного пункта. На данный момент используется только система кодирования Яндекс Расписаний (`yandex_code`). |
| `stations` | Объект | Список станций в населенном пункте. |
**Элементыобъекта**`stations`
| | | |
| --- | --- | --- |
| **Элемент JSON** | **Тип** | **Описание** |
| `direction` | Строка | Направление движения поездов, на котором находится станция.<br>Значение пусто, если станция не железнодорожная. |
| `codes` | Объект | Список кодов станции. |
| `station_type` | Строка | Тип станции.<br>Возможные значения:<br>- `station` — станция;<br>- `platform` — платформа;<br>- `stop` — остановочный пункт;<br>- `checkpoint` — блок-пост;<br>- `post` — пост;<br>- `crossing` — разъезд;<br>- `overtaking_point` — обгонный пункт;<br>- `train_station` — вокзал;<br>- `airport` — аэропорт;<br>- `bus_station` — автовокзал;<br>- `bus_stop` — автобусная остановка;<br>- `unknown` — станция без типа;<br>- `port` — порт;<br>- `port_point` — портпункт;<br>- `wharf` — пристань;<br>- `river_port` — речной вокзал;<br>- `marine_station` — морской вокзал. |
| `title` | Строка | Название станции. |
| `longitude` | Число | Долгота станции. |
| `transport_type` | Строка | Тип транспорта, следующего через станцию.<br>Возможные значения:<br>- `plane` — самолет;<br>- `train` — поезд;<br>- `suburban` — электричка;<br>- `bus` — автобус;<br>- `water` — морской транспорт;<br>- `helicopter` — вертолет. |
| `latitude` | Число | Широта станции. |
**Элементыобъекта**`station/codes`
| | | |
| --- | --- | --- |
| **Элемент JSON** | **Тип** | **Описание** |
| `esr_code` | Строка | Код железнодорожной станции в системе кодирования [ЕСР](https://ru.wikipedia.org/wiki/%C5%E4%E8%ED%E0%FF_%F1%E5%F2%E5%E2%E0%FF_%F0%E0%E7%EC%E5%F2%EA%E0). |
| `yandex_code` | Строка | Код в системе кодирования Яндекс Расписаний. |
```
<response>
<country>
<title>Бермудские острова</title>
<codes>
<yandex_code>l21546</yandex_code>
</codes>
<region>
<title/>
<codes/>
<settlement>
<title/>
<codes/>
<station>
<title>Бермуды</title>
<longitude>-64.678703</longitude>
<latitude>32.364041</latitude>
<transport_type>Самолёт</transport_type>
<station_type>аэропорт</station_type>
<codes>
<yandex_code>s9628674</yandex_code>
</codes>
</station>
</settlement>
</region>
</country>
<country>
<title>Гамбия</title>
<codes>
<yandex_code>l21010</yandex_code>
</codes>
<region>
<title/>
<codes/>
<settlement>
<title>Банжул</title>
<codes>
<yandex_code>c21012</yandex_code>
</codes>
<station>
<title>Юндум</title>
<longitude>-16.652222</longitude>
<latitude>13.338056</latitude>
<transport_type>Самолёт</transport_type>
<station_type>аэропорт</station_type>
<codes>
<yandex_code>s9628059</yandex_code>
</codes>
</station>
</settlement>
</region>
</country>
<country>
<title>Россия</title>
<codes>
<yandex_code>l225</yandex_code>
</codes>
<region>
<title>Псковская область</title>
<codes>
<yandex_code>r10926</yandex_code>
</codes>
<settlement>
<title>Новая Уситва</title>
<codes>
<yandex_code>c54722</yandex_code>
</codes>
<station>
<title>Новая Уситва</title>
<longitude>28.1280804652</longitude>
<latitude>57.4583284321</latitude>
<transport_type>Автобус</transport_type>
<station_type>автобусная остановка</station_type>
<codes>
<yandex_code>s9855938</yandex_code>
</codes>
</station>
<station>
<title>Касторная-Новая</title>
<longitude>38.123675</longitude>
<latitude>51.780828</latitude>
<transport_type>Поезд</transport_type>
<station_type>станция</station_type>
<direction>Елецкое</direction>
<codes>
<esr_code>595401</esr_code>
<yandex_code>s9605487</yandex_code>
</codes>
</station>
</settlement>
</region>
</country>
</response>
```
#### Описание элементов XML
| | | |
| --- | --- | --- |
| **Элемент XML** | **Тип** | **Описание** |
| `country` | | Страна, с вложенными описаниями регионов. |
**Элементыобъекта**`country`
| | | |
| --- | --- | --- |
| **Элемент XML** | **Тип** | **Описание** |
| `region` | Массив | Один из регионов страны. |
| `codes` | | Коды страны. На данный момент используется только система кодирования Яндекс Расписаний (`yandex_code`). |
| `title` | Строка | Название страны. |
**Элементыобъекта**`region`
| | | |
| --- | --- | --- |
| **Элемент XML** | **Тип** | **Описание** |
| `settlement` | | Один из населенных пунктов региона. |
| `codes` | Объект | Коды региона. На данный момент используется только система кодирования Яндекс Расписаний (`yandex_code`). |
| `title` | Объект | Название региона. |
**Элементыобъекта**`settlement`
| | | |
| --- | --- | --- |
| **Элемент XML** | **Тип** | **Описание** |
| `title` | Объект | Название населенного пункта. |
| `codes` | Объект | Коды населенного пункта. На данный момент используется только система кодирования Яндекс Расписаний (`yandex_code`). |
| `station` | Объект | Одна из станций в населенном пункте. |
**Элементыобъекта**`station`
| | | |
| --- | --- | --- |
| **Элемент XML** | **Тип** | **Описание** |
| `direction` | Строка | Направление движения поездов, на котором находится станция.<br>Значение пусто, если станция не железнодорожная. |
| `codes` | Объект | Список кодов станции. |
| `station_type` | Объект | Тип станции.<br>Возможные значения:<br>- `station` — станция;<br>- `platform` — платформа;<br>- `stop` — остановочный пункт;<br>- `checkpoint` — блок-пост;<br>- `post` — пост;<br>- `crossing` — разъезд;<br>- `overtaking_point` — обгонный пункт;<br>- `train_station` — вокзал;<br>- `airport` — аэропорт;<br>- `bus_station` — автовокзал;<br>- `bus_stop` — автобусная остановка;<br>- `unknown` — станция без типа;<br>- `port` — порт;<br>- `port_point` — портпункт;<br>- `wharf` — пристань;<br>- `river_port` — речной вокзал;<br>- `marine_station` — морской вокзал. |
| `title` | Объект | Название станции. |
| `longitude` | Число | Долгота станции. |
| `transport_type` | Объект | Тип транспорта, следующего через станцию.<br>Возможные значения:<br>- `plane` — самолет;<br>- `train` — поезд;<br>- `suburban` — электричка;<br>- `bus` — автобус;<br>- `water` — морской транспорт;<br>- `helicopter` — вертолет. |
| `latitude` | Число | Широта станции. |
**Элементы, вложенные в элемент**`station/codes`
| | | |
| --- | --- | --- |
| **Элемент XML** | **Тип** | **Описание** |
| `yandex_code` | Строка | Код в системе кодирования Яндекс Расписаний. |
| `esr_code` | Строка | Код железнодорожной станции в системе кодирования [ЕСР](https://ru.wikipedia.org/wiki/%C5%E4%E8%ED%E0%FF_%F1%E5%F2%E5%E2%E0%FF_%F0%E0%E7%EC%E5%F2%EA%E0). |
[Ключ доступа](https://yandex.ru/dev/rasp/doc/ru/concepts/access) к API.
Параметр можно не передавать, если ключ доступа указан в заголовке `Authorization`, например:
```
Authorization: 1eb31582-941a-3ac8-a61f-041c344495ab
```
Язык возвращаемой информации, в формате <код языка>\_<код страны>. Поддерживаемые коды языка описаны стандартом [ISO 639](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2), коды стран — стандартом [ISO 3166](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).
По умолчанию ответ возвращается для значения `ru_RU`.
Поддерживаемые коды языков:
- `ru` — русский;
- `uk` — украинский.
Поддерживаемые коды стран:
- `RU` — Россия;
- `UA` — Украина.
Формат ответа. Поддерживаемые значения:
- `json` (по умолчанию);
- `xml`.
**Тип**
Массив
**Описание**
Список населенных пунктов региона
**Тип**
Строка
**Описание**
Название населенного пункта.
**Тип**
Строка
**Описание**
Направление движения поездов, на котором находится станция.
Значение пусто, если станция не железнодорожная.
**Тип**
Строка
**Описание**
Код в системе кодирования Яндекс Расписаний.
**Тип**
**Описание**
Страна, с вложенными описаниями регионов.
**Тип**
Объект
**Описание**
Коды страны. На данный момент используется только система кодирования Яндекс Расписаний (`yandex_code`).
**Тип**
Строка
**Описание**
Название страны.
**Тип**
Объект
**Описание**
Название региона.
**Тип**
Объект
**Описание**
Название населенного пункта.
**Тип**
Объект
**Описание**
Название станции.
**Тип**
Строка
**Описание**
Код в системе кодирования Яндекс Расписаний.
**Тип**
Массив
**Описание**
Один из регионов страны.
**Тип**
**Описание**
Один из населенных пунктов региона.
**Тип**
Объект
**Описание**
Одна из станций в населенном пункте.
**Тип**
Число
**Описание**
Долгота станции.
**Тип**
Число
**Описание**
Широта станции.
**Тип**
Строка
**Описание**
Тип транспорта, следующего через станцию.
Возможные значения:
- `plane` — самолет;
- `train` — поезд;
- `suburban` — электричка;
- `bus` — автобус;
- `water` — морской транспорт;
- `helicopter` — вертолет.
**Тип**
Строка
**Описание**
Тип станции.
Возможные значения:
- `station` — станция;
- `platform` — платформа;
- `stop` — остановочный пункт;
- `checkpoint` — блок-пост;
- `post` — пост;
- `crossing` — разъезд;
- `overtaking_point` — обгонный пункт;
- `train_station` — вокзал;
- `airport` — аэропорт;
- `bus_station` — автовокзал;
- `bus_stop` — автобусная остановка;
- `unknown` — станция без типа;
- `port` — порт;
- `port_point` — портпункт;
- `wharf` — пристань;
- `river_port` — речной вокзал;
- `marine_station` — морской вокзал.
**Тип**
Строка
**Описание**
Направление движения поездов, на котором находится станция.
Значение пусто, если станция не железнодорожная.
**Тип**
Строка
**Описание**
Код железнодорожной станции в системе кодирования [ЕСР](https://ru.wikipedia.org/wiki/%D0%95%D0%B4%D0%B8%D0%BD%D0%B0%D1%8F_%D1%81%D0%B5%D1%82%D0%B5%D0%B2%D0%B0%D1%8F_%D1%80%D0%B0%D0%B7%D0%BC%D0%B5%D1%82%D0%BA%D0%B0).

31
docs/yandex-api-docs/terms.md Normal file
View File

@@ -0,0 +1,31 @@
# Терминология
## Расписание
Периодичность или время отправления рейсов.
## Станция
Место отправления, прибытия или остановки транспортного средства. Например, автобусная остановка, автовокзал, аэропорт и т. п.
## Рейс
Маршрут движения транспортного средства от места отправления до места назначения по заранее определенному маршруту и установленному расписанию.
## Нитка
Маршрут и время движения транспортного средства от начальной точки движения до конечной, привязанный к определенной дате.
Каждому рейсу соответствует нитка или набор ниток, определенный для конкретного дня. Например, в будние дни рейс «Москва — Голицыно» может двигаться по ниткам: «Москва — Одинцово», «Одинцово — Голицыно». В выходные дни этот же рейс может двигаться по нитке «Москва — Голицыно».
## Интервальная нитка
Нитка, на остановках которой транспорт останавливается с определенной периодичностью, но без четкого расписания.
## Перевозчик
Предприятие, принявшее на себя обязанность доставить пассажира из места отправления в место назначения.
## Система кодирования
Совокупность правил кодового обозначения городов, станций, перевозчиков (см. раздел Системы кодирования).