GET ​/api​/v3​/search​/universal

Searches across bands, venues, users, and genres

Request

Example Request

{
  "query": "roc",
  "minimum_upcoming_gigs": 3,
  "types": "venues,band_profiles,accounts"
}

Example Parameters

  • query: The term to search for.

    • Required: yes
    • Type: string
    • Example: roc
  • minimumupcominggigs: Filter results by minimum upcoming gigs

    • Required: no
    • Type: integer
    • Example: 3
  • types: The types of records to search for, separated by commas. Supported types are venues, bandprofiles, accounts, genregroups

    • Required: no
    • Type: string
    • Example: venues,band_profiles,accounts

Response

Example Response

{
  "results": {
    "meta": {
      "venues": {
        "page": 1,
        "total_pages": 7,
        "per_page": 10,
        "records": 66
      },
      "band_profiles": {
        "page": 1,
        "total_pages": 3,
        "per_page": 10,
        "records": 24
      },
      "accounts": {
        "page": 1,
        "total_pages": 1,
        "per_page": 10,
        "records": 8
      },
      "genre_groups": {
        "page": 1,
        "total_pages": 1,
        "per_page": 10,
        "records": 1
      }
    },
    "venues": [
      {
        "id": "1",
        "_score": 0.121371135,
        "title": "Rock House",
        "subtitle": "Houston, TX, US",
        "type": "venue",
        "slug": "palladium-radio",
        "image": "",
        "official_station_id": 123
      }
    ],
    "band_profiles": [
      {
        "id": "1",
        "_score": 0.8030679,
        "title": "Rocky Horror Sounds",
        "subtitle": "",
        "type": "band_profile",
        "slug": "the-foos",
        "image": ""
      }
    ],
    "accounts": [
      {
        "id": "3",
        "_score": 2.071925,
        "title": "Rocco Balbooney",
        "subtitle": "rocco",
        "type": "band_profile",
        "slug": "foo",
        "image": ""
      }
    ],
    "genre_groups": [
      {
        "id": "1",
        "_score": 2.1499853,
        "title": "Rock",
        "subtitle": "Rock, Pop, Indie, Funk, Blues",
        "type": "band_profile"
      }
    ]
  }
}

Response Parameters

  • results: Contains the search results matching the provided term for each section.

    • Required: no
    • meta:

      • Required: yes
      • venues: The paging information for the venue results

        • Required: no
        • page: The requested page of records
          • Required: no
          • Type: number
          • Example: 1
        • total_pages: The total number of pages available to request
          • Required: no
          • Type: number
          • Example: 7
        • per_page: The number of records contained in each page
          • Required: no
          • Type: number
          • Example: 10
        • records: The total number of records that matched the search
          • Required: no
          • Type: number
          • Example: 66
      • band_profiles: The paging information for the band_profile results

        • Required: no
        • page: The requested page of records
          • Required: no
          • Type: number
          • Example: 1
        • total_pages: The total number of pages available to request
          • Required: no
          • Type: number
          • Example: 3
        • per_page: The number of records contained in each page
          • Required: no
          • Type: number
          • Example: 10
        • records: The total number of records that matched the search
          • Required: no
          • Type: number
          • Example: 24
      • accounts: The paging information for the account results

        • Required: no
        • page: The requested page of records
          • Required: no
          • Type: number
          • Example: 1
        • total_pages: The total number of pages available to request
          • Required: no
          • Type: number
          • Example: 1
        • per_page: The number of records contained in each page
          • Required: no
          • Type: number
          • Example: 10
        • records: The total number of records that matched the search
          • Required: no
          • Type: number
          • Example: 8
      • genre_groups: The paging information for the genre group results

        • Required: no
        • page: The requested page of records
          • Required: no
          • Type: number
          • Example: 1
        • total_pages: The total number of pages available to request
          • Required: no
          • Type: number
          • Example: 1
        • per_page: The number of records contained in each page
          • Required: no
          • Type: number
          • Example: 10
        • records: The total number of records that matched the search
          • Required: no
          • Type: number
          • Example: 1
    • venues: The collection of venues that matched the search.

      • Required: no
      • Type: array
      • Items

        • Required: no
        • id: The id of the record
          • Required: no
          • Type: string
          • Example: 1
        • __score_: The 'relevance' score. A higher number is more relevant.
          • Required: no
          • Type: number
          • Example: 0.121371135
        • title: The title to display in search result listings.
          • Required: no
          • Type: string
          • Example: Rock House
        • subtitle: Secondary text to display in search result listings.
          • Required: no
          • Type: string
          • Example: Houston, TX, US
        • type: The type of record returned
          • Required: no
          • Type: string
          • Example: venue
        • slug: The unique slug for a venue.
          • Required: no
          • Type:
            • null
            • string
          • Example: palladium-radio
        • image: An image url for the result
          • Required: no
          • Type:
            • null
            • string
        • officialstationid: The ID for the official station for this venue
          • Required: yes
          • Type:
            • null
            • integer
          • Example: 123
    • band_profiles: The matching band profiles.

      • Required: no
      • Items

        • Required: no
        • id: the id of the record
          • Required: no
          • Type: string
          • Example: 1
        • __score_: The 'relevance' score. A higher number is more relevant.
          • Required: no
          • Type: number
          • Example: 0.8030679
        • title: The title to display in search result listings.
          • Required: no
          • Type: string
          • Example: Rocky Horror Sounds
        • subtitle: Secondary text to display in search result listings.
          • Required: no
          • Type: string
          • Example:
        • type: The type of record returned
          • Required: no
          • Type: string
          • Example: band_profile
        • slug: The unique slug for a band.
          • Required: no
          • Type:
            • null
            • string
          • Example: the-foos
        • image: An image url for the result
          • Required: no
          • Type:
            • null
            • string
    • accounts: The matching accounts.

      • Required: no
      • Type: array
      • Items

        • Required: no
        • id: The id of the record
          • Required: no
          • Type: string
          • Example: 3
        • __score_: The 'relevance' score. A higher number is more relevant.
          • Required: no
          • Type: number
          • Example: 2.071925
        • title: The title to display in search result listings.
          • Required: no
          • Type: string
          • Example: Rocco Balbooney
        • subtitle: Secondary text to display in search result listings.
          • Required: no
          • Type: string
          • Example: rocco
        • type: The type of record returned
          • Required: no
          • Type: string
          • Example: band_profile
        • slug: The unique slug for a user. Corresponds to username.
          • Required: no
          • Type: string
          • Example: foo
        • image: An image url for the result
          • Required: no
          • Type:
            • null
            • string
    • genre_groups: The matching genre groups.

      • Required: no
      • Type: array
      • Items

        • Required: no
        • id: The id of the record
          • Required: no
          • Type: string
          • Example: 1
        • __score_: The 'relevance' score. A higher number is more relevant.
          • Required: no
          • Type: number
          • Example: 2.1499853
        • title: The title to display in search result listings.
          • Required: no
          • Type: string
          • Example: Rock
        • subtitle: Secondary text to display in search result listings.
          • Required: no
          • Type: string
          • Example: Rock, Pop, Indie, Funk, Blues
        • type: The type of record returned
          • Required: no
          • Type: string
          • Example: band_profile

Response Codes

Successful Response Codes

  • 200: Search was executed successfully.

Failure Response Codes