wikiti/!FAB-CLAIM-README.md

## !FAB-CLAIM-README.md

      
    Raw
  

              !FAB-CLAIM-README.md
            
          
    Important
This script was built for educational purposes. Due to how FAB APIs are built to handle search pagination, all assets might not be claimable through this script. With the last script update, a total of ~600 scanned pages, with ~14k assets.
Please note that, by clicking on the "Claim All" quixel button, you'll already have claimed all assets for future free usage, beyond 2024 (official response). This script simply makes sure that assets are added to a library.

Script to add all quixel megascan items to your FAB account

As quixel megascan items will stop being free after 2024. So, this script will go through all Quixel MegaScan items and add them to your account. Quixel would be working on a tool to automatically add all resources to your FAB account, but I couldn't help myself and I wrote a script to do it.
How to use


Copy the contents of the script below (claim.js)
Log in into your fab dashboard
Make sure you have accepted the terms and conditions (e.g. try claiming any free asset)
Go to the Quixel seller list at https://www.fab.com/sellers/Quixel
Open devtools (F12) -> Go to "Console" tab
Paste the script and press enter

Feel free to tweak the constants at the very top of the script to reduce wait times, or to prevent tiemouts or throttlings.
Known issues


The script stopped working after X claims

Try running the script again. Before doing so, take note on the cursor and filter index values, and update the script with those, so you can resume the process at the same point where the script stopped executing. For example, if the script printed this message before stopping execution:
Getting content from page cursor bz0yMDQw, with filter index 1...

