> For the complete documentation index, see [llms.txt](https://docs.mapbox.com/ios/search/llms.txt)

# API Reference

The Mapbox Search SDK for iOS gives you the tools you need to add a search experience to your application.

The Search SDK consists of two frameworks: Search Core (`MapboxSearch`) and the Search UI SDK (`MapboxSearchUI`). To learn more about the different frameworks, read the [structure of the Search SDK section](https://docs.mapbox.com/ios/search/guides#structure-of-the-search-sdk).

v2.28.4 latest

[2.28.4Search Core](https://docs.mapbox.com/ios/search/api/core/2.28.4/)[2.28.4Search UI](https://docs.mapbox.com/ios/search/api/ui/2.28.4/)

Prerelease

v2.30.0-alpha.5

[2.30.0-alpha.5Search Core](https://docs.mapbox.com/ios/search/api/core/2.30.0-alpha.5/)[2.30.0-alpha.5Search UI](https://docs.mapbox.com/ios/search/api/ui/2.30.0-alpha.5/)

v2.30.0-alpha.3

[2.30.0-alpha.3Search Core](https://docs.mapbox.com/ios/search/api/core/2.30.0-alpha.3/)[2.30.0-alpha.3Search UI](https://docs.mapbox.com/ios/search/api/ui/2.30.0-alpha.3/)

v2.30.0-alpha.2

[2.30.0-alpha.2Search Core](https://docs.mapbox.com/ios/search/api/core/2.30.0-alpha.2/)[2.30.0-alpha.2Search UI](https://docs.mapbox.com/ios/search/api/ui/2.30.0-alpha.2/)

v2.29.0-rc.1

[2.29.0-rc.1Search Core](https://docs.mapbox.com/ios/search/api/core/2.29.0-rc.1/)[2.29.0-rc.1Search UI](https://docs.mapbox.com/ios/search/api/ui/2.29.0-rc.1/)

v2.29.0-alpha.3

[2.29.0-alpha.3Search Core](https://docs.mapbox.com/ios/search/api/core/2.29.0-alpha.3/)[2.29.0-alpha.3Search UI](https://docs.mapbox.com/ios/search/api/ui/2.29.0-alpha.3/)

v2.29.0-alpha.2

[2.29.0-alpha.2Search Core](https://docs.mapbox.com/ios/search/api/core/2.29.0-alpha.2/)[2.29.0-alpha.2Search UI](https://docs.mapbox.com/ios/search/api/ui/2.29.0-alpha.2/)

v2.29.0-alpha.1

[2.29.0-alpha.1Search Core](https://docs.mapbox.com/ios/search/api/core/2.29.0-alpha.1/)[2.29.0-alpha.1Search UI](https://docs.mapbox.com/ios/search/api/ui/2.29.0-alpha.1/)

Previous versions

v2.28.3

[2.28.3Search Core](https://docs.mapbox.com/ios/search/api/core/2.28.3/)[2.28.3Search UI](https://docs.mapbox.com/ios/search/api/ui/2.28.3/)

v2.28.2

[2.28.2Search Core](https://docs.mapbox.com/ios/search/api/core/2.28.2/)[2.28.2Search UI](https://docs.mapbox.com/ios/search/api/ui/2.28.2/)

v2.28.1

[2.28.1Search Core](https://docs.mapbox.com/ios/search/api/core/2.28.1/)[2.28.1Search UI](https://docs.mapbox.com/ios/search/api/ui/2.28.1/)

v2.28.0

[2.28.0Search Core](https://docs.mapbox.com/ios/search/api/core/2.28.0/)[2.28.0Search UI](https://docs.mapbox.com/ios/search/api/ui/2.28.0/)

v2.27.2

[2.27.2Search Core](https://docs.mapbox.com/ios/search/api/core/2.27.2/)[2.27.2Search UI](https://docs.mapbox.com/ios/search/api/ui/2.27.2/)

v2.27.1

[2.27.1Search Core](https://docs.mapbox.com/ios/search/api/core/2.27.1/)[2.27.1Search UI](https://docs.mapbox.com/ios/search/api/ui/2.27.1/)

v2.27.0

[2.27.0Search Core](https://docs.mapbox.com/ios/search/api/core/2.27.0/)[2.27.0Search UI](https://docs.mapbox.com/ios/search/api/ui/2.27.0/)

v2.26.0

[2.26.0Search Core](https://docs.mapbox.com/ios/search/api/core/2.26.0/)[2.26.0Search UI](https://docs.mapbox.com/ios/search/api/ui/2.26.0/)

v2.25.3

[2.25.3Search Core](https://docs.mapbox.com/ios/search/api/core/2.25.3/)[2.25.3Search UI](https://docs.mapbox.com/ios/search/api/ui/2.25.3/)

v2.25.2

[2.25.2Search Core](https://docs.mapbox.com/ios/search/api/core/2.25.2/)[2.25.2Search UI](https://docs.mapbox.com/ios/search/api/ui/2.25.2/)

v2.25.1

[2.25.1Search Core](https://docs.mapbox.com/ios/search/api/core/2.25.1/)[2.25.1Search UI](https://docs.mapbox.com/ios/search/api/ui/2.25.1/)

v2.25.0

[2.25.0Search Core](https://docs.mapbox.com/ios/search/api/core/2.25.0/)[2.25.0Search UI](https://docs.mapbox.com/ios/search/api/ui/2.25.0/)

v2.24.3

[2.24.3Search Core](https://docs.mapbox.com/ios/search/api/core/2.24.3/)[2.24.3Search UI](https://docs.mapbox.com/ios/search/api/ui/2.24.3/)

v2.24.2

[2.24.2Search Core](https://docs.mapbox.com/ios/search/api/core/2.24.2/)[2.24.2Search UI](https://docs.mapbox.com/ios/search/api/ui/2.24.2/)

v2.24.1

[2.24.1Search Core](https://docs.mapbox.com/ios/search/api/core/2.24.1/)[2.24.1Search UI](https://docs.mapbox.com/ios/search/api/ui/2.24.1/)

v2.23.1

[2.23.1Search Core](https://docs.mapbox.com/ios/search/api/core/2.23.1/)[2.23.1Search UI](https://docs.mapbox.com/ios/search/api/ui/2.23.1/)

v2.23.0

[2.23.0Search Core](https://docs.mapbox.com/ios/search/api/core/2.23.0/)[2.23.0Search UI](https://docs.mapbox.com/ios/search/api/ui/2.23.0/)

v2.22.4

[2.22.4Search Core](https://docs.mapbox.com/ios/search/api/core/2.22.4/)[2.22.4Search UI](https://docs.mapbox.com/ios/search/api/ui/2.22.4/)

v2.22.3

[2.22.3Search Core](https://docs.mapbox.com/ios/search/api/core/2.22.3/)[2.22.3Search UI](https://docs.mapbox.com/ios/search/api/ui/2.22.3/)

v2.22.1

[2.22.1Search Core](https://docs.mapbox.com/ios/search/api/core/2.22.1/)[2.22.1Search UI](https://docs.mapbox.com/ios/search/api/ui/2.22.1/)

v2.22.0

[2.22.0Search Core](https://docs.mapbox.com/ios/search/api/core/2.22.0/)[2.22.0Search UI](https://docs.mapbox.com/ios/search/api/ui/2.22.0/)

v2.21.10

[2.21.10Search Core](https://docs.mapbox.com/ios/search/api/core/2.21.10/)[2.21.10Search UI](https://docs.mapbox.com/ios/search/api/ui/2.21.10/)

v2.21.9

[2.21.9Search Core](https://docs.mapbox.com/ios/search/api/core/2.21.9/)[2.21.9Search UI](https://docs.mapbox.com/ios/search/api/ui/2.21.9/)

v2.21.8

[2.21.8Search Core](https://docs.mapbox.com/ios/search/api/core/2.21.8/)[2.21.8Search UI](https://docs.mapbox.com/ios/search/api/ui/2.21.8/)

v2.21.7

[2.21.7Search Core](https://docs.mapbox.com/ios/search/api/core/2.21.7/)[2.21.7Search UI](https://docs.mapbox.com/ios/search/api/ui/2.21.7/)

v2.21.6

[2.21.6Search Core](https://docs.mapbox.com/ios/search/api/core/2.21.6/)[2.21.6Search UI](https://docs.mapbox.com/ios/search/api/ui/2.21.6/)

v2.21.5

[2.21.5Search Core](https://docs.mapbox.com/ios/search/api/core/2.21.5/)[2.21.5Search UI](https://docs.mapbox.com/ios/search/api/ui/2.21.5/)

v2.21.4

[2.21.4Search Core](https://docs.mapbox.com/ios/search/api/core/2.21.4/)[2.21.4Search UI](https://docs.mapbox.com/ios/search/api/ui/2.21.4/)

v2.21.3

[2.21.3Search Core](https://docs.mapbox.com/ios/search/api/core/2.21.3/)[2.21.3Search UI](https://docs.mapbox.com/ios/search/api/ui/2.21.3/)

v2.21.2

[2.21.2Search Core](https://docs.mapbox.com/ios/search/api/core/2.21.2/)[2.21.2Search UI](https://docs.mapbox.com/ios/search/api/ui/2.21.2/)

v2.21.1

[2.21.1Search Core](https://docs.mapbox.com/ios/search/api/core/2.21.1/)[2.21.1Search UI](https://docs.mapbox.com/ios/search/api/ui/2.21.1/)

v2.21.0

[2.21.0Search Core](https://docs.mapbox.com/ios/search/api/core/2.21.0/)[2.21.0Search UI](https://docs.mapbox.com/ios/search/api/ui/2.21.0/)

v2.20.3

[2.20.3Search Core](https://docs.mapbox.com/ios/search/api/core/2.20.3/)[2.20.3Search UI](https://docs.mapbox.com/ios/search/api/ui/2.20.3/)

v2.20.2

[2.20.2Search Core](https://docs.mapbox.com/ios/search/api/core/2.20.2/)[2.20.2Search UI](https://docs.mapbox.com/ios/search/api/ui/2.20.2/)

v2.20.1

[2.20.1Search Core](https://docs.mapbox.com/ios/search/api/core/2.20.1/)[2.20.1Search UI](https://docs.mapbox.com/ios/search/api/ui/2.20.1/)

v2.20.0

[2.20.0Search Core](https://docs.mapbox.com/ios/search/api/core/2.20.0/)[2.20.0Search UI](https://docs.mapbox.com/ios/search/api/ui/2.20.0/)

v2.19.6

[2.19.6Search Core](https://docs.mapbox.com/ios/search/api/core/2.19.6/)[2.19.6Search UI](https://docs.mapbox.com/ios/search/api/ui/2.19.6/)

v2.19.5

[2.19.5Search Core](https://docs.mapbox.com/ios/search/api/core/2.19.5/)[2.19.5Search UI](https://docs.mapbox.com/ios/search/api/ui/2.19.5/)

v2.19.4

[2.19.4Search Core](https://docs.mapbox.com/ios/search/api/core/2.19.4/)[2.19.4Search UI](https://docs.mapbox.com/ios/search/api/ui/2.19.4/)

v2.19.3

[2.19.3Search Core](https://docs.mapbox.com/ios/search/api/core/2.19.3/)[2.19.3Search UI](https://docs.mapbox.com/ios/search/api/ui/2.19.3/)

v2.19.2

[2.19.2Search Core](https://docs.mapbox.com/ios/search/api/core/2.19.2/)[2.19.2Search UI](https://docs.mapbox.com/ios/search/api/ui/2.19.2/)

v2.19.1

[2.19.1Search Core](https://docs.mapbox.com/ios/search/api/core/2.19.1/)[2.19.1Search UI](https://docs.mapbox.com/ios/search/api/ui/2.19.1/)

v2.19.0

[2.19.0Search Core](https://docs.mapbox.com/ios/search/api/core/2.19.0/)[2.19.0Search UI](https://docs.mapbox.com/ios/search/api/ui/2.19.0/)

v2.18.3

[2.18.3Search Core](https://docs.mapbox.com/ios/search/api/core/2.18.3/)[2.18.3Search UI](https://docs.mapbox.com/ios/search/api/ui/2.18.3/)

v2.18.2

[2.18.2Search Core](https://docs.mapbox.com/ios/search/api/core/2.18.2/)[2.18.2Search UI](https://docs.mapbox.com/ios/search/api/ui/2.18.2/)

v2.18.1

[2.18.1Search Core](https://docs.mapbox.com/ios/search/api/core/2.18.1/)[2.18.1Search UI](https://docs.mapbox.com/ios/search/api/ui/2.18.1/)

v2.18.0

[2.18.0Search Core](https://docs.mapbox.com/ios/search/api/core/2.18.0/)[2.18.0Search UI](https://docs.mapbox.com/ios/search/api/ui/2.18.0/)

v2.17.0

[2.17.0Search Core](https://docs.mapbox.com/ios/search/api/core/2.17.0/)[2.17.0Search UI](https://docs.mapbox.com/ios/search/api/ui/2.17.0/)

v2.16.1

[2.16.1Search Core](https://docs.mapbox.com/ios/search/api/core/2.16.1/)[2.16.1Search UI](https://docs.mapbox.com/ios/search/api/ui/2.16.1/)

v2.16.0

[2.16.0Search Core](https://docs.mapbox.com/ios/search/api/core/2.16.0/)[2.16.0Search UI](https://docs.mapbox.com/ios/search/api/ui/2.16.0/)

v2.15.1

[2.15.1Search Core](https://docs.mapbox.com/ios/search/api/core/2.15.1/)[2.15.1Search UI](https://docs.mapbox.com/ios/search/api/ui/2.15.1/)

v2.15.0

[2.15.0Search Core](https://docs.mapbox.com/ios/search/api/core/2.15.0/)[2.15.0Search UI](https://docs.mapbox.com/ios/search/api/ui/2.15.0/)

v2.14.4

[2.14.4Search Core](https://docs.mapbox.com/ios/search/api/core/2.14.4/)[2.14.4Search UI](https://docs.mapbox.com/ios/search/api/ui/2.14.4/)

v2.14.3

[2.14.3Search Core](https://docs.mapbox.com/ios/search/api/core/2.14.3/)[2.14.3Search UI](https://docs.mapbox.com/ios/search/api/ui/2.14.3/)

v2.14.2

[2.14.2Search Core](https://docs.mapbox.com/ios/search/api/core/2.14.2/)[2.14.2Search UI](https://docs.mapbox.com/ios/search/api/ui/2.14.2/)

v2.14.1

[2.14.1Search Core](https://docs.mapbox.com/ios/search/api/core/2.14.1/)[2.14.1Search UI](https://docs.mapbox.com/ios/search/api/ui/2.14.1/)

v2.14.0

[2.14.0Search Core](https://docs.mapbox.com/ios/search/api/core/2.14.0/)[2.14.0Search UI](https://docs.mapbox.com/ios/search/api/ui/2.14.0/)

v2.13.5

[2.13.5Search Core](https://docs.mapbox.com/ios/search/api/core/2.13.5/)[2.13.5Search UI](https://docs.mapbox.com/ios/search/api/ui/2.13.5/)

v2.13.4

[2.13.4Search Core](https://docs.mapbox.com/ios/search/api/core/2.13.4/)[2.13.4Search UI](https://docs.mapbox.com/ios/search/api/ui/2.13.4/)

v2.13.3

[2.13.3Search Core](https://docs.mapbox.com/ios/search/api/core/2.13.3/)[2.13.3Search UI](https://docs.mapbox.com/ios/search/api/ui/2.13.3/)

v2.13.2

[2.13.2Search Core](https://docs.mapbox.com/ios/search/api/core/2.13.2/)[2.13.2Search UI](https://docs.mapbox.com/ios/search/api/ui/2.13.2/)

v2.13.1

[2.13.1Search Core](https://docs.mapbox.com/ios/search/api/core/2.13.1/)[2.13.1Search UI](https://docs.mapbox.com/ios/search/api/ui/2.13.1/)

v2.13.0

[2.13.0Search Core](https://docs.mapbox.com/ios/search/api/core/2.13.0/)[2.13.0Search UI](https://docs.mapbox.com/ios/search/api/ui/2.13.0/)

v2.12.3

[2.12.3Search Core](https://docs.mapbox.com/ios/search/api/core/2.12.3/)[2.12.3Search UI](https://docs.mapbox.com/ios/search/api/ui/2.12.3/)

v2.12.2

[2.12.2Search Core](https://docs.mapbox.com/ios/search/api/core/2.12.2/)[2.12.2Search UI](https://docs.mapbox.com/ios/search/api/ui/2.12.2/)

v2.12.1

[2.12.1Search Core](https://docs.mapbox.com/ios/search/api/core/2.12.1/)[2.12.1Search UI](https://docs.mapbox.com/ios/search/api/ui/2.12.1/)

v2.12.0

[2.12.0Search Core](https://docs.mapbox.com/ios/search/api/core/2.12.0/)[2.12.0Search UI](https://docs.mapbox.com/ios/search/api/ui/2.12.0/)

v2.9.2

[2.9.2Search Core](https://docs.mapbox.com/ios/search/api/core/2.9.2/)[2.9.2Search UI](https://docs.mapbox.com/ios/search/api/ui/2.9.2/)

v2.9.1

[2.9.1Search Core](https://docs.mapbox.com/ios/search/api/core/2.9.1/)[2.9.1Search UI](https://docs.mapbox.com/ios/search/api/ui/2.9.1/)

v2.9.0

[2.9.0Search Core](https://docs.mapbox.com/ios/search/api/core/2.9.0/)[2.9.0Search UI](https://docs.mapbox.com/ios/search/api/ui/2.9.0/)

v2.8.2

[2.8.2Search Core](https://docs.mapbox.com/ios/search/api/core/2.8.2/)[2.8.2Search UI](https://docs.mapbox.com/ios/search/api/ui/2.8.2/)

v2.8.1

[2.8.1Search Core](https://docs.mapbox.com/ios/search/api/core/2.8.1/)[2.8.1Search UI](https://docs.mapbox.com/ios/search/api/ui/2.8.1/)

v2.8.0

[2.8.0Search Core](https://docs.mapbox.com/ios/search/api/core/2.8.0/)[2.8.0Search UI](https://docs.mapbox.com/ios/search/api/ui/2.8.0/)

v2.7.2

[2.7.2Search Core](https://docs.mapbox.com/ios/search/api/core/2.7.2/)[2.7.2Search UI](https://docs.mapbox.com/ios/search/api/ui/2.7.2/)

v2.7.1

[2.7.1Search Core](https://docs.mapbox.com/ios/search/api/core/2.7.1/)[2.7.1Search UI](https://docs.mapbox.com/ios/search/api/ui/2.7.1/)

v2.7.0

[2.7.0Search Core](https://docs.mapbox.com/ios/search/api/core/2.7.0/)[2.7.0Search UI](https://docs.mapbox.com/ios/search/api/ui/2.7.0/)

v2.6.1

[2.6.1Search Core](https://docs.mapbox.com/ios/search/api/core/2.6.1/)[2.6.1Search UI](https://docs.mapbox.com/ios/search/api/ui/2.6.1/)

v2.6.0

[2.6.0Search Core](https://docs.mapbox.com/ios/search/api/core/2.6.0/)[2.6.0Search UI](https://docs.mapbox.com/ios/search/api/ui/2.6.0/)

v2.5.1

[2.5.1Search Core](https://docs.mapbox.com/ios/search/api/core/2.5.1/)[2.5.1Search UI](https://docs.mapbox.com/ios/search/api/ui/2.5.1/)

v2.5.0

[2.5.0Search Core](https://docs.mapbox.com/ios/search/api/core/2.5.0/)[2.5.0Search UI](https://docs.mapbox.com/ios/search/api/ui/2.5.0/)

v2.3.0

[2.3.0Search Core](https://docs.mapbox.com/ios/search/api/core/2.3.0/)[2.3.0Search UI](https://docs.mapbox.com/ios/search/api/ui/2.3.0/)

v2.2.2

[2.2.2Search Core](https://docs.mapbox.com/ios/search/api/core/2.2.2/)[2.2.2Search UI](https://docs.mapbox.com/ios/search/api/ui/2.2.2/)

v2.2.1

[2.2.1Search Core](https://docs.mapbox.com/ios/search/api/core/2.2.1/)[2.2.1Search UI](https://docs.mapbox.com/ios/search/api/ui/2.2.1/)

v2.2.0

[2.2.0Search Core](https://docs.mapbox.com/ios/search/api/core/2.2.0/)[2.2.0Search UI](https://docs.mapbox.com/ios/search/api/ui/2.2.0/)

v2.1.1

[2.1.1Search Core](https://docs.mapbox.com/ios/search/api/core/2.1.1/)[2.1.1Search UI](https://docs.mapbox.com/ios/search/api/ui/2.1.1/)

v2.1.0

[2.1.0Search Core](https://docs.mapbox.com/ios/search/api/core/2.1.0/)[2.1.0Search UI](https://docs.mapbox.com/ios/search/api/ui/2.1.0/)

v2.0.3

[2.0.3Search Core](https://docs.mapbox.com/ios/search/api/core/2.0.3/)[2.0.3Search UI](https://docs.mapbox.com/ios/search/api/ui/2.0.3/)

v2.0.2

[2.0.2Search Core](https://docs.mapbox.com/ios/search/api/core/2.0.2/)[2.0.2Search UI](https://docs.mapbox.com/ios/search/api/ui/2.0.2/)

v2.0.1

[2.0.1Search Core](https://docs.mapbox.com/ios/search/api/core/2.0.1/)[2.0.1Search UI](https://docs.mapbox.com/ios/search/api/ui/2.0.1/)

v2.0.0

[2.0.0Search Core](https://docs.mapbox.com/ios/search/api/core/2.0.0/)[2.0.0Search UI](https://docs.mapbox.com/ios/search/api/ui/2.0.0/)

v1.4.1

[1.4.1Search Core](https://docs.mapbox.com/ios/search/api/core/1.4.1/)[1.4.1Search UI](https://docs.mapbox.com/ios/search/api/ui/1.4.1/)

v1.4.0

[1.4.0Search Core](https://docs.mapbox.com/ios/search/api/core/1.4.0/)[1.4.0Search UI](https://docs.mapbox.com/ios/search/api/ui/1.4.0/)

v1.0.3

[1.0.3Search Core](https://docs.mapbox.com/ios/search/api/core/1.0.3/)[1.0.3Search UI](https://docs.mapbox.com/ios/search/api/ui/1.0.3/)

v1.0.2

[1.0.2Search Core](https://docs.mapbox.com/ios/search/api/core/1.0.2/)[1.0.2Search UI](https://docs.mapbox.com/ios/search/api/ui/1.0.2/)

v1.0.1

[1.0.1Search Core](https://docs.mapbox.com/ios/search/api/core/1.0.1/)[1.0.1Search UI](https://docs.mapbox.com/ios/search/api/ui/1.0.1/)

v1.0.0

[1.0.0Search Core](https://docs.mapbox.com/ios/search/api/core/1.0.0/)[1.0.0Search UI](https://docs.mapbox.com/ios/search/api/ui/1.0.0/)