MENU navbar-image

Introduction

This documentation aims to provide all the information you need to work with our API.

Authenticating requests

This API is not authenticated.

Authentication

Register

Example request:
curl --request POST \
    "https://homzen.botble.com/api/v1/register" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"first_name\": \"quos\",
    \"last_name\": \"qui\",
    \"email\": \"[email protected]\",
    \"password\": \"BKWLQRmz2SW:\",
    \"phone\": \"velit\",
    \"password_confirmation\": \"qui\"
}"

const url = new URL(
    "https://homzen.botble.com/api/v1/register"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "first_name": "quos",
    "last_name": "qui",
    "email": "[email protected]",
    "password": "BKWLQRmz2SW:",
    "phone": "velit",
    "password_confirmation": "qui"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
    "error": false,
    "data": null,
    "message": "Registered successfully! We emailed you to verify your account!"
}

Example response (422):


{
    "message": "The given data was invalid.",
    "errors": {
        "first_name": [
            "The first name field is required."
        ],
        "last_name": [
            "The last name field is required."
        ],
        "email": [
            "The email field is required."
        ],
        "password": [
            "The password field is required."
        ]
    }
}

Request      

POST api/v1/register

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

first_name   string   

The name of the user. Example: quos

last_name   string   

The name of the user. Example: qui

email   string   

The email of the user. Example: [email protected]

password   string   

The password of user to create. Example: BKWLQRmz2SW:

phone   string   

The phone of the user. Example: velit

password_confirmation   string   

The password confirmation. Example: qui

Login

Example request:
curl --request POST \
    "https://homzen.botble.com/api/v1/login" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"email\": \"e.g: [email protected]\",
    \"password\": \"[tO.voEjo?*rHMRU\",
    \"login\": \"recusandae\"
}"

const url = new URL(
    "https://homzen.botble.com/api/v1/login"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "email": "e.g: [email protected]",
    "password": "[tO.voEjo?*rHMRU",
    "login": "recusandae"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
    "error": false,
    "data": {
        "token": "1|aF5s7p3xxx1lVL8hkSrPN72m4wPVpTvTs..."
    },
    "message": null
}

Request      

POST api/v1/login

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

email   string   

Must be a valid email address. Example: e.g: [email protected]

password   string   

The password of user to create. Example: [tO.voEjo?*rHMRU

login   string   

The email/phone of the user. Example: recusandae

Forgot password

Send a reset link to the given user.

Example request:
curl --request POST \
    "https://homzen.botble.com/api/v1/password/forgot" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"email\": \"[email protected]\"
}"

const url = new URL(
    "https://homzen.botble.com/api/v1/password/forgot"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "email": "[email protected]"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST api/v1/password/forgot

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

email   string   

The email of the user. Example: [email protected]

Resend email verification

Resend the email verification notification.

Example request:
curl --request POST \
    "https://homzen.botble.com/api/v1/resend-verify-account-email" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"email\": \"[email protected]\"
}"

const url = new URL(
    "https://homzen.botble.com/api/v1/resend-verify-account-email"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "email": "[email protected]"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST api/v1/resend-verify-account-email

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

email   string   

The email of the user. Example: [email protected]

Logout

requires authentication

Example request:
curl --request GET \
    --get "https://homzen.botble.com/api/v1/logout" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://homzen.botble.com/api/v1/logout"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "error": true,
    "data": null,
    "message": "Unauthenticated."
}

Request      

GET api/v1/logout

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Blog

Example request:
curl --request GET \
    --get "https://homzen.botble.com/api/v1/search" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"q\": \"officia\"
}"

