#Install the Ulixee CLI and your Schema(s)

• Step 1:
  • npm install -g @ulixee/cli
• Step 2:
  • ulixee start
    • You’ll be prompted to create a keypair and lockfile. These both need to go into your deployment/project.
• Step 3:
  • Search for schemas at https://ulixee.network (ask for credentials)

#Add the Ulixee Client to your Project

• npm install —save @ulixee/client
  • Run this in your project
  • NOTE: your lockfile and keyfile need to be deployed with your app. Include in your deployment/project

#Start Querying for Data

• Write your queries into your app. Your data type has the available fields to retrieve and the parameters to retrieve data.

  • NOTE: you can also find documentation here: https://ulixee.network (ask for credentials)

• For each query, you will specify a “view of truth”. For example, RestaurantReservations might support opentable.com, reserve.com and a few others.

  • You can explore which views of truth are supported using the cli (“find schemas” menu option)
  • You can also find supported views of truth for a schema on https://ulixee.network (ask for credentials)

• Query formats look a form of GraphQL.

  • The fist parameter to a query is the Schema name (can be found in your ulixee-lock.json file if you forget).
  • Following your lock file are the filter parameters in parentheses. Multiple parameters should be comma separated
  • The fields parameter looks like a graphql set of parameters for ease of use.

  const Ulixee = require('@ulixee/client');
  
       (async function run() {
         try {
           const ulixee = new Ulixee({ lockfile: 'ulixee-lock.json' });
           const request = await ulixee.get('EncyclopediaEntry (name: Blockchain, page: 1)', {
             fields: `
               title
               url
               extract
               contributors {
                 username
               }
             `,
             viewOfTruth: 'wikipedia.com',
             maxTimeInCache: '10s'
           });
  
           console.log(JSON.stringify(request, null, 2));
         } catch (err) {
           console.log(err);
         }
       })();