Nourishing Pizza Microservice

    node-rets

    0.2.6 • Public • Published

    node-rets

    Known Vulnerabilities Coverage Status Issues

    About

    A node library to connect to Real Estate Transaction Standard (RETS) server. This is highly influenced by the rets-client by sbruno81 but without any native bindings.

    Limitations

    At the current state, this library is unfinished and has support for limited functions (see usage below). Additionally, it currently only uses GET requests to connect to the RETS server. Lastly, I only have a single RETS server to test against, and while the code is fully tested, it is not feature complete and may not work for every RETS server. Any additional test servers are welcome and I will develop to them. Any issues or request should be directed toward the Github Issue Tracking.

    Usage

    Initialize a Client

    const client = RETS.initialize({
      loginUrl: 'http://retsserver.com/login',
      username: 'RETSUsername',
      password: 'R3T5P@SSW0RD',
      version: 'RETS/1.8',
      userAgent: 'node-rets/0.0',
      userAgentPassword: '123456',
      // log level 'error', 'warn', 'info', 'debug'
      logLevel: 'debug',
    });
    

    Metadata

    
    const classesMetadata = await client.metadata('CLASS');
    // Resource from classesMetadata
    const classMetadataProperty = await client.metadata('CLASS', 'Property');
    

    Search

    const query = '(ModificationTimestamp=2020-03-17T01:19:11+)'; // DMQL2 query
    const resourceType = classMetadataProperty.Resource;
    const classType = classMetadataProperty.Objects[0].ClassName;
    const searchProperties = await client.search(resourceType, classType, query, { limit: 1, offset: 1 });
    

    GetObject

    const objectIds = `${searchProperties.Objects[0].ListingKey}:*`;
    const returnLocation = 1;
    const objectData = '*';
    const propertyPhotos = await client.getObject('Property', 'Photo', objectIds, returnLocation, objectData);
    

    Logout

    await client.logout();
    

    Keywords

    Install

    npm i node-rets

    DownloadsWeekly Downloads

    3

    Version

    0.2.6

    License

    MIT

    Unpacked Size

    208 kB

    Total Files

    21

    Last publish

    Collaborators

    • slosarek