const url = new URL(
    "https://homzen.botble.com/api/v1/search"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "q": "officia"
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 59
access-control-allow-origin: *
 

{
    "error": true,
    "data": null,
    "message": "No results found, please try with different keywords."
}

List posts

Example request:
curl --request GET \
    --get "https://homzen.botble.com/api/v1/posts" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://homzen.botble.com/api/v1/posts"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 58
access-control-allow-origin: *
 

{
    "data": [
        {
            "id": 1,
            "name": "Top 10 Tips for First-time Home Buyers",
            "slug": "top-10-tips-for-first-time-home-buyers",
            "description": "THAT'S a good way off, panting, with its wings. 'Serpent!' screamed the Queen. 'Their heads are gone, if it likes.' 'I'd rather not,' the Cat went on, taking first one side and then the Mock Turtle.",
            "image": "https://homzen.botble.com/storage/posts/8.jpg",
            "categories": [
                {
                    "id": 2,
                    "name": "Selling a Home",
                    "slug": "selling-a-home",
                    "url": "https://homzen.botble.com/news/selling-a-home",
                    "description": "Illo ut omnis et quo. Suscipit et ipsam neque excepturi doloremque. Rerum ut quia eum ducimus. Velit aliquid voluptas laborum et suscipit quam nobis qui."
                },
                {
                    "id": 3,
                    "name": "Market Trends",
                    "slug": "market-trends",
                    "url": "https://homzen.botble.com/news/market-trends",
                    "description": "Unde cum tempora eum quidem ut voluptatum. Unde est qui error praesentium sunt. Et dolores id nostrum possimus."
                }
            ],
            "tags": [
                {
                    "id": 2,
                    "name": "Investing",
                    "slug": "investing",
                    "description": ""
                },
                {
                    "id": 4,
                    "name": "DIY",
                    "slug": "diy",
                    "description": ""
                },
                {
                    "id": 5,
                    "name": "Luxury Homes",
                    "slug": "luxury-homes",
                    "description": ""
                }
            ],
            "created_at": "2024-06-17T08:58:12.000000Z",
            "updated_at": "2024-06-17T08:58:12.000000Z"
        },
        {
            "id": 2,
            "name": "How to Stage Your Home for a Quick Sale",
            "slug": "how-to-stage-your-home-for-a-quick-sale",
            "description": "White Rabbit: it was very glad that it felt quite strange at first; but she was losing her temper. 'Are you content now?' said the Caterpillar sternly. 'Explain yourself!' 'I can't go no lower,'.",
            "image": "https://homzen.botble.com/storage/posts/9.jpg",
            "categories": [
                {
                    "id": 2,
                    "name": "Selling a Home",
                    "slug": "selling-a-home",
                    "url": "https://homzen.botble.com/news/selling-a-home",
                    "description": "Illo ut omnis et quo. Suscipit et ipsam neque excepturi doloremque. Rerum ut quia eum ducimus. Velit aliquid voluptas laborum et suscipit quam nobis qui."
                },
                {
                    "id": 5,
                    "name": "Real Estate Investing",
                    "slug": "real-estate-investing",
                    "url": "https://homzen.botble.com/news/real-estate-investing",
                    "description": "Ut qui blanditiis quis alias id enim. Aperiam nesciunt rem sit vitae corrupti. Placeat doloremque aut et. Cumque quos expedita dolor. Qui ad deserunt consequatur necessitatibus."
                }
            ],
            "tags": [
                {
                    "id": 3,
                    "name": "Market Analysis",
                    "slug": "market-analysis",
                    "description": ""
                },
                {
                    "id": 7,
                    "name": "Property Management",
                    "slug": "property-management",
                    "description": ""
                },
                {
                    "id": 8,
                    "name": "Renovation",
                    "slug": "renovation",
                    "description": ""
                }
            ],
            "created_at": "2024-06-17T08:58:12.000000Z",
            "updated_at": "2024-06-17T08:58:12.000000Z"
        },
        {
            "id": 3,
            "name": "Understanding the Current Real Estate Market Trends",
            "slug": "understanding-the-current-real-estate-market-trends",
            "description": "For this must ever be A secret, kept from all the party sat silent for a dunce? Go on!' 'I'm a poor man, your Majesty,' said Two, in a deep sigh, 'I was a good character, But said I could say if I.",
            "image": "https://homzen.botble.com/storage/posts/3.jpg",
            "categories": [
                {
                    "id": 3,
                    "name": "Market Trends",
                    "slug": "market-trends",
                    "url": "https://homzen.botble.com/news/market-trends",
                    "description": "Unde cum tempora eum quidem ut voluptatum. Unde est qui error praesentium sunt. Et dolores id nostrum possimus."
                },
                {
                    "id": 4,
                    "name": "Home Improvement",
                    "slug": "home-improvement",
                    "url": "https://homzen.botble.com/news/home-improvement",
                    "description": "Nesciunt aut ea sed iusto ut enim quo. Placeat porro pariatur earum earum assumenda sit."
                }
            ],
            "tags": [
                {
                    "id": 4,
                    "name": "DIY",
                    "slug": "diy",
                    "description": ""
                },
                {
                    "id": 6,
                    "name": "First-time Buyers",
                    "slug": "first-time-buyers",
                    "description": ""
                },
                {
                    "id": 8,
                    "name": "Renovation",
                    "slug": "renovation",
                    "description": ""
                }
            ],
            "created_at": "2024-06-17T08:58:12.000000Z",
            "updated_at": "2024-06-17T08:58:12.000000Z"
        },
        {
            "id": 4,
            "name": "DIY Home Improvement Projects That Add Value",
            "slug": "diy-home-improvement-projects-that-add-value",
            "description": "VERY much out of the shepherd boy--and the sneeze of the edge of her hedgehog. The hedgehog was engaged in a deep, hollow tone: 'sit down, both of you, and must know better'; and this was the cat.).",
            "image": "https://homzen.botble.com/storage/posts/8.jpg",
            "categories": [
                {
                    "id": 2,
                    "name": "Selling a Home",
                    "slug": "selling-a-home",
                    "url": "https://homzen.botble.com/news/selling-a-home",
                    "description": "Illo ut omnis et quo. Suscipit et ipsam neque excepturi doloremque. Rerum ut quia eum ducimus. Velit aliquid voluptas laborum et suscipit quam nobis qui."
                },
                {
                    "id": 5,
                    "name": "Real Estate Investing",
                    "slug": "real-estate-investing",
                    "url": "https://homzen.botble.com/news/real-estate-investing",
                    "description": "Ut qui blanditiis quis alias id enim. Aperiam nesciunt rem sit vitae corrupti. Placeat doloremque aut et. Cumque quos expedita dolor. Qui ad deserunt consequatur necessitatibus."
                }
            ],
            "tags": [
                {
                    "id": 6,
                    "name": "First-time Buyers",
                    "slug": "first-time-buyers",
                    "description": ""
                },
                {
                    "id": 8,
                    "name": "Renovation",
                    "slug": "renovation",
                    "description": ""
                }
            ],
            "created_at": "2024-06-17T08:58:12.000000Z",
            "updated_at": "2024-06-17T08:58:12.000000Z"
        },
        {
            "id": 5,
            "name": "A Beginner’s Guide to Real Estate Investing",
            "slug": "a-beginners-guide-to-real-estate-investing",
            "description": "No, there were TWO little shrieks, and more sounds of broken glass, from which she found herself lying on the glass table as before, 'and things are \"much of a dance is it?' The Gryphon lifted up.",
            "image": "https://homzen.botble.com/storage/posts/5.jpg",
            "categories": [
                {
                    "id": 4,
                    "name": "Home Improvement",
                    "slug": "home-improvement",
                    "url": "https://homzen.botble.com/news/home-improvement",
                    "description": "Nesciunt aut ea sed iusto ut enim quo. Placeat porro pariatur earum earum assumenda sit."
                },
                {
                    "id": 6,
                    "name": "Neighborhood Guides",
                    "slug": "neighborhood-guides",
                    "url": "https://homzen.botble.com/news/neighborhood-guides",
                    "description": "Tenetur nobis minus cumque consectetur et alias. Voluptatum libero quis quia."
                }
            ],
            "tags": [
                {
                    "id": 2,
                    "name": "Investing",
                    "slug": "investing",
                    "description": ""
                },
                {
                    "id": 5,
                    "name": "Luxury Homes",
                    "slug": "luxury-homes",
                    "description": ""
                }
            ],
            "created_at": "2024-06-17T08:58:12.000000Z",
            "updated_at": "2024-06-17T08:58:12.000000Z"
        },
        {
            "id": 6,
            "name": "How to Choose the Right Neighborhood for Your Family",
            "slug": "how-to-choose-the-right-neighborhood-for-your-family",
            "description": "BEST butter, you know.' 'Not at all,' said the others. 'Are their heads downward! The Antipathies, I think--' (she was so small as this before, never! And I declare it's too bad, that it might not.",
            "image": "https://homzen.botble.com/storage/posts/6.jpg",
            "categories": [
                {
                    "id": 4,
                    "name": "Home Improvement",
                    "slug": "home-improvement",
                    "url": "https://homzen.botble.com/news/home-improvement",
                    "description": "Nesciunt aut ea sed iusto ut enim quo. Placeat porro pariatur earum earum assumenda sit."
                },
                {
                    "id": 6,
                    "name": "Neighborhood Guides",
                    "slug": "neighborhood-guides",
                    "url": "https://homzen.botble.com/news/neighborhood-guides",
                    "description": "Tenetur nobis minus cumque consectetur et alias. Voluptatum libero quis quia."
                }
            ],
            "tags": [
                {
                    "id": 1,
                    "name": "Tips",
                    "slug": "tips",
                    "description": ""
                },
                {
                    "id": 2,
                    "name": "Investing",
                    "slug": "investing",
                    "description": ""
                },
                {
                    "id": 8,
                    "name": "Renovation",
                    "slug": "renovation",
                    "description": ""
                }
            ],
            "created_at": "2024-06-17T08:58:12.000000Z",
            "updated_at": "2024-06-17T08:58:12.000000Z"
        },
        {
            "id": 7,
            "name": "Luxury Homes: What to Look For",
            "slug": "luxury-homes-what-to-look-for",
            "description": "Cheshire Cat sitting on the breeze that followed them, the melancholy words:-- 'Soo--oop of the well, and noticed that they were gardeners, or soldiers, or courtiers, or three of her going, though.",
            "image": "https://homzen.botble.com/storage/posts/6.jpg",
            "categories": [
                {
                    "id": 3,
                    "name": "Market Trends",
                    "slug": "market-trends",
                    "url": "https://homzen.botble.com/news/market-trends",
                    "description": "Unde cum tempora eum quidem ut voluptatum. Unde est qui error praesentium sunt. Et dolores id nostrum possimus."
                },
                {
                    "id": 4,
                    "name": "Home Improvement",
                    "slug": "home-improvement",
                    "url": "https://homzen.botble.com/news/home-improvement",
                    "description": "Nesciunt aut ea sed iusto ut enim quo. Placeat porro pariatur earum earum assumenda sit."
                }
            ],
            "tags": [
                {
                    "id": 4,
                    "name": "DIY",
                    "slug": "diy",
                    "description": ""
                },
                {
                    "id": 7,
                    "name": "Property Management",
                    "slug": "property-management",
                    "description": ""
                },
                {
                    "id": 8,
                    "name": "Renovation",
                    "slug": "renovation",
                    "description": ""
                }
            ],
            "created_at": "2024-06-17T08:58:12.000000Z",
            "updated_at": "2024-06-17T08:58:12.000000Z"
        },
        {
            "id": 8,
            "name": "Property Management: Best Practices for Landlords",
            "slug": "property-management-best-practices-for-landlords",
            "description": "Oh dear! I shall fall right THROUGH the earth! How funny it'll seem, sending presents to one's own feet! And how odd the directions will look! ALICE'S RIGHT FOOT, ESQ. HEARTHRUG, NEAR THE FENDER.",
            "image": "https://homzen.botble.com/storage/posts/4.jpg",
            "categories": [
                {
                    "id": 1,
                    "name": "Buying a Home",
                    "slug": "buying-a-home",
                    "url": "https://homzen.botble.com/news/buying-a-home",
                    "description": "Perspiciatis sed sit esse necessitatibus consequatur. Repudiandae sunt pariatur vitae rem. Sed sed incidunt rerum."
                },
                {
                    "id": 6,
                    "name": "Neighborhood Guides",
                    "slug": "neighborhood-guides",
                    "url": "https://homzen.botble.com/news/neighborhood-guides",
                    "description": "Tenetur nobis minus cumque consectetur et alias. Voluptatum libero quis quia."
                }
            ],
            "tags": [
                {
                    "id": 6,
                    "name": "First-time Buyers",
                    "slug": "first-time-buyers",
                    "description": ""
                },
                {
                    "id": 7,
                    "name": "Property Management",
                    "slug": "property-management",
                    "description": ""
                },
                {
                    "id": 8,
                    "name": "Renovation",
                    "slug": "renovation",
                    "description": ""
                }
            ],
            "created_at": "2024-06-17T08:58:12.000000Z",
            "updated_at": "2024-06-17T08:58:12.000000Z"
        },
        {
            "id": 9,
            "name": "Renovation Ideas to Increase Your Home’s Value",
            "slug": "renovation-ideas-to-increase-your-homes-value",
            "description": "The Antipathies, I think--' (she was obliged to say 'creatures,' you see, Miss, this here ought to eat or drink under the door; so either way I'll get into that lovely garden. I think you'd better.",
            "image": "https://homzen.botble.com/storage/posts/7.jpg",
            "categories": [
                {
                    "id": 2,
                    "name": "Selling a Home",
                    "slug": "selling-a-home",
                    "url": "https://homzen.botble.com/news/selling-a-home",
                    "description": "Illo ut omnis et quo. Suscipit et ipsam neque excepturi doloremque. Rerum ut quia eum ducimus. Velit aliquid voluptas laborum et suscipit quam nobis qui."
                },
                {
                    "id": 4,
                    "name": "Home Improvement",
                    "slug": "home-improvement",
                    "url": "https://homzen.botble.com/news/home-improvement",
                    "description": "Nesciunt aut ea sed iusto ut enim quo. Placeat porro pariatur earum earum assumenda sit."
                }
            ],
            "tags": [
                {
                    "id": 1,
                    "name": "Tips",
                    "slug": "tips",
                    "description": ""
                },
                {
                    "id": 7,
                    "name": "Property Management",
                    "slug": "property-management",
                    "description": ""
                }
            ],
            "created_at": "2024-06-17T08:58:12.000000Z",
            "updated_at": "2024-06-17T08:58:12.000000Z"
        },
        {
            "id": 10,
            "name": "The Ultimate Guide to Buying a Vacation Home",
            "slug": "the-ultimate-guide-to-buying-a-vacation-home",
            "description": "Do cats eat bats, I wonder?' Alice guessed in a sulky tone; 'Seven jogged my elbow.' On which Seven looked up eagerly, half hoping that they would call after her: the last concert!' on which the.",
            "image": "https://homzen.botble.com/storage/posts/3.jpg",
            "categories": [
                {
                    "id": 1,
                    "name": "Buying a Home",
                    "slug": "buying-a-home",
                    "url": "https://homzen.botble.com/news/buying-a-home",
                    "description": "Perspiciatis sed sit esse necessitatibus consequatur. Repudiandae sunt pariatur vitae rem. Sed sed incidunt rerum."
                },
                {
                    "id": 2,
                    "name": "Selling a Home",
                    "slug": "selling-a-home",
                    "url": "https://homzen.botble.com/news/selling-a-home",
                    "description": "Illo ut omnis et quo. Suscipit et ipsam neque excepturi doloremque. Rerum ut quia eum ducimus. Velit aliquid voluptas laborum et suscipit quam nobis qui."
                }
            ],
            "tags": [
                {
                    "id": 4,
                    "name": "DIY",
                    "slug": "diy",
                    "description": ""
                },
                {
                    "id": 7,
                    "name": "Property Management",
                    "slug": "property-management",
                    "description": ""
                }
            ],
            "created_at": "2024-06-17T08:58:12.000000Z",
            "updated_at": "2024-06-17T08:58:12.000000Z"
        }
    ],
    "links": {
        "first": "https://homzen.botble.com/api/v1/posts?page=1",
        "last": "https://homzen.botble.com/api/v1/posts?page=2",
        "prev": null,
        "next": "https://homzen.botble.com/api/v1/posts?page=2"
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 2,
        "links": [
            {
                "url": null,
                "label": "« Previous",
                "active": false
            },
            {
                "url": "https://homzen.botble.com/api/v1/posts?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": "https://homzen.botble.com/api/v1/posts?page=2",
                "label": "2",
                "active": false
            },
            {
                "url": "https://homzen.botble.com/api/v1/posts?page=2",
                "label": "Next »",
                "active": false
            }
        ],
        "path": "https://homzen.botble.com/api/v1/posts",
        "per_page": 10,
        "to": 10,
        "total": 18
    },
    "error": false,
    "message": null
}

Request      

GET api/v1/posts

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

List categories

Example request:
curl --request GET \
    --get "https://homzen.botble.com/api/v1/categories" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://homzen.botble.com/api/v1/categories"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 57
access-control-allow-origin: *
 

{
    "data": [
        {
            "id": 1,
            "name": "Buying a Home",
            "slug": "buying-a-home",
            "description": "Perspiciatis sed sit esse necessitatibus consequatur. Repudiandae sunt pariatur vitae rem. Sed sed incidunt rerum.",
            "children": [],
            "parent": {
                "id": null,
                "name": "",
                "slug": "",
                "url": "https://homzen.botble.com",
                "description": ""
            }
        },
        {
            "id": 2,
            "name": "Selling a Home",
            "slug": "selling-a-home",
            "description": "Illo ut omnis et quo. Suscipit et ipsam neque excepturi doloremque. Rerum ut quia eum ducimus. Velit aliquid voluptas laborum et suscipit quam nobis qui.",
            "children": [],
            "parent": {
                "id": null,
                "name": "",
                "slug": "",
                "url": "https://homzen.botble.com",
                "description": ""
            }
        },
        {
            "id": 3,
            "name": "Market Trends",
            "slug": "market-trends",
            "description": "Unde cum tempora eum quidem ut voluptatum. Unde est qui error praesentium sunt. Et dolores id nostrum possimus.",
            "children": [],
            "parent": {
                "id": null,
                "name": "",
                "slug": "",
                "url": "https://homzen.botble.com",
                "description": ""
            }
        },
        {
            "id": 4,
            "name": "Home Improvement",
            "slug": "home-improvement",
            "description": "Nesciunt aut ea sed iusto ut enim quo. Placeat porro pariatur earum earum assumenda sit.",
            "children": [],
            "parent": {
                "id": null,
                "name": "",
                "slug": "",
                "url": "https://homzen.botble.com",
                "description": ""
            }
        },
        {
            "id": 5,
            "name": "Real Estate Investing",
            "slug": "real-estate-investing",
            "description": "Ut qui blanditiis quis alias id enim. Aperiam nesciunt rem sit vitae corrupti. Placeat doloremque aut et. Cumque quos expedita dolor. Qui ad deserunt consequatur necessitatibus.",
            "children": [],
            "parent": {
                "id": null,
                "name": "",
                "slug": "",
                "url": "https://homzen.botble.com",
                "description": ""
            }
        },
        {
            "id": 6,
            "name": "Neighborhood Guides",
            "slug": "neighborhood-guides",
            "description": "Tenetur nobis minus cumque consectetur et alias. Voluptatum libero quis quia.",
            "children": [],
            "parent": {
                "id": null,
                "name": "",
                "slug": "",
                "url": "https://homzen.botble.com",
                "description": ""
            }
        }
    ],
    "links": {
        "first": "https://homzen.botble.com/api/v1/categories?page=1",
        "last": "https://homzen.botble.com/api/v1/categories?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "« Previous",
                "active": false
            },
            {
                "url": "https://homzen.botble.com/api/v1/categories?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "Next »",
                "active": false
            }
        ],
        "path": "https://homzen.botble.com/api/v1/categories",
        "per_page": 10,
        "to": 6,
        "total": 6
    },
    "error": false,
    "message": null
}

