Get a venue

GET

/venues/{venue_id}

const url = 'https://api.krkplaystennis.example/v1/venues/ven_7hk2p9wq4m';
const options = {method: 'GET', headers: {'X-API-Key': '<X-API-Key>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.krkplaystennis.example/v1/venues/ven_7hk2p9wq4m \
  --header 'X-API-Key: <X-API-Key>'

Returns a venue and its courts.

Authorizations

ApiKeyAuth

Parameters

Path Parameters

venue_id

required

A venue ID. Starts with ven_.

string

/^ven_[a-z0-9]{10}$/

The venue ID.

Responses

200

The venue.

application/json

object

required

A venue ID. Starts with ven_.

string

/^ven_[a-z0-9]{10}$/

name

required

string

district

required

The Kraków district.

string

address

required

string

courts

required

Array<object>

object

number

required

integer

>= 1

surface

required

string

Allowed values: clay hard grass carpet artificial_grass

indoor

required

true for an indoor court or a court under a seasonal dome.

boolean

Examples

venue

Outdoor clay club with one covered court

{
  "id": "ven_7hk2p9wq4m",
  "name": "Riverside Courts Podgórze",
  "district": "Podgórze",
  "address": "ul. Rakietowa 7, 30-532 Kraków",
  "courts": [
    {
      "number": 1,
      "surface": "clay",
      "indoor": false
    },
    {
      "number": 2,
      "surface": "clay",
      "indoor": false
    },
    {
      "number": 3,
      "surface": "clay",
      "indoor": false
    },
    {
      "number": 4,
      "surface": "hard",
      "indoor": true
    }
  ]
}

401

The credentials are missing, invalid, or expired.

application/problem+json

An error, as RFC 9457 problem details.

object

type

required

A URL that identifies the error type and links to its documentation.

string format: uri

title

required

A short summary of the error type. It’s the same for every error of this type.

string

status

required

The HTTP status code.

integer

>= 400 <= 599

detail

required

An explanation of this occurrence of the error.

string

instance

The request path that caused the error.

string

errors

One item per invalid field or parameter. Only for invalid-request, invalid-score, and validation-failed.

Array<object>

object

pointer

required

A JSON Pointer to the invalid field in the request body, or #/ followed by the name of an invalid query parameter.

string

detail

required

What’s wrong with the field and how to fix it.

string

Examples

unauthenticated

Missing API key

{
  "type": "https://saverio-cirillo.com/krk-plays-tennis-api/errors/#unauthenticated",
  "title": "Authentication required",
  "status": 401,
  "detail": "Send a valid API key in the X-API-Key header.",
  "instance": "/v1/players/plr_2b7xq9mhk4"
}

404

No resource exists with this ID.

application/problem+json

An error, as RFC 9457 problem details.

object

type

required

A URL that identifies the error type and links to its documentation.

string format: uri

title

required

A short summary of the error type. It’s the same for every error of this type.

string

status

required

The HTTP status code.

integer

>= 400 <= 599

detail

required

An explanation of this occurrence of the error.

string

instance

The request path that caused the error.

string

errors

One item per invalid field or parameter. Only for invalid-request, invalid-score, and validation-failed.

Array<object>

object

pointer

required

A JSON Pointer to the invalid field in the request body, or #/ followed by the name of an invalid query parameter.

string

detail

required

What’s wrong with the field and how to fix it.

string

Examples

notFound

Unknown player ID

{
  "type": "https://saverio-cirillo.com/krk-plays-tennis-api/errors/#not-found",
  "title": "Not found",
  "status": 404,
  "detail": "No player exists with the ID plr_0000000000.",
  "instance": "/v1/players/plr_0000000000"
}

429

You sent too many requests. Wait for the number of seconds in Retry-After, then retry.

application/problem+json

An error, as RFC 9457 problem details.

object

type

required

A URL that identifies the error type and links to its documentation.

string format: uri

title

required

A short summary of the error type. It’s the same for every error of this type.

string

status

required

The HTTP status code.

integer

>= 400 <= 599

detail

required

An explanation of this occurrence of the error.

string

instance

The request path that caused the error.

string

errors

One item per invalid field or parameter. Only for invalid-request, invalid-score, and validation-failed.

Array<object>

object

pointer

required

A JSON Pointer to the invalid field in the request body, or #/ followed by the name of an invalid query parameter.

string

detail

required

What’s wrong with the field and how to fix it.

string

Examples

rateLimited

Rate limit reached

{
  "type": "https://saverio-cirillo.com/krk-plays-tennis-api/errors/#rate-limited",
  "title": "Rate limit reached",
  "status": 429,
  "detail": "This API key is limited to 60 requests per minute. Retry after 30 seconds.",
  "instance": "/v1/matches"
}

Headers

Retry-After

integer

>= 1

Number of seconds to wait before you retry.