{"openapi":"3.1.0","info":{"title":"Spiderlook API","description":"Public Spiderlook API for competitive intelligence: organizations, tracked companies, ads, social posts, website changes, and battlecards.","version":"1.0.0"},"servers":[{"url":"/v1"},{"url":"https://api.spiderlook.com/v1","description":"Production"}],"paths":{"/organizations/{slug}/me":{"get":{"tags":["public-v1"],"summary":"Current organization","operationId":"read_org_me_organizations__slug__me_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"slug","in":"path","required":true,"schema":{"type":"string","title":"Slug"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Read Org Me Organizations  Slug  Me Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/organizations/{slug}/tracked-companies":{"get":{"tags":["public-v1"],"summary":"List tracked companies","description":"Cursor pagination for tracked companies (your brand, rivals, benchmarks).\n\nCursor format: base64(JSON) with keys {after_created_at, after_id}.","operationId":"list_tracked_companies_organizations__slug__tracked_companies_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"slug","in":"path","required":true,"schema":{"type":"string","title":"Slug"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"default":50,"title":"Limit"}},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor"}},{"name":"since","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Since"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicCursorPage_PublicTrackedCompany_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/organizations/{slug}/ads":{"get":{"tags":["public-v1"],"summary":"List ads","description":"List Meta and Google ads for tracked companies in the organization.","operationId":"list_ads_organizations__slug__ads_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"slug","in":"path","required":true,"schema":{"type":"string","title":"Slug"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"default":50,"title":"Limit"}},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor"}},{"name":"since","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Since"}},{"name":"updated_since","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated Since"}},{"name":"tracked_company","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Tracked Company"}},{"name":"platform","in":"query","required":false,"schema":{"anyOf":[{"enum":["meta","google"],"type":"string"},{"type":"null"}],"title":"Platform"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicCursorPage_PublicAd_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/organizations/{slug}/social-posts":{"get":{"tags":["public-v1"],"summary":"List social posts","description":"List social posts across Instagram, TikTok, Facebook, LinkedIn, YouTube, and X.","operationId":"list_social_posts_organizations__slug__social_posts_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"slug","in":"path","required":true,"schema":{"type":"string","title":"Slug"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"default":50,"title":"Limit"}},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor"}},{"name":"since","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Since"}},{"name":"tracked_company","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Tracked Company"}},{"name":"network","in":"query","required":false,"schema":{"anyOf":[{"enum":["instagram","tiktok","facebook","linkedin","youtube","x"],"type":"string"},{"type":"null"}],"title":"Network"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicCursorPage_PublicSocialPost_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/organizations/{slug}/website-changes":{"get":{"tags":["public-v1"],"summary":"List website changes","description":"List watched website page updates for tracked companies.","operationId":"list_website_changes_organizations__slug__website_changes_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"slug","in":"path","required":true,"schema":{"type":"string","title":"Slug"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"default":50,"title":"Limit"}},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor"}},{"name":"since","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Since"}},{"name":"tracked_company","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Tracked Company"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicCursorPage_PublicWebsiteChange_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/organizations/{slug}/battlecards":{"get":{"tags":["public-v1"],"summary":"List battlecards","description":"List battlecards for tracked companies in the organization.","operationId":"list_battlecards_organizations__slug__battlecards_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"slug","in":"path","required":true,"schema":{"type":"string","title":"Slug"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"default":50,"title":"Limit"}},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor"}},{"name":"since","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Since"}},{"name":"tracked_company","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Tracked Company"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicCursorPage_PublicBattlecard_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/organizations/{slug}/battlecards/{battlecard_id}":{"get":{"tags":["public-v1"],"summary":"Get a battlecard","operationId":"read_battlecard_organizations__slug__battlecards__battlecard_id__get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"slug","in":"path","required":true,"schema":{"type":"string","title":"Slug"}},{"name":"battlecard_id","in":"path","required":true,"schema":{"type":"string","title":"Battlecard Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicBattlecard"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"PublicAd":{"properties":{"id":{"type":"string","title":"Id"},"platform":{"type":"string","enum":["meta","google"],"title":"Platform"},"tracked_company":{"$ref":"#/components/schemas/PublicTrackedCompanyRef"},"text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Text"},"creative":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Creative"},"media_urls":{"items":{"type":"string"},"type":"array","title":"Media Urls"},"landing_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Landing Url"},"first_seen":{"type":"string","format":"date-time","title":"First Seen"},"last_seen":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Last Seen"},"is_active":{"type":"boolean","title":"Is Active"},"library_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Library Url"}},"type":"object","required":["id","platform","tracked_company","first_seen","is_active"],"title":"PublicAd"},"PublicBattlecard":{"properties":{"id":{"type":"string","title":"Id"},"tracked_company":{"$ref":"#/components/schemas/PublicTrackedCompanyRef"},"content":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Content"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"},"approved_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Approved At"}},"type":"object","required":["id","tracked_company","updated_at"],"title":"PublicBattlecard"},"PublicCursorPage_PublicAd_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/PublicAd"},"type":"array","title":"Items"},"next_cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next Cursor"},"limit":{"type":"integer","title":"Limit"}},"type":"object","required":["items","limit"],"title":"PublicCursorPage[PublicAd]"},"PublicCursorPage_PublicBattlecard_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/PublicBattlecard"},"type":"array","title":"Items"},"next_cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next Cursor"},"limit":{"type":"integer","title":"Limit"}},"type":"object","required":["items","limit"],"title":"PublicCursorPage[PublicBattlecard]"},"PublicCursorPage_PublicSocialPost_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/PublicSocialPost"},"type":"array","title":"Items"},"next_cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next Cursor"},"limit":{"type":"integer","title":"Limit"}},"type":"object","required":["items","limit"],"title":"PublicCursorPage[PublicSocialPost]"},"PublicCursorPage_PublicTrackedCompany_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/PublicTrackedCompany"},"type":"array","title":"Items"},"next_cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next Cursor"},"limit":{"type":"integer","title":"Limit"}},"type":"object","required":["items","limit"],"title":"PublicCursorPage[PublicTrackedCompany]"},"PublicCursorPage_PublicWebsiteChange_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/PublicWebsiteChange"},"type":"array","title":"Items"},"next_cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next Cursor"},"limit":{"type":"integer","title":"Limit"}},"type":"object","required":["items","limit"],"title":"PublicCursorPage[PublicWebsiteChange]"},"PublicSocialPost":{"properties":{"id":{"type":"string","title":"Id"},"network":{"type":"string","enum":["instagram","tiktok","facebook","linkedin","youtube","x"],"title":"Network"},"tracked_company":{"$ref":"#/components/schemas/PublicTrackedCompanyRef"},"url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Url"},"text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Text"},"posted_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Posted At"},"engagement":{"anyOf":[{"additionalProperties":{"type":"integer"},"type":"object"},{"type":"null"}],"title":"Engagement"}},"type":"object","required":["id","network","tracked_company"],"title":"PublicSocialPost"},"PublicTrackedCompany":{"properties":{"id":{"type":"string","title":"Id"},"name":{"type":"string","title":"Name"},"url":{"type":"string","title":"Url"},"role":{"type":"string","enum":["your_brand","rival","benchmark"],"title":"Role","description":"Entity label: your_brand, rival, or benchmark"},"entity_label":{"type":"string","enum":["your_brand","rival","benchmark"],"title":"Entity Label","description":"Same as role; rival, benchmark, or your_brand"},"project":{"$ref":"#/components/schemas/PublicTrackedProject"},"daily_scans":{"type":"boolean","title":"Daily Scans","description":"Whether daily scans are on for this company"},"created_at":{"type":"string","format":"date-time","title":"Created At"}},"type":"object","required":["id","name","url","role","entity_label","project","daily_scans","created_at"],"title":"PublicTrackedCompany","description":"Slim public contract for tracked companies (your brand, rivals, benchmarks)."},"PublicTrackedCompanyRef":{"properties":{"id":{"type":"string","title":"Id"},"name":{"type":"string","title":"Name"},"url":{"type":"string","title":"Url"},"entity_label":{"type":"string","enum":["your_brand","rival","benchmark"],"title":"Entity Label"}},"type":"object","required":["id","name","url","entity_label"],"title":"PublicTrackedCompanyRef","description":"Nested tracked-company reference on resource endpoints."},"PublicTrackedProject":{"properties":{"id":{"type":"string","title":"Id"},"slug":{"type":"string","title":"Slug"},"name":{"type":"string","title":"Name"}},"type":"object","required":["id","slug","name"],"title":"PublicTrackedProject"},"PublicWebsiteChange":{"properties":{"id":{"type":"string","title":"Id"},"tracked_company":{"$ref":"#/components/schemas/PublicTrackedCompanyRef"},"page_url":{"type":"string","title":"Page Url"},"detected_at":{"type":"string","format":"date-time","title":"Detected At"},"deep_link":{"type":"string","title":"Deep Link"}},"type":"object","required":["id","tracked_company","page_url","detected_at","deep_link"],"title":"PublicWebsiteChange"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}},"securitySchemes":{"HTTPBearer":{"type":"http","scheme":"bearer"}}}}