Request      

GET api/v1/categories

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

List tags

Example request:
curl --request GET \
    --get "https://homzen.botble.com/api/v1/tags" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://homzen.botble.com/api/v1/tags"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 56
access-control-allow-origin: *
 

{
    "data": [
        {
            "id": 1,
            "name": "Tips",
            "slug": "tips",
            "description": ""
        },
        {
            "id": 2,
            "name": "Investing",
            "slug": "investing",
            "description": ""
        },
        {
            "id": 3,
            "name": "Market Analysis",
            "slug": "market-analysis",
            "description": ""
        },
        {
            "id": 4,
            "name": "DIY",
            "slug": "diy",
            "description": ""
        },
        {
            "id": 5,
            "name": "Luxury Homes",
            "slug": "luxury-homes",
            "description": ""
        },
        {
            "id": 6,
            "name": "First-time Buyers",
            "slug": "first-time-buyers",
            "description": ""
        },
        {
            "id": 7,
            "name": "Property Management",
            "slug": "property-management",
            "description": ""
        },
        {
            "id": 8,
            "name": "Renovation",
            "slug": "renovation",
            "description": ""
        }
    ],
    "links": {
        "first": "https://homzen.botble.com/api/v1/tags?page=1",
        "last": "https://homzen.botble.com/api/v1/tags?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "« Previous",
                "active": false
            },
            {
                "url": "https://homzen.botble.com/api/v1/tags?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "Next »",
                "active": false
            }
        ],
        "path": "https://homzen.botble.com/api/v1/tags",
        "per_page": 10,
        "to": 8,
        "total": 8
    },
    "error": false,
    "message": null
}

