{"variants":[{"paths":["\/documentation\/amiiboservice\/amiiboliveclient\/getamiiboseries(by:)"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"patch":0,"major":0,"minor":3},"kind":"symbol","hierarchy":{"paths":[["doc:\/\/AmiiboService\/documentation\/AmiiboService","doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboLiveClient"]]},"sections":[],"metadata":{"role":"symbol","title":"getAmiiboSeries(by:)","symbolKind":"method","modules":[{"name":"AmiiboService"}],"externalID":"s:13AmiiboService0A10LiveClientV03getA6Series2bySayAA0aF0VGAA0aF6FilterV_tYaKF","roleHeading":"Instance Method","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getAmiiboSeries","kind":"identifier"},{"text":"(","kind":"text"},{"text":"by","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:13AmiiboService0A12SeriesFilterV","text":"AmiiboSeriesFilter","kind":"typeIdentifier"},{"text":") ","kind":"text"},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":" -> [","kind":"text"},{"preciseIdentifier":"s:13AmiiboService0A6SeriesV","text":"AmiiboSeries","kind":"typeIdentifier"},{"text":"]","kind":"text"}],"extendedModule":"AmiiboService"},"abstract":[{"type":"text","text":"Gets a list of amiibo series based on a given filter."}],"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["macOS"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"getAmiiboSeries"},{"kind":"text","text":"("},{"kind":"externalParam","text":"by"},{"kind":"text","text":" "},{"kind":"internalParam","text":"filter"},{"kind":"text","text":": "},{"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboSeriesFilter","kind":"typeIdentifier","preciseIdentifier":"s:13AmiiboService0A12SeriesFilterV","text":"AmiiboSeriesFilter"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"},{"kind":"text","text":" -> ["},{"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboSeries","kind":"typeIdentifier","preciseIdentifier":"s:13AmiiboService0A6SeriesV","text":"AmiiboSeries"},{"kind":"text","text":"]"}]}],"kind":"declarations"},{"kind":"parameters","parameters":[{"content":[{"inlineContent":[{"text":"A filter to remove unwanted items from the result.","type":"text"}],"type":"paragraph"}],"name":"filter"}]},{"content":[{"type":"heading","level":2,"text":"Return Value","anchor":"return-value"},{"inlineContent":[{"text":"A list of filtered amiibo series.","type":"text"}],"type":"paragraph"}],"kind":"content"},{"content":[{"type":"heading","level":2,"text":"Discussion","anchor":"discussion"},{"type":"aside","content":[{"inlineContent":[{"text":"An ","type":"text"},{"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboServiceError","type":"reference","isActive":true},{"text":" error in case some issue is encountered while generating the result.","type":"text"}],"type":"paragraph"}],"name":"Throws","style":"note"}],"kind":"content"}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboLiveClient\/getAmiiboSeries(by:)"},"references":{"doc://AmiiboService/documentation/AmiiboService/AmiiboLiveClient":{"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboLiveClient","type":"topic","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AmiiboLiveClient","kind":"identifier"}],"role":"symbol","navigatorTitle":[{"text":"AmiiboLiveClient","kind":"identifier"}],"title":"AmiiboLiveClient","abstract":[{"type":"text","text":"A type that implements a live client to the online service."}],"url":"\/documentation\/amiiboservice\/amiiboliveclient","kind":"symbol"},"doc://AmiiboService/documentation/AmiiboService/AmiiboServiceError":{"title":"AmiiboServiceError","type":"topic","role":"symbol","kind":"symbol","abstract":[{"text":"A representation of all the possible errors that the ","type":"text
