---
title: "GET /api/venues"
method: GET
path: "/api/venues"
tags: ["VenueApi"]
---

# GET /api/venues

`GET /api/venues`

## Request

- Base URL: `https://vocadb.net` (the document declares no server; this is the origin it was published from)
- URL: `https://vocadb.net/api/venues`
- Auth: none declared
- TypeScript: <https://skmtc.dev/vocadb/apis/vocadbweb/docs/api/venues/get.ts> (a function with typed inputs; its response is checked against the schema)

## Query parameters

- `query` string
- `fields` 'None' | 'AdditionalNames' | 'Description' | 'Events' | 'Names' | 'WebLinks'
- `start` integer
- `maxResults` integer
- `getTotalCount` boolean
- `nameMatchMode` 'Auto' | 'Partial' | 'StartsWith' | 'Exact' | 'Words'
- `lang` 'Default' | 'Japanese' | 'Romaji' | 'English'
- `sortRule` 'None' | 'Name' | 'Distance'
- `latitude` number, double
- `longitude` number, double
- `radius` number, double
- `distanceUnit` 'Kilometers' | 'Miles'

## Response `200`

Success

- VenueForApiContractPartialFindResult
  - `items` VenueForApiContract[], nullable
    - `additionalNames` string, nullable
    - `address` string, nullable
    - `addressCountryCode` string, nullable
    - `coordinates` OptionalGeoPointContract
      - `formatted` string, nullable
      - `hasValue` boolean
      - `latitude` number, double, nullable
      - `longitude` number, double, nullable
    - `deleted` boolean
    - `description` string, nullable
    - `events` ReleaseEventContract[], nullable
      - `additionalNames` string, nullable
      - `category` 'Unspecified' | 'AlbumRelease' | 'Anniversary' | 'Club' | 'Concert' | 'Contest' | 'Convention' | 'Other' | 'Festival'
      - `customName` boolean
      - `date` string, date-time, nullable
      - `deleted` boolean
      - `description` string, nullable
      - `endDate` string, date-time, nullable
      - `hasVenueOrVenueName` boolean
      - `id` integer
      - `inheritedCategory` 'Unspecified' | 'AlbumRelease' | 'Anniversary' | 'Club' | 'Concert' | 'Contest' | 'Convention' | 'Other' | 'Festival'
      - `name` string, nullable
      - `pictureMime` string, nullable
      - `series` ReleaseEventSeriesContract
        - `additionalNames` string, nullable
        - `category` 'Unspecified' | 'AlbumRelease' | 'Anniversary' | 'Club' | 'Concert' | 'Contest' | 'Convention' | 'Other' | 'Festival'
        - `deleted` boolean
        - `description` string, nullable
        - `id` integer
        - `name` string, nullable
        - `pictureMime` string, nullable
        - `status` 'Draft' | 'Finished' | 'Approved' | 'Locked'
        - `urlSlug` string, nullable
        - `version` integer
        - `webLinks` WebLinkContract[], nullable
          - `category` 'Official' | 'Commercial' | 'Reference' | 'Other'
          - `description` string, nullable
          - `descriptionOrUrl` string, nullable
          - `disabled` boolean
          - `id` integer
          - `url` string, nullable
      - `songList` SongListBaseContract
        - `featuredCategory` 'Nothing' | 'Concerts' | 'VocaloidRanking' | 'Pools' | 'Other'
        - `id` integer
        - `name` string, nullable
      - `status` 'Draft' | 'Finished' | 'Approved' | 'Locked'
      - `urlSlug` string, nullable
      - `venue` VenueContract
        - `additionalNames` string, nullable
        - `address` string, nullable
        - `addressCountryCode` string, nullable
        - `coordinates` OptionalGeoPointContract
          - `formatted` string, nullable
          - `hasValue` boolean
          - `latitude` number, double, nullable
          - `longitude` number, double, nullable
        - `deleted` boolean
        - `description` string, nullable
        - `id` integer
        - `name` string, nullable
        - `status` 'Draft' | 'Finished' | 'Approved' | 'Locked'
        - `version` integer
        - `webLinks` WebLinkContract[], nullable
          - `category` 'Official' | 'Commercial' | 'Reference' | 'Other'
          - `description` string, nullable
          - `descriptionOrUrl` string, nullable
          - `disabled` boolean
          - `id` integer
          - `url` string, nullable
      - `venueName` string, nullable
      - `version` integer
    - `id` integer
    - `name` string, nullable
    - `names` LocalizedStringContract[], nullable
      - `language` 'Unspecified' | 'Japanese' | 'Romaji' | 'English'
      - `value` string, nullable
    - `status` 'Draft' | 'Finished' | 'Approved' | 'Locked'
    - `version` integer
    - `webLinks` WebLinkForApiContract[], nullable
      - `category` 'Official' | 'Commercial' | 'Reference' | 'Other'
      - `description` string, nullable
      - `descriptionOrUrl` string, nullable
      - `disabled` boolean
      - `id` integer
      - `url` string, nullable
  - `term` string, nullable
  - `totalCount` integer

## Changes

- **2023-02-17** `a58e37404e87`: 9 warning
  - added the new `Festival` enum value to the `items/items/events/items/category` response property for the response status `200` (media type: text/plain)
  - added the new `Festival` enum value to the `items/items/events/items/category` response property for the response status `200` (media type: application/json)
  - added the new `Festival` enum value to the `items/items/events/items/category` response property for the response status `200` (media type: text/json)
  - added the new `Festival` enum value to the `items/items/events/items/inheritedCategory` response property for the response status `200` (media type: text/plain)
  - …5 more

[Operation history](https://skmtc.dev/vocadb/apis/vocadbweb/changes/api/venues/get.md)

---

[API](https://skmtc.dev/vocadb/apis/vocadbweb.md) - [All operations](https://skmtc.dev/vocadb/apis/vocadbweb/llms.txt) - [OpenAPI document](https://skmtc.dev/vocadb/apis/vocadbweb/revisions/d1328dfaa36f?raw)