Request      

GET api/v1/tags

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Filters posts

Example request:
curl --request GET \
    --get "https://homzen.botble.com/api/v1/posts/filters?page=20&per_page=5&search=tenetur&after=at&author=in&author_exclude=voluptatibus&before=architecto&exclude=tempore&include=earum&order=voluptates&order_by=dolore&categories=quae&categories_exclude=architecto&tags=voluptas&tags_exclude=consectetur&featured=velit" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://homzen.botble.com/api/v1/posts/filters"
);

const params = {
    "page": "20",
    "per_page": "5",
    "search": "tenetur",
    "after": "at",
    "author": "in",
    "author_exclude": "voluptatibus",
    "before": "architecto",
    "exclude": "tempore",
    "include": "earum",
    "order": "voluptates",
    "order_by": "dolore",
    "categories": "quae",
    "categories_exclude": "architecto",
    "tags": "voluptas",
    "tags_exclude": "consectetur",
    "featured": "velit",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 55
access-control-allow-origin: *
 

{
    "data": [],
    "links": {
        "first": "https://homzen.botble.com/api/v1/posts/filters?page=1",
        "last": "https://homzen.botble.com/api/v1/posts/filters?page=1",
        "prev": "https://homzen.botble.com/api/v1/posts/filters?page=19",
        "next": null
    },
    "meta": {
        "current_page": 20,
        "from": null,
        "last_page": 1,
        "links": [
            {
                "url": "https://homzen.botble.com/api/v1/posts/filters?page=19",
                "label": "« Previous",
                "active": false
            },
            {
                "url": "https://homzen.botble.com/api/v1/posts/filters?page=1",
                "label": "1",
                "active": false
            },
            {
                "url": null,
                "label": "Next »",
                "active": false
            }
        ],
        "path": "https://homzen.botble.com/api/v1/posts/filters",
        "per_page": 5,
        "to": null,
        "total": 0
    },
    "error": false,
    "message": null
}

Request      

GET api/v1/posts/filters

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Query Parameters

page   integer  optional  

Current page of the collection. Default: 1 Example: 20

per_page   integer  optional  

Maximum number of items to be returned in result set.Default: 10 Example: 5

search   string  optional  

Limit results to those matching a string. Example: tenetur

after   string  optional  

Limit response to posts published after a given ISO8601 compliant date. Example: at

author   string  optional  

Limit result set to posts assigned to specific authors. Example: in

author_exclude   string  optional  

Ensure result set excludes posts assigned to specific authors. Example: voluptatibus

before   string  optional  

Limit response to posts published before a given ISO8601 compliant date. Example: architecto

exclude   string  optional  

Ensure result set excludes specific IDs. Example: tempore

include   string  optional  

Limit result set to specific IDs. Example: earum

order   string  optional  

Order sort attribute ascending or descending. Default: desc .One of: asc, desc Example: voluptates

order_by   string  optional  

Sort collection by object attribute. Default: updated_at. One of: author, created_at, updated_at, id, slug, title Example: dolore

categories   string  optional  

Limit result set to all items that have the specified term assigned in the categories taxonomy. Example: quae

categories_exclude   string  optional  

Limit result set to all items except those that have the specified term assigned in the categories taxonomy. Example: architecto

tags   string  optional  

Limit result set to all items that have the specified term assigned in the tags taxonomy. Example: voluptas

tags_exclude   string  optional  

Limit result set to all items except those that have the specified term assigned in the tags taxonomy. Example: consectetur

featured   string  optional  

Limit result set to items that are sticky. Example: velit

Get post by slug

Example request:
curl --request GET \
    --get "https://homzen.botble.com/api/v1/posts/dolor?slug=qui" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://homzen.botble.com/api/v1/posts/dolor"
);

