HomePricingNews Log in
  • PARAMETERS
    • API parameters
      All API calls use GET. Choose a query type with t, then provide either a username with q or a job ID with id.
      Request parameters
      t Query type
      Always required.
      u, t, a or n
      q Username
      Required for
      t=u, t=a, t=n
      id Job ID
      Required for
      t=t
      u User profile
      api.php?t=u&q=USERNAME
      Profile fields
      Field
      Description
      id
      Unique user ID
      username
      Username
      first_name
      First name
      last_name
      Last name
      website
      Website URL
      description
      Profile description
      image
      Profile avatar URL
      facebook
      Facebook profile URL
      x
      X.com profile URL
      instagram
      Instagram profile URL
      youtube
      YouTube profile URL
      vimeo
      Vimeo profile URL
      linkedin
      LinkedIn profile URL
      t Job
      api.php?t=t&id=JOB_ID
      18 fields
      Field
      Description
      id
      Unique job ID
      title
      Job title
      description
      Job description
      engine
      Current render engine
      extension
      Output file extension
      tag
      Tag list
      size
      Job file size
      start_frame
      Start frame number
      end_frame
      End frame number
      total_frames
      Total number of frames
      width
      Frame width
      height
      Frame height
      license
      License type
      time
      Date and time when the job was published
      status
      Job status
      priority
      Job priority
      views
      Number of views
      downloads
      Number of downloads
      a All jobs
      api.php?t=a&q=USERNAME
      Up to 100 jobs
      Returns an object containing the requested user and a jobs array. Each item in jobs uses the same job fields documented in t — Job.
      Field
      Description
      username
      Requested username
      uid
      User ID
      jobs
      Array containing up to 100 job objects
      n Nodes
      api.php?t=n&q=USERNAME
      Up to 100 nodes
      Returns an object containing the requested user and a nodes array.
      Field
      Description
      username
      Requested username
      uid
      User ID
      nodes
      Array containing up to 100 node objects
      Node object fields
      id
      Unique node ID
      hostname
      Node hostname (machine name)
      ip
      Current IP address
      status
      Current node status
      registered_at
      Date and time when the node was registered
      last_seen_at
      Date and time when the node was last seen online
      Successful responses contain apiVersion and data. Endpoint-specific values are returned inside data.
  • EXAMPLE GET USER INFO
    • For profile information of a user:
      https://pixomea.com/api.php?t=u&q=USERNAME

      Sample code PHP:
      // --- API credentials ---
      $app_key = 'YOUR API KEY'; // Public key of your application
      $app_secret = 'YOUR API SECRET'; // Private key of your application
      // --- Safe cURL helper function ---
      function api_get($url, $headers = []) {
      $ch = curl_init($url);
      curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
      curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, 5); // 5 sec connection timeout
      curl_setopt($ch, CURLOPT_TIMEOUT, 8); // 8 sec total timeout
      curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
      $result = curl_exec($ch);
      if ($result === false) {
      $err = curl_error($ch);
      die("cURL error: $err\nURL: $url");
      }
      return $result;
      }
      // --- Step 1: Get authentication token ---
      $url_token = "https://pixomea.com/api.php?t=token";
      $json = api_get($url_token, [
      "X-App-Key: $app_key",
      "X-App-Secret: $app_secret"
      ]);
      // Clean the response (in case of unexpected output before JSON)
      if (($pos = strpos($json, '{')) !== false) {
      $json = substr($json, $pos);
      }
      $data = json_decode($json, true);
      // Verify if token exists
      if (empty($data['token'])) {
      die("Error retrieving token: " . ($data['error'] ?? 'Token missing'));
      }
      $token = $data['token']; // Use this token for all further requests
      print_r($data);
      // --- Step 2: Get user info ---
      $username = 'pppppp'; // Replace with the username to test
      $url_user = "https://pixomea.com/api.php?t=u&q=" . urlencode($username);
      $file = api_get($url_user, [
      "X-Token: $token"
      ]);
      // Clean JSON response
      if (($pos = strpos($file, '{')) !== false) {
      $file = substr($file, $pos);
      }
      $user_data = json_decode($file, true);
      print_r($user_data);

  • EXAMPLE GET JOB INFO
    • For information about a job:
      https://pixomea.com/api.php?t=t&id=IDJOB

      Sample code PHP:
      // --- API credentials ---
      $app_key = 'YOUR API KEY';
      $app_secret = 'YOUR API SECRET';
      // --- Safe cURL helper function ---
      function api_get($url, $headers = []) {
      $ch = curl_init($url);
      curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
      curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, 5);
      curl_setopt($ch, CURLOPT_TIMEOUT, 8);
      curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
      $result = curl_exec($ch);
      if ($result === false) {
      $err = curl_error($ch);
      die("cURL error: $err\nURL: $url");
      }
      return $result;
      }
      // --- Step 1: Get authentication token ---
      $url_token = "https://pixomea.com/api.php?t=token";
      $json = api_get($url_token, [
      "X-App-Key: $app_key",
      "X-App-Secret: $app_secret"
      ]);
      if (($pos = strpos($json, '{')) !== false) {
      $json = substr($json, $pos);
      }
      $data = json_decode($json, true);
      if (empty($data['token'])) {
      die("Error retrieving token: " . ($data['error'] ?? 'Token missing'));
      }
      $token = $data['token'];
      print_r($data);
      // --- Step 2: Get info for a specific job ---
      $job_id = '00'; // Replace with the job ID to test
      $url_job = "https://pixomea.com/api.php?t=t&id=" . urlencode($job_id);
      $file = api_get($url_job, [
      "X-Token: $token"
      ]);
      if (($pos = strpos($file, '{')) !== false) {
      $file = substr($file, $pos);
      }
      $job_data = json_decode($file, true);
      print_r($job_data);

  • EXAMPLE GET ALL JOBS OF A USER
    • For information about up to 100 jobs of a user:
      https://pixomea.com/api.php?t=a&q=USERNAME

      Sample code PHP:
      // --- API credentials ---
      $app_key = 'YOUR API KEY';
      $app_secret = 'YOUR API SECRET';
      // --- Safe cURL helper function ---
      function api_get($url, $headers = []) {
      $ch = curl_init($url);
      curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
      curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, 5);
      curl_setopt($ch, CURLOPT_TIMEOUT, 8);
      curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
      $result = curl_exec($ch);
      if ($result === false) {
      $err = curl_error($ch);
      die("cURL error: $err\nURL: $url");
      }
      return $result;
      }
      // --- Step 1: Get authentication token ---
      $url_token = "https://pixomea.com/api.php?t=token";
      $json = api_get($url_token, [
      "X-App-Key: $app_key",
      "X-App-Secret: $app_secret"
      ]);
      if (($pos = strpos($json, '{')) !== false) {
      $json = substr($json, $pos);
      }
      $data = json_decode($json, true);
      if (empty($data['token'])) {
      die("Error retrieving token: " . ($data['error'] ?? 'Token missing'));
      }
      $token = $data['token'];
      print_r($data);
      // --- Step 2: Get all jobs for a user ---
      $user = 'pppppp'; // Replace with username
      $url_jobs = "https://pixomea.com/api.php?t=a&q=" . urlencode($user);
      $file = api_get($url_jobs, [
      "X-Token: $token"
      ]);
      if (($pos = strpos($file, '{')) !== false) {
      $file = substr($file, $pos);
      }
      $jobs_data = json_decode($file, true);
      print_r($jobs_data);

  • EXAMPLE GET ALL NODES OF A USER
    • For information about up to 100 nodes of a user:
      https://pixomea.com/api.php?t=n&q=USERNAME

      Sample code PHP:
      // --- API credentials ---
      $app_key = 'YOUR API KEY';
      $app_secret = 'YOUR API SECRET';
      // --- Safe cURL helper function ---
      function api_get($url, $headers = []) {
      $ch = curl_init($url);
      curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
      curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, 5);
      curl_setopt($ch, CURLOPT_TIMEOUT, 8);
      curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
      $result = curl_exec($ch);
      if ($result === false) {
      $err = curl_error($ch);
      die("cURL error: $err\nURL: $url");
      }
      return $result;
      }
      // --- Step 1: Get authentication token ---
      $url_token = "https://pixomea.com/api.php?t=token";
      $json = api_get($url_token, [
      "X-App-Key: $app_key",
      "X-App-Secret: $app_secret"
      ]);
      if (($pos = strpos($json, '{')) !== false) {
      $json = substr($json, $pos);
      }
      $data = json_decode($json, true);
      if (empty($data['token'])) {
      die("Error retrieving token: " . ($data['error'] ?? 'Token missing'));
      }
      $token = $data['token'];
      print_r($data);
      // --- Step 2: Get all nodes for a user ---
      $user = 'pppppp'; // Replace with username
      $url_nodes = "https://pixomea.com/api.php?t=n&q=" . urlencode($user);
      $file = api_get($url_nodes, [
      "X-Token: $token"
      ]);
      if (($pos = strpos($file, '{')) !== false) {
      $file = substr($file, $pos);
      }
      $nodes_data = json_decode($file, true);
      print_r($nodes_data);