Skip to content
Scrappa Get API key
Resy API 1 credit / request

Resy City Listings API Documentation

GET https://scrappa.co/api/resy/city-listings?location=new-york-ny

Return the public Book Tonight venue listing for a city slug. Each venue carries its id, name, cuisine, price band, rating and images. Filter by day, party size and position. Omit day and party_size to use today and 2. Costs 1 credit.

Resy City Listings API Documentation 1 credit / request

Endpoint

Request preview
GET
https://scrappa.co/api/resy/city-listings?location=new-york-ny
Auth header
x-api-key
Cost
1 credit / request
location = new-york-ny
Response preview
200 OK
{
    "success": true,
    "data": {
        "venues": [
            {
                "id": {
                    "resy": 60029
                },
                "name": "Le Gratin"
            }
        ]
    },
    "meta": {
        "endpoint_family": "city_listings",
...

Parameters

Start with the required fields, then add optional filters only when your use case needs them.

Runnable path

1 required parameter needed before sending a request.

4 optional filters available.

location string Required

City slug, e.g. new-york-ny.

Example value new-york-ny
day string Optional

Reservation date in YYYY-MM-DD form. Defaults to today.

Example value example
party_size integer Optional

Number of guests, 1 to 20. Defaults to 2 when day is omitted.

Example value 10
latitude number Optional

Latitude to bias the listing. Send with longitude.

Example value 10
longitude number Optional

Longitude to bias the listing. Send with latitude.

Example value 10

Request Examples

PHP
<?php

$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => "https://scrappa.co/api/resy/city-listings?location=new-york-ny",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => "",
    CURLOPT_MAXREDIRS => 10,
    CURLOPT_TIMEOUT => 30,
    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_HTTPHEADER => [
        "x-api-key: YOUR_API_KEY_HERE"
    ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
    echo "cURL Error #:" . $err;
} else {
    echo $response;
}
PHP
<?php

use Illuminate\Support\Facades\Http;

$response = Http::timeout(30)
    ->withHeaders(['x-api-key' => 'YOUR_API_KEY_HERE'])
    ->get('https://scrappa.co/api/resy/city-listings?location=new-york-ny');

if ($response->successful()) {
    echo $response->body();
} else {
    echo "Error: " . $response->status();
}
JavaScript
const options = {
    method: 'GET',
    headers: {
        'x-api-key': 'YOUR_API_KEY_HERE'
    }
};

fetch('https://scrappa.co/api/resy/city-listings?location=new-york-ny', options)
    .then(response => {
        if (!response.ok) {
            throw new Error(`HTTP error! status: ${response.status}`);
        }
        return response.text();
    })
    .then(data => console.log(data))
    .catch(error => console.error('Error:', error));
JavaScript
const axios = require('axios');

const options = {
    method: 'GET',
    url: 'https://scrappa.co/api/resy/city-listings?location=new-york-ny',
    headers: {
        x-api-key: 'YOUR_API_KEY_HERE',
    }
};

try {
    const response = await axios(options);
    console.log(response.data);
} catch (error) {
    console.error('Error:', error.message);
}
Ruby
require 'net/http'
require 'uri'

uri = URI.parse("https://scrappa.co/api/resy/city-listings?location=new-york-ny")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == 'https'

request = Net::HTTP::Get.new(uri.request_uri)
request['x-api-key'] = 'YOUR_API_KEY_HERE'

begin
    response = http.request(request)
    puts response.body
rescue => e
    puts "Error: #{e.message}"
end
Python
import http.client
import json

conn = http.client.HTTPSConnection("scrappa.co")

headers = {
    'x-api-key': 'YOUR_API_KEY_HERE',
}

try:
    conn.request("GET", "/api/resy/city-listings?location=new-york-ny", headers=headers)
    res = conn.getresponse()
    data = res.read()
    print(data.decode("utf-8"))
except Exception as e:
    print(f"Error: {e}")
finally:
    conn.close()
Python
import requests

headers = {
    'x-api-key': 'YOUR_API_KEY_HERE',
}

try:
    response = requests.get('https://scrappa.co/api/resy/city-listings?location=new-york-ny', headers=headers)
    response.raise_for_status()
    print(response.text)
except requests.exceptions.RequestException as e:
    print(f"Error: {e}")
Java
import okhttp3.OkHttpClient;
import okhttp3.Request;
import okhttp3.Response;
import java.io.IOException;

public class ApiExample {
    public static void main(String[] args) {
        OkHttpClient client = new OkHttpClient();

        Request request = new Request.Builder()
            .url("https://scrappa.co/api/resy/city-listings?location=new-york-ny")
        .addHeader("x-api-key", "YOUR_API_KEY_HERE")
            .build();

        try (Response response = client.newCall(request).execute()) {
            if (response.isSuccessful()) {
                System.out.println(response.body().string());
            } else {
                System.out.println("Error: " + response.code());
            }
        } catch (IOException e) {
            System.out.println("Error: " + e.getMessage());
        }
    }
}
Go
package main

import (
    "fmt"
    "net/http"
    "io/ioutil"
)

func main() {
    client := &http.Client{}
    req, err := http.NewRequest("GET", "https://scrappa.co/api/resy/city-listings?location=new-york-ny", nil)
    if err != nil {
        fmt.Println("Error creating request:", err)
        return
    }
    req.Header.Set("x-api-key", "YOUR_API_KEY_HERE")

    resp, err := client.Do(req)
    if err != nil {
        fmt.Println("Error making request:", err)
        return
    }
    defer resp.Body.Close()

    body, err := ioutil.ReadAll(resp.Body)
    if err != nil {
        fmt.Println("Error reading response:", err)
        return
    }

    fmt.Println(string(body))
}
Terminal
#!/bin/bash

curl -X GET \
    -H "x-api-key: YOUR_API_KEY_HERE" \
    "https://scrappa.co/api/resy/city-listings?location=new-york-ny"
C#
using System;
using System.Net.Http;
using System.Threading.Tasks;

class Program
{
    static async Task Main()
    {
        using var client = new HttpClient();
        client.DefaultRequestHeaders.Add("x-api-key", "YOUR_API_KEY_HERE");

        try
        {
            var response = await client.SendAsync(new HttpRequestMessage(HttpMethod.Get, "https://scrappa.co/api/resy/city-listings?location=new-york-ny"));
            var content = await response.Content.ReadAsStringAsync();
            Console.WriteLine(content);
        }
        catch (Exception ex)
        {
            Console.WriteLine($"Error: {ex.Message}");
        }
    }
}
TypeScript
import axios from 'axios';

async function run(): Promise<void> {
    try {
        const response = await axios({
            method: 'GET',
            url: 'https://scrappa.co/api/resy/city-listings?location=new-york-ny',
            headers: {
        'x-api-key': 'YOUR_API_KEY_HERE',
            },
        });

        console.log(response.data);
    } catch (error) {
        console.error('Error:', error);
    }
}

void run();
RUST
use reqwest::Client;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let client = Client::new();

    let response = client
        .get("https://scrappa.co/api/resy/city-listings?location=new-york-ny")
        .header("x-api-key", "YOUR_API_KEY_HERE")
        .send()
        .await?;

    println!("{}", response.text().await?);

    Ok(())
}

Response Schema

Example response fields are illustrative; inspect the JSON before integrating.

Example response fields

Scan these fields before integrating.

success data meta
JSON Response
200 OK
{
    "success": true,
    "data": {
        "venues": [
            {
                "id": {
                    "resy": 60029
                },
                "name": "Le Gratin"
            }
        ]
    },
    "meta": {
        "endpoint_family": "city_listings",
        "billable": true
    }
}

Errors

Handle these documented responses before retrying or showing customer-facing failures.

400

Unsupported Filter

The request used a filter key that is not proven. No filter is fabricated. Not billable.

{
    "message": "Unsupported filter: cuisine"
}
422

Invalid Request

Resy rejected the request. Check the parameters. Not billable and not retryable.

{
    "meta": {
        "billable": false,
        "retryable": false
    },
    "error": {
        "code": "VALIDATION",
        "message": "The Resy request was rejected. Check the request parameters."
    },
    "success": false
}
404

Venue Not Found

The requested venue was not found. Not billable.

{
    "meta": {
        "billable": false,
        "endpoint_family": "venue"
    },
    "error": {
        "code": "NOT_FOUND",
        "message": "The requested Resy venue was not found."
    },
    "success": false
}
502

Invalid Source Response

The upstream response no longer matches the expected shape. Not billable.

{
    "meta": {
        "billable": false
    },
    "error": {
        "code": "PARSER_DRIFT",
        "message": "The Resy API is temporarily unavailable. Please retry."
    },
    "success": false
}
503

Upstream Unavailable

No healthy egress or the upstream failed. Not billable.

{
    "meta": {
        "billable": false
    },
    "error": {
        "code": "UPSTREAM_UNAVAILABLE",
        "message": "The Resy API is temporarily unavailable. Please retry."
    },
    "success": false
}

Generate Code with AI

Copy a ready-made prompt with all the endpoint details, parameters, and example responses. Paste it into ChatGPT, Claude, or any AI assistant to instantly generate working code.

Try It Live

Test this endpoint in our interactive playground with real data.