const params = {
    "slug": "qui",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (404):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 54
access-control-allow-origin: *
 

{
    "error": true,
    "data": null,
    "message": "Not found"
}

Request      

GET api/v1/posts/{slug}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

slug   string   

The slug of the post. Example: dolor

Query Parameters

slug   string  optional  

Find by slug of post. Example: qui

Filters categories

Example request:
curl --request GET \
    --get "https://homzen.botble.com/api/v1/categories/filters" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://homzen.botble.com/api/v1/categories/filters"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 53
access-control-allow-origin: *
 

{
    "data": [
        {
            "id": 2,
            "name": "Selling a Home",
            "slug": "selling-a-home",
            "url": "https://homzen.botble.com/news/selling-a-home",
            "description": "Illo ut omnis et quo. Suscipit et ipsam neque excepturi doloremque. Rerum ut quia eum ducimus. Velit aliquid voluptas laborum et suscipit quam nobis qui."
        },
        {
            "id": 5,
            "name": "Real Estate Investing",
            "slug": "real-estate-investing",
            "url": "https://homzen.botble.com/news/real-estate-investing",
            "description": "Ut qui blanditiis quis alias id enim. Aperiam nesciunt rem sit vitae corrupti. Placeat doloremque aut et. Cumque quos expedita dolor. Qui ad deserunt consequatur necessitatibus."
        },
        {
            "id": 6,
            "name": "Neighborhood Guides",
            "slug": "neighborhood-guides",
            "url": "https://homzen.botble.com/news/neighborhood-guides",
            "description": "Tenetur nobis minus cumque consectetur et alias. Voluptatum libero quis quia."
        },
        {
            "id": 3,
            "name": "Market Trends",
            "slug": "market-trends",
            "url": "https://homzen.botble.com/news/market-trends",
            "description": "Unde cum tempora eum quidem ut voluptatum. Unde est qui error praesentium sunt. Et dolores id nostrum possimus."
        },
        {
            "id": 4,
            "name": "Home Improvement",
            "slug": "home-improvement",
            "url": "https://homzen.botble.com/news/home-improvement",
            "description": "Nesciunt aut ea sed iusto ut enim quo. Placeat porro pariatur earum earum assumenda sit."
        },
        {
            "id": 1,
            "name": "Buying a Home",
            "slug": "buying-a-home",
            "url": "https://homzen.botble.com/news/buying-a-home",
            "description": "Perspiciatis sed sit esse necessitatibus consequatur. Repudiandae sunt pariatur vitae rem. Sed sed incidunt rerum."
        }
    ],
    "links": {
        "first": "https://homzen.botble.com/api/v1/categories/filters?page=1",
        "last": "https://homzen.botble.com/api/v1/categories/filters?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "« Previous",
                "active": false
            },
            {
                "url": "https://homzen.botble.com/api/v1/categories/filters?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "Next »",
                "active": false
            }
        ],
        "path": "https://homzen.botble.com/api/v1/categories/filters",
        "per_page": 10,
        "to": 6,
        "total": 6
    },
    "error": false,
    "message": null
}

