API

Access API

Access to the Names Day API requires an Authorization token to be supplied, via the authorization header, in all request sent to the endpoint.

The content type of requests must be application/json and the response will also be in the json format.

POST https://namesday.au/api/v1/names Copied

This will return a list of names for the given date supplied in the request.

Field	Type	Description
date *	string	The date in the format YYYY-MM-DD e.g. "2024-06-30"
OR
day	string\|integer	The numerical day of the month i.e. 1-31
month	string\|integer	The numerical month of the year i.e. 1-12

* When the "date" field is provided it takes precednce over any other fields

{"date" : "2024-06-30"}

{"day" : 20, "month": 8}

Field	Type	Description	Status
status	string	Request outcome `success` or 'fail'	success\|fail
data	object	The numerical day of the month i.e. 1-31	success\|fail
databody	object	The fields sent in the request body	success\|fail
datanames	string[]	The names for the requested day	success
dataerror	string	Type of failure e.g. 'Authorisation Error' , 'Unsupported Format'	fail
datamessage	string	Specific message providing more details about the cause of the failure	fail