InBe Docs

Advanced Details Endpoint

This endpoint provides the most complete picture about a location, including all images, menus, events and more

The Advanced Details endpoint provides the most comprehensive venue information available. This includes complete venue profiles, all available images, detailed descriptions, amenities, contact information, and much more. Use this endpoint when you need the full picture of a venue for detailed profile pages or rich user experiences.

Endpoint

GET /v1/establishments/advanced/{venueId}

Caching

If you are caching the venue details, you should only cache the venue ID. Do not cache the full venue details response, as the data changes frequently and must always be fetched fresh for accuracy and compliance.

Parameters

id (required)

The venue ID obtained from search results or other InBe endpoints.

Response structure

Advanced details response
type  = {
  : string;
  : string;
  : string;
  : string;
  : {
    : string;
    : [number, number];
  };
  : string;
  : string;
  : string;
  : string;
  : string;
  : string[];
  : string;
  : boolean;
  : {
    : string[];
    : {
      : string;
      : string;
      : boolean;
      : boolean;
    }[];
  }[];
  : string;
  : string;
  : string[];
  : string[];
  : {
    : string;
    : string | null;
  }[];
  : string;
  : {
    : string;
    : {
      : string;
      : string;
      : boolean;
      : boolean;
    }[];
  }[];
  : {
    : string[];
    : {
      : string;
      : string;
      : boolean;
      : boolean;
    }[];
  }[];
  : {
    : string;
    : string;
  };
  : {
    : string;
    : number;
  };
  : {
    : boolean;
    : boolean;
    : boolean;
    : boolean;
  };
  : {
    : boolean;
    : boolean;
    : boolean;
    : boolean;
    : boolean;
    : boolean;
    : boolean;
    : boolean;
  };
  : {
    : boolean;
    : boolean;
    : boolean;
    : boolean;
  };
  : {
    ?: string;
    ?: string;
    ?: string;
    ?: string;
    ?: number;
  };
  : {
    ?: string;
    ?: string;
    ?: string;
    ?: string;
    ?: string;
  };
  : [];
  : {}[];
};

Use cases

  • Venue profile pages
  • Detailed venue information
  • Rich user experiences
  • Complete venue data

Real-world examples

TypeScript
class VenueProfilePage {
  async loadFullVenueDetails(venueId: string) {
    try {
      const response = await fetch(`/v1/establishments/advanced/${venueId}`, {
        headers: { "Api-Key": `${process.env.API_KEY}` },
      });
 
      if (!response.ok) {
        throw new Error(`Failed to load venue: ${response.status}`);
      }
 
      const venue: AdvancedDetails = await response.json();
      this.renderVenueProfile(venue);
      this.setupImageGallery(venue.photos);
      this.displayAmenities(venue.establishmentFlags);
    } catch (error) {
      this.showError("Failed to load venue details");
    }
  }
 
  private renderVenueProfile(venue: AdvancedDetails) {
    const profileHTML = `
      <div class="venue-profile">
        <h1>${venue.name}</h1>
        <p class="description">${venue.description}</p>
        <div class="rating">
          <span class="stars">${"⭐".repeat(Math.floor(parseFloat(venue.ratings.rating)))}</span>
          <span class="score">${venue.ratings.rating} (${venue.ratings.userRatingCount} reviews)</span>
        </div>
        <div class="location">
          <p>${venue.formattedAddress}</p>
        </div>
        <div class="contact">
          <p>📞 ${venue.contactNumber}</p>
          <p>🌐 <a href="${venue.websiteUri}">${venue.websiteUri}</a></p>
        </div>
      </div>
    `;
 
    document.getElementById("venue-profile")!.innerHTML = profileHTML;
  }
 
  private setupImageGallery(photos: { url: string; caption: string | null }[]) {
    const gallery = document.getElementById("image-gallery")!;
    gallery.innerHTML = photos
      .map(
        (photo) => `
      <div class="gallery-item">
        <img src="${photo.url}" alt="${photo.caption || "Venue photo"}" />
        <p class="caption">${photo.caption || ""}</p>
      </div>
    `,
      )
      .join("");
  }
}

API Reference

Below is the complete OpenAPI specification for the Advanced Details endpoint:

Next steps

On this page