Request      

GET api/v1/categories/filters

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Get category by slug

Example request:
curl --request GET \
    --get "https://homzen.botble.com/api/v1/categories/id?slug=alias" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://homzen.botble.com/api/v1/categories/id"
);

const params = {
    "slug": "alias",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (404):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 52
access-control-allow-origin: *
 

{
    "error": true,
    "data": null,
    "message": "Not found"
}

Request      

GET api/v1/categories/{slug}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

slug   string   

The slug of the category. Example: id

Query Parameters

slug   string  optional  

Find by slug of category. Example: alias

Profile

Get the user profile information.

requires authentication

Example request:
curl --request GET \
    --get "https://homzen.botble.com/api/v1/me" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://homzen.botble.com/api/v1/me"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "error": true,
    "data": null,
    "message": "Unauthenticated."
}

Request      

GET api/v1/me

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Update profile

requires authentication

Example request:
curl --request PUT \
    "https://homzen.botble.com/api/v1/me" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"first_name\": \"quidem\",
    \"last_name\": \"quaerat\",
    \"phone\": \"eos\",
    \"dob\": \"dolor\",
    \"gender\": \"earum\",
    \"description\": \"Ullam beatae minus rerum minus.\",
    \"email\": \"[email protected]\"
}"

const url = new URL(
    "https://homzen.botble.com/api/v1/me"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "first_name": "quidem",
    "last_name": "quaerat",
    "phone": "eos",
    "dob": "dolor",
    "gender": "earum",
    "description": "Ullam beatae minus rerum minus.",
    "email": "[email protected]"
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

PUT api/v1/me

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

first_name   string   

First name. Example: quidem

last_name   string   

Last name. Example: quaerat

phone   string   

Phone. Example: eos

dob   string   

Date of birth. Example: dolor

gender   string  optional  

Gender Example: earum

description   string  optional  

Description Example: Ullam beatae minus rerum minus.

email   string  optional  

Email. Example: [email protected]

Update Avatar

requires authentication

Example request:
curl --request POST \
    "https://homzen.botble.com/api/v1/update/avatar" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "avatar=@/tmp/phpShWNv3" 
const url = new URL(
    "https://homzen.botble.com/api/v1/update/avatar"
);

const headers = {
    "Content-Type": "multipart/form-data",
    "Accept": "application/json",
};

const body = new FormData();
body.append('avatar', document.querySelector('input[name="avatar"]').files[0]);

fetch(url, {
    method: "POST",
    headers,
    body,
}).then(response => response.json());

Request      

POST api/v1/update/avatar

Headers

Content-Type      

Example: multipart/form-data

Accept      

Example: application/json

Body Parameters

avatar   file   

Avatar file. Example: /tmp/phpShWNv3

Update password

requires authentication

Example request:
curl --request PUT \
    "https://homzen.botble.com/api/v1/update/password" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"password\": \"NW~E$&I-$m.]\'B}*Y\"
}"

const url = new URL(
    "https://homzen.botble.com/api/v1/update/password"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "password": "NW~E$&I-$m.]'B}*Y"
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

PUT api/v1/update/password

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

password   string   

The new password of user. Example: NW~E$&I-$m.]'B}*Y