Skip to content

RealSavvy/realsavvy-package

Repository files navigation

realsavvy-package

RealSavvy API Package that can be used client or server side

API Docs

https://docs.realsavvy.com/reference

How To Use

Install Package

npm install realsavvy-package

Creating A Client

import { Client as RealSavvyClient } from 'realsavvy-package'

const client = new RealSavvyClient({token: 'jwt.access.token'});

Querying for properties

client.properties.search({filter: {price: {max: 500000}}, page: {size: 8}}).then(response => {
  console.log(response.data)
})

Show a property

client.properties.show({complexId: 'hudson_gateway_association_of_realtors~24542612'}).then(response => {
  console.log(response.data)
})

Get share token for a user

const client = new RealSavvyClient({token: 'jwt.access.tokenForUser'});

client.shareToken

Get Agents For Given Site

client.agents.index({page: {size: 8}}).then(response => {
  console.log(response.data)
})

Show Agent

client.agents.show({id: 48}).then(response => {
  console.log(response.data)
})

How To Developer

  1. Fork the repo and clone it down

  2. Install dependies

npm install
  1. Create your own branch for your changes
git checkout -b your-name/your-feature-or-fix
  1. Make your changes

  2. Run tests

npm test
  1. Get tests green.

  2. Build the package.

npx webpack
  1. Commit your changes to your branch and push to them to your fork.

  2. Request PR

Releases

No releases published

Packages

No packages published