@leopiccionia/numista-sdk / Exports / SearchRequest

Interface: SearchRequest

At least one of the following parameters should be provided: q, issuer, catalogue

Hierarchy

• BaseRequest

• PaginatedRequest

  ↳ SearchRequest

Table of contents

Properties

• catalogue
• category
• count
• issuer
• lang
• number
• page
• q

Properties

catalogue

• Optional catalogue: number

ID of a reference catalogue. If provided, only the types referenced in the given catalogue are returned

---

category

• Optional category: Category

Catalogue category

---

count

• count: number

Results per page

Overrides

PaginatedRequest.count

---

issuer

• Optional issuer: string

Issuer code. If provided, only the types from the given issuer are returned

---

lang

• Optional lang: Language

Language

Overrides

BaseRequest.lang

---

number

• Optional number: string

Number of the searched typed in a reference catalogue. This parameter works only with the other parameter catalogue

---

page

• page: number

Page of results

Overrides

PaginatedRequest.page

---

q

• Optional q: string

Search query