> ## Documentation Index > Fetch the complete documentation index at: https://docs.theswarm.com/llms.txt > Use this file to discover all available pages before exploring further. # API Query Tester > Test your OpenSearch DSL queries against the Swarm API and see real results. export const SwarmQueryTester = () => { const executeUrl = "https://theswarm-query-builder.vercel.app/api/execute"; const [apiKey, setApiKey] = useState(""); const [showApiKey, setShowApiKey] = useState(false); const [query, setQuery] = useState(""); const [queryType, setQueryType] = useState("profiles"); const [maxResults, setMaxResults] = useState(20); const [result, setResult] = useState(""); const [loading, setLoading] = useState(false); const [paginationToken, setPaginationToken] = useState(null); const [totalCount, setTotalCount] = useState(null); const [copied, setCopied] = useState(false); useEffect(() => { const savedApiKey = localStorage.getItem("swarm-api-key"); if (savedApiKey) { setApiKey(savedApiKey); } }, []); const handleApiKeyChange = e => { const newApiKey = e.target.value; setApiKey(newApiKey); if (newApiKey.trim()) { localStorage.setItem("swarm-api-key", newApiKey); } else { localStorage.removeItem("swarm-api-key"); } }; const clearApiKey = () => { setApiKey(""); localStorage.removeItem("swarm-api-key"); }; const runQuery = async (parsedQuery, token) => { const response = await fetch(executeUrl, { method: "POST", headers: { "Content-Type": "application/json" }, body: JSON.stringify({ query: parsedQuery, type: queryType, apiKey: apiKey.trim(), limit: maxResults, paginationToken: token || null }) }); const data = await response.json().catch(() => null); if (response.ok && data?.success) { setResult(JSON.stringify(data.data, null, 2)); setTotalCount(data.data?.total_count ?? null); setPaginationToken(data.data?.pagination_token || null); } else { setResult(`Error: ${data?.error || `Request failed (status ${response.status})`}`); } }; const testQuery = async () => { if (!apiKey.trim() || !query.trim()) return; setLoading(true); setResult(""); setTotalCount(null); setPaginationToken(null); let parsedQuery; try { parsedQuery = JSON.parse(query); } catch (parseError) { setResult(`Error: Invalid JSON query format - ${parseError.message}`); setLoading(false); return; } try { await runQuery(parsedQuery, null); } catch (error) { console.error("Execute failed:", error); setResult(`Error: ${error?.message || "Failed to connect to server"}`); } finally { setLoading(false); } }; const loadNextPage = async () => { if (!paginationToken) return; let parsedQuery; try { parsedQuery = JSON.parse(query); } catch (parseError) { setResult(`Error: Invalid JSON query format - ${parseError.message}`); return; } setLoading(true); try { await runQuery(parsedQuery, paginationToken); } catch (error) { console.error("Execute failed:", error); setResult(`Error: ${error?.message || "Failed to connect to server"}`); } finally { setLoading(false); } }; const resetPagination = () => { setPaginationToken(null); setResult(""); }; const copyToClipboard = async () => { if (!result) return; try { await navigator.clipboard.writeText(result); setCopied(true); setTimeout(() => setCopied(false), 1500); } catch (error) { console.error("Failed to copy to clipboard:", error); } }; const downloadResults = () => { if (!result || result.startsWith("Error:")) return; try { const data = JSON.parse(result); const dataStr = JSON.stringify(data, null, 2); const dataBlob = new Blob([dataStr], { type: "application/json" }); const url = URL.createObjectURL(dataBlob); const link = document.createElement("a"); link.href = url; link.download = `swarm-query-results-${Date.now()}.json`; document.body.appendChild(link); link.click(); document.body.removeChild(link); URL.revokeObjectURL(url); } catch (error) { console.error("Failed to download results:", error); } }; const handleQueryChange = e => { setQuery(e.target.value); if (paginationToken) { setPaginationToken(null); } }; const renderJSON = text => { if (!text) return null; if (text.startsWith("Error:")) { return
{text}
; } try { const jsonObj = JSON.parse(text); const renderValue = (value, indent = 0) => { const spaces = (" ").repeat(indent); if (value === null) { return null; } if (typeof value === "boolean") { return {String(value)}; } if (typeof value === "number") { return {value}; } if (typeof value === "string") { return "{value}"; } if (Array.isArray(value)) { if (value.length === 0) { return <> [ ] ; } return <> [
{value.map((item, index) =>
{spaces} {renderValue(item, indent + 1)} {index < value.length - 1 && ,}
)}
{spaces}] ; } if (typeof value === "object") { const keys = Object.keys(value); if (keys.length === 0) { return <> {`{`} {`}`} ; } return <> {`{`}
{keys.map((key, index) =>
{spaces} "{key}" : {renderValue(value[key], indent + 1)} {index < keys.length - 1 && ,}
)}
{spaces}{`}`} ; } return String(value); }; return renderValue(jsonObj); } catch (e) { return
{text}
; } }; return
{}
{}
Swarm API Key
{apiKey && }
Your API key is stored locally in your browser. It is sent only to proxy your request to the Swarm API and is never stored on our servers.
{}
Max Results
setMaxResults(parseInt(e.target.value) || 20)} style={{ width: "100%", padding: "12px 16px", border: "1px solid rgba(255,255,255,0.2)", borderRadius: "8px", background: "rgba(0,0,0,0.5)", color: "#f9fafb", fontSize: "14px", fontFamily: "inherit" }} />
{}
OpenSearch DSL Query