Update the top variables to match those values:
async function claimQuixelAssets() {
  // Configurable constants to resume
  const INITIAL_PAGE_CURSOR = "bz0yMDQw";
  const INITIAL_FILTER_INDEX = 1;
  
  // ...

Some claims constantly fail with a 500 error

For some reason, some assets cannot be claimed, not even through the web UI. Add the item IDs to the SKIP_ITEM_IDS constant at the top of the script. The following items were throwing errors when running the script:
3e441085-0d1d-4476-93bc-e68d184026f2
f74671f7-d8a5-42e7-9dd4-e76639ca0ef0

So, I would update the SKIP_ITEM_IDS to be:
const SKIP_ITEM_IDS = [
  '3e441085-0d1d-4476-93bc-e68d184026f2',
  'f74671f7-d8a5-42e7-9dd4-e76639ca0ef0',
];

Script is a bit slow between pages

The script sleeps by default for 5 seconds to prevent request throttling (not sure if there is any to be honest). If you don't want to wait that much, set the value of WAIT_TIME_BETWEEN_PAGES to 0.

Script stops after X pages

For some reason, the search query might stop depending on the sorting key that's used. Or, in some cases, repeat the same page over and over again. I'm currently trying to find a solution to this, but it totally depends on how the server responds to the search queries made by this script.

I'm getting HTTP 401 errors on all claim requests, even if I add them to SKIP_ITEMS_ID

You must accept the terms and conditions first from FAB. For example, try manually adding through the web interface one free item to your library. Then, try running the script.
Changelog


[V1 23/10/24] Initial version
[V2 24/10/24] Changed query parameters for retrieving item list
[V3 25/10/24] Add error detection for cursor loops (around ~210 pages)
[V4 25/10/24] Add multiple search filters for covering as many assets as possible
[V5 26/10/24] Corrected an issue where the last filter (3d models) was not executed
[V6 26/10/24] Add Set check for claimable assets, so they are claimed once, in case filters are repeated
[V7 16/11/24] Rename CSRF cookie to fab_csrftoken

Credits

I wrote the script by myself, but it was heavily inspired by this script, coded by jamiephan. Thanks to all the folks in the comment section who pointed out bugs, and suggested minor improvements!

  
## claim.js
async function claimQuixelAssets() {
  // Configurable constants to resume
  const INITIAL_PAGE_CURSOR = null;
  const INITIAL_FILTER_INDEX = 0;
  const WAIT_TIME_BETWEEN_PAGES = 5; // in seconds
  const WAIT_TIME_BETWEEN_CLAIMS = 0; // in seconds

  // Debugging constants
  const CLEAR_CONSOLE = true;
  const PARALLEL_CLAIM = true;
  const CLAIM = true;

  // Hacky constants to overcome API limitations
  const SKIP_ITEM_IDS = [
    '3e441085-0d1d-4476-93bc-e68d184026f2',
    'f74671f7-d8a5-42e7-9dd4-e76639ca0ef0',
    'd808f867-2560-4476-ad05-a1d999bd940b',
  ]; // A list of strings, in case an item constantly fails to claim due to 500 errors

  const FILTERS = [
    // Environments
    'listing_types=environment',

    // Materials
    'listing_types=material',
    // 'categories=art-traditional&listing_types=material',
    // 'categories=building-human-made&listing_types=material',
    // 'categories=damage-grunge&listing_types=material',
    // 'categories=fabric-clothing&listing_types=material',
    // 'categories=nature-terrain&listing_types=material',
    // 'categories=organic&listing_types=material',

    // Decals
    'listing_types=decal',
    // 'categories=art-traditional&listing_types=decal',
    // 'categories=building-human-made&listing_types=decal',
    // 'categories=damage-grunge&listing_types=decal',
    // 'categories=fabric-clothing&listing_types=decal',
    // 'categories=nature-terrain&listing_types=decal',
    // 'categories=organic&listing_types=decal',

    // Brushes
    'listing_types=brush',
    // 'categories=art-traditional&listing_types=brush',
    // 'categories=building-human-made&listing_types=brush',
    // 'categories=damage-grunge&listing_types=brush',

    // Atlas
    'listing_types=atlas',
    // 'categories=building-human-made&listing_types=atlas',
    // 'categories=damage-grunge&listing_types=atlas',
    // 'categories=nature-terrain&listing_types=atlas',

    // 3D models
    'listing_types=3d-model',
    // 'categories=buildings-architecture&listing_types=3d-model',
    // 'categories=electronics-technology&listing_types=3d-model',
    // 'categories=food-drink&listing_types=3d-model',
    // 'categories=furniture-fixtures&listing_types=3d-model',
    // 'categories=nature-plants&listing_types=3d-model',
    // 'categories=environments-scenes&listing_types=3d-model',
    // 'categories=objects-decor&listing_types=3d-model',

    // ...
  ]

  // Counters
  let totalPages = 0;
  let claimedAssets = new Set();

  // Functions
  const clearConsole = () => {
    if (CLEAR_CONSOLE) {
      console.clear()
    }
    else {
      console.log(`-------------------------------------------------------------------`);
    }
  }

  const sleep = (seconds) => {
    return new Promise(r => setTimeout(r, seconds * 1000));
  }

  const getCSRFToken = () => {
    const cookieName = 'fab_csrftoken';
    return document.cookie.match('(^|;)\\s*' + cookieName + '\\s*=\\s*([^;]+)')?.pop() || '';
  }

  const postResource = async (path, body) => {
    const baseUrl = "https://www.fab.com/i/listings";
    const formData = new FormData();

    for (const name in body) {
      formData.append(name, body[name]);
    }

    const response = await fetch(`${baseUrl}/${path}`, {
      headers: {
        "accept": "application/json, text/plain, */*",
        "x-csrftoken": getCSRFToken(),
      },
      method: "POST",
      body: formData,
    });

    if (!response.ok) {
      throw new Error(`Failed request with ${response.status} status code`);
    }

    return await response.text();
  }

  const getResource = async (path) => {
    const baseUrl = "https://www.fab.com/i/listings";

    const response = await fetch(`${baseUrl}/${path}`, {
      headers: {
        "accept": "application/json, text/plain, */*",
        "x-csrftoken": getCSRFToken(),
      },
      method: "GET",
    });

    if (!response.ok) {
      throw new Error(`Failed request with ${response.status} status code`);
    }

    return await response.json();
  }

  const fetchItem = async (itemId) => {
    try {
      return await getResource(itemId);
    }
    catch (error) {
      throw new Error(`Failed to fetch item ${itemId} due to: ${error}`)
    }
  }

  const claimItem = async (item) => {
    let offer_id = item.licenses.find((license) => license.slug == "professional").offerId;
    // offer_id = item.licenses[0].offerId;

    try {
      await postResource(`${item.uid}/add-to-library`, { offer_id });
    }
    catch (error) {
      throw new Error(`Failed to claim item ${item.title} (${item.uid}) due to: ${error}`)
    }
  }

  const handleItem = async (listItem) => {
    if (SKIP_ITEM_IDS.includes(listItem.uid)) {
      console.log(`-> Skipping ${listItem.title} (id: ${listItem.uid})`);
      return;
    }

    if (claimedAssets.has(listItem.uid)) {
      console.log(`-> Already claimed ${listItem.title} (id: ${listItem.uid})`);
      return;
    }

    console.log(`-> Claiming ${listItem.title} (id: ${listItem.uid})`);

    if (CLAIM) {
      const item = await fetchItem(listItem.uid);
      await claimItem(item);
    }

    claimedAssets.add(listItem.uid);

    await sleep(WAIT_TIME_BETWEEN_CLAIMS);
  }

  const fetchItems = async (filterIndex, pageCursor) => {
    const filters = FILTERS[filterIndex];

    try {
      const cursorQuery = pageCursor ? `&cursor=${pageCursor}` : ''
      return await getResource(`search?seller=Quixel&${filters}${cursorQuery}`);
    }
    catch (error) {
      throw new Error(`Failed to get page ${pageCursor || 'null'} due to: ${error}`);
    }
  }

  const handleListPage = async (filterIndex, pageCursor) => {
    console.log(`-> Getting content from page cursor ${pageCursor || '<not-set>'}, with filter index ${filterIndex}...`);
    let page = await fetchItems(filterIndex, pageCursor);
    console.log(`-> Found ${page.results.length} results on this page`);

    if (PARALLEL_CLAIM) {
      const promises = page.results.map((item) => handleItem(item));
      await Promise.all(promises)
    }
    else {
      for (const item of page.results) {
        await handleItem(item);
      }
    }

    await sleep(WAIT_TIME_BETWEEN_PAGES);
    clearConsole();

    totalPages += 1;

    if (pageCursor != null && pageCursor == page.cursors.next) {
      throw new Error(`Cursor loop found on page ${pageCursor}; this is a problem on FAB's API, not this script`);
    }

    return page.cursors.next
  }

  // Main loop function
  const main = async () => {
    clearConsole();

    try {
      for (let filterIndex = INITIAL_FILTER_INDEX; filterIndex < FILTERS.length; filterIndex += 1) {
        let pageCursor = INITIAL_PAGE_CURSOR;

        do {
          console.log(`-> Pages processed so far: ${totalPages} pages`);
          console.log(`-> Assets claimed so far: ${claimedAssets.size} assets`);

          pageCursor = await handleListPage(filterIndex, pageCursor)
        } while (pageCursor != null);
      }

      console.log('-> Script execution completed successfully!')
      console.log(`-> Total pages processed: ${totalPages} pages`);
      console.log(`-> Total assets claimed: ${claimedAssets.size} assets`);
    }
    catch (error) {
      console.error(`-> ${error.message}`);
      console.error("-> Try waiting for a couple of minutes, then re-running the script by changing INITIAL_FILTER_INDEX and INITIAL_PAGE_CURSOR");
      console.error(error);
    }
  }

  return await main();
}

claimQuixelAssets();

## LICENSE.md

      
    Raw
  

              LICENSE.md
            
          
    Copyright 2024 Daniel herzog
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
	async function claimQuixelAssets() {
	// Configurable constants to resume
	const INITIAL_PAGE_CURSOR = null;
	const INITIAL_FILTER_INDEX = 0;
	const WAIT_TIME_BETWEEN_PAGES = 5; // in seconds
	const WAIT_TIME_BETWEEN_CLAIMS = 0; // in seconds

	// Debugging constants
	const CLEAR_CONSOLE = true;
	const PARALLEL_CLAIM = true;
	const CLAIM = true;

	// Hacky constants to overcome API limitations
	const SKIP_ITEM_IDS = [
	'3e441085-0d1d-4476-93bc-e68d184026f2',
	'f74671f7-d8a5-42e7-9dd4-e76639ca0ef0',
	'd808f867-2560-4476-ad05-a1d999bd940b',
	]; // A list of strings, in case an item constantly fails to claim due to 500 errors

	const FILTERS = [
	// Environments
	'listing_types=environment',

	// Materials
	'listing_types=material',
	// 'categories=art-traditional&listing_types=material',
	// 'categories=building-human-made&listing_types=material',
	// 'categories=damage-grunge&listing_types=material',
	// 'categories=fabric-clothing&listing_types=material',
	// 'categories=nature-terrain&listing_types=material',
	// 'categories=organic&listing_types=material',

	// Decals
	'listing_types=decal',
	// 'categories=art-traditional&listing_types=decal',
	// 'categories=building-human-made&listing_types=decal',
	// 'categories=damage-grunge&listing_types=decal',
	// 'categories=fabric-clothing&listing_types=decal',
	// 'categories=nature-terrain&listing_types=decal',
	// 'categories=organic&listing_types=decal',

	// Brushes
	'listing_types=brush',
	// 'categories=art-traditional&listing_types=brush',
	// 'categories=building-human-made&listing_types=brush',
	// 'categories=damage-grunge&listing_types=brush',

	// Atlas
	'listing_types=atlas',
	// 'categories=building-human-made&listing_types=atlas',
	// 'categories=damage-grunge&listing_types=atlas',
	// 'categories=nature-terrain&listing_types=atlas',

	// 3D models
	'listing_types=3d-model',
	// 'categories=buildings-architecture&listing_types=3d-model',
	// 'categories=electronics-technology&listing_types=3d-model',
	// 'categories=food-drink&listing_types=3d-model',
	// 'categories=furniture-fixtures&listing_types=3d-model',
	// 'categories=nature-plants&listing_types=3d-model',
	// 'categories=environments-scenes&listing_types=3d-model',
	// 'categories=objects-decor&listing_types=3d-model',

	// ...
	]

	// Counters
	let totalPages = 0;
	let claimedAssets = new Set();

	// Functions
	const clearConsole = () => {
	if (CLEAR_CONSOLE) {
	console.clear()
	}
	else {
	console.log(`-------------------------------------------------------------------`);
	}
	}

	const sleep = (seconds) => {
	return new Promise(r => setTimeout(r, seconds * 1000));
	}

	const getCSRFToken = () => {
	const cookieName = 'fab_csrftoken';
	return document.cookie.match('(^\|;)\\s' + cookieName + '\\s=\\s*([^;]+)')?.pop() \|\| '';
	}

	const postResource = async (path, body) => {
	const baseUrl = "https://www.fab.com/i/listings";
	const formData = new FormData();

	for (const name in body) {
	formData.append(name, body[name]);
	}

	const response = await fetch(`${baseUrl}/${path}`, {
	headers: {
	"accept": "application/json, text/plain, /",
	"x-csrftoken": getCSRFToken(),
	},
	method: "POST",
	body: formData,
	});

	if (!response.ok) {
	throw new Error(`Failed request with ${response.status} status code`);
	}

	return await response.text();
	}

	const getResource = async (path) => {
	const baseUrl = "https://www.fab.com/i/listings";

	const response = await fetch(`${baseUrl}/${path}`, {
	headers: {
	"accept": "application/json, text/plain, /",
	"x-csrftoken": getCSRFToken(),
	},
	method: "GET",
	});

	if (!response.ok) {
	throw new Error(`Failed request with ${response.status} status code`);
	}

	return await response.json();
	}

	const fetchItem = async (itemId) => {
	try {
	return await getResource(itemId);
	}
	catch (error) {
	throw new Error(`Failed to fetch item ${itemId} due to: ${error}`)
	}
	}

	const claimItem = async (item) => {
	let offer_id = item.licenses.find((license) => license.slug == "professional").offerId;
	// offer_id = item.licenses[0].offerId;

	try {
	await postResource(`${item.uid}/add-to-library`, { offer_id });
	}
	catch (error) {
	throw new Error(`Failed to claim item ${item.title} (${item.uid}) due to: ${error}`)
	}
	}

	const handleItem = async (listItem) => {
	if (SKIP_ITEM_IDS.includes(listItem.uid)) {
	console.log(`-> Skipping ${listItem.title} (id: ${listItem.uid})`);
	return;
	}

	if (claimedAssets.has(listItem.uid)) {
	console.log(`-> Already claimed ${listItem.title} (id: ${listItem.uid})`);
	return;
	}

	console.log(`-> Claiming ${listItem.title} (id: ${listItem.uid})`);

	if (CLAIM) {
	const item = await fetchItem(listItem.uid);
	await claimItem(item);
	}

	claimedAssets.add(listItem.uid);

	await sleep(WAIT_TIME_BETWEEN_CLAIMS);
	}

	const fetchItems = async (filterIndex, pageCursor) => {
	const filters = FILTERS[filterIndex];

	try {
	const cursorQuery = pageCursor ? `&cursor=${pageCursor}` : ''
	return await getResource(`search?seller=Quixel&${filters}${cursorQuery}`);
	}
	catch (error) {
	throw new Error(`Failed to get page ${pageCursor \|\| 'null'} due to: ${error}`);
	}
	}

	const handleListPage = async (filterIndex, pageCursor) => {
	console.log(`-> Getting content from page cursor ${pageCursor \|\| '<not-set>'}, with filter index ${filterIndex}...`);
	let page = await fetchItems(filterIndex, pageCursor);
	console.log(`-> Found ${page.results.length} results on this page`);

	if (PARALLEL_CLAIM) {
	const promises = page.results.map((item) => handleItem(item));
	await Promise.all(promises)
	}
	else {
	for (const item of page.results) {
	await handleItem(item);
	}
	}

	await sleep(WAIT_TIME_BETWEEN_PAGES);
	clearConsole();

	totalPages += 1;

	if (pageCursor != null && pageCursor == page.cursors.next) {
	throw new Error(`Cursor loop found on page ${pageCursor}; this is a problem on FAB's API, not this script`);
	}

	return page.cursors.next
	}

	// Main loop function
	const main = async () => {
	clearConsole();

	try {
	for (let filterIndex = INITIAL_FILTER_INDEX; filterIndex < FILTERS.length; filterIndex += 1) {
	let pageCursor = INITIAL_PAGE_CURSOR;

	do {
	console.log(`-> Pages processed so far: ${totalPages} pages`);
	console.log(`-> Assets claimed so far: ${claimedAssets.size} assets`);

	pageCursor = await handleListPage(filterIndex, pageCursor)
	} while (pageCursor != null);
	}

	console.log('-> Script execution completed successfully!')
	console.log(`-> Total pages processed: ${totalPages} pages`);
	console.log(`-> Total assets claimed: ${claimedAssets.size} assets`);
	}
	catch (error) {
	console.error(`-> ${error.message}`);
	console.error("-> Try waiting for a couple of minutes, then re-running the script by changing INITIAL_FILTER_INDEX and INITIAL_PAGE_CURSOR");
	console.error(error);
	}
	}

	return await main();
	}

	claimQuixelAssets();