Words

Base URL:

https://igboapi.com/api/v1/

Get Multiple Words

GET /words

Get words from dictionary

Request Headers

Name	Description	Example
X-API-Header required	Secret API token	`X-API-Header=API_token`

Query Parameters

Name	Description	Example
keyword required	Keyword for querying words	`keyword=ego`
page	Current page of results, the default max number of words on a page is 10	`page=1`
range	A selected range of words to return, the max range is 25	`range=[0, 24]`
strict	Searches strictly for words matching with provided diacritics	`strict=true`
dialects	Includes dialect information in each document	`dialects=true`
examples	Includes examples associated with each document	`examples=true`

Responses

An array of up to 10 word JSON objects.

[
 {
   "definitions": [
     "the likeness of an action or being; manner; how; the way;"
   ],
   "word": "ètù",
   "pronunciation": "https://igbo-api.s3.us-east-2.amazonaws.com/audio-pronunciations/5f90c35e49f7e863e92b7622.mp3",
   "attributes": {
     "isStandardIgbo": true,
     "isAccented": false,
     "isSlang": false,
     "isConstructedTerm": false,
     "isBorrowedTerm": false,
     "isStem": true,
     "isCommon": false
   },
   "relatedTerms": [
     "636464df6ec644341fb395e5"
   ],
   "id": "5f90c35e49f7e863e92b7622",
   "wordClass": "ADV",
   "nsibidi": "虐"
 }
]

Get a Single Word

GET /words/{wordId}

Returns a single word JSON object from the database

Parameters

Name	Description	Example
wordId required	The word Id (string)	`id=1234567890`

Responses

A single word JSON object will be returned.

 {
   "definitions": [
     "the likeness of an action or being; manner; how; the way;"
   ],
   "word": "ètù",
   "pronunciation": "https://igbo-api.s3.us-east-2.amazonaws.com/audio-pronunciations/5f90c35e49f7e863e92b7622.mp3",
   "attributes": {
     "isStandardIgbo": true,
     "isAccented": false,
     "isSlang": false,
     "isConstructedTerm": false,
     "isBorrowedTerm": false,
     "isStem": true,
     "isCommon": false
   },
   "relatedTerms": [
     "636464df6ec644341fb395e5"
   ],
   "id": "5f90c35e49f7e863e92b7622",
   "wordClass": "ADV",
   "nsibidi": "虐"
 }

Response Code

Success:

[JSON Object]

If there are more than 10 words that match the query, you can look at the Content-Range response header to find the total number of matching words.

Getting Started Examples