@lap v0.3
# Machine-readable API spec. Each @endpoint block is one API call.
@api OpenFIGI API
@base https://api.openfigi.com/v3
@version 2.0.0
@auth ApiKey X-OPENFIGI-APIKEY in header
@endpoints 4
@toc mapping(2), search(1), filter(1)

@group mapping
@endpoint POST /mapping
@returns(200)
@errors {400, 401, 405, 406, 415, 429, 500, 503}

@endpoint GET /mapping/values/{key}
@required {key: str(idType/exchCode/micCode/currency/marketSecDes/securityType/securityType2)}
@returns(200) {values: [str]}
@errors {400, 401, 405, 406, 415, 429, 500, 503}

@endgroup

@group search
@endpoint POST /search
@optional {query: str, start: str}
@returns(200)
@errors {400, 401, 405, 406, 415, 429, 500, 503}

@endgroup

@group filter
@endpoint POST /filter
@returns(200)
@errors {400, 401, 405, 406, 415, 429, 500, 503}

@endgroup

@end