{"uid":"cap_T2LO2ODAdDLXfDOmTrcm_","slug":"s2ar-symbol-listing-file-skeleton-916e24bb","name":"s2ar Symbol Listing (File Skeleton)","description":"File skeleton from a GitHub repo — every function, type and method with line ranges, no bodies. GET ?repo=&file=","url":"https://api.s2ar.dev/x402/v1/sym/ls?utm_source=zero.xyz","method":"GET","headers":{},"bodySchema":{"type":"object","$schema":"https://json-schema.org/draft/2020-12/schema","required":["input"],"properties":{"input":{"type":"object","required":["type","method","queryParams"],"properties":{"type":{"type":"string","const":"http"},"method":{"enum":["GET"],"type":"string"},"headers":{"type":"object","additionalProperties":{"type":"string"}},"queryParams":{"type":"object","required":["repo","file"],"properties":{"ref":{"type":"string","description":"branch, tag or commit; the default branch when omitted"},"file":{"type":"string","description":"path inside the repository"},"repo":{"type":"string","description":"a public GitHub, GitLab or Codeberg repository: owner/repo, github.com/owner/repo or its https URL"}},"additionalProperties":{"type":"string"}}},"additionalProperties":false},"output":{"type":"object","required":["type"],"properties":{"type":{"type":"string"},"example":{"type":"object"}}}}},"responseSchema":null,"example":null,"exampleRequest":null,"tags":["x402"],"displayCostAmount":"0.005","displayCostAsset":"USDC","priceDynamic":false,"priceHint":null,"priceStatus":"priced","priceSource":"probe","requiresHandshake":false,"reviewCount":0,"rating":{"score":"0.00","successRate":"0.00","reviews":0,"stars":null,"state":"unrated"},"availabilityStatus":"unknown","priceObserved":null,"sessionDeposit":null,"pricing":{"kind":"static","summary":"$0.005/call","primary":{"kind":"static","protocol":"x402","network":"base","amountUsd":"0.005","per":"call","confidence":"exact"},"accepted":[{"kind":"static","protocol":"x402","network":"base","amountUsd":"0.005","per":"call","confidence":"exact"}]},"paymentMethods":[{"uid":"pm_RZ0L87s2vaRDJD7ynU51z","protocol":"x402","methodType":"crypto","chain":"base","mode":"charge","costAmount":"0.005","costPer":"request","priority":0,"asset":"0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913","unit":"request","depositMicros":null,"planRef":null}],"brandName":null,"brandSlug":null,"brandBaseUrl":null,"brandDocsUrl":null,"whatItDoes":"Returns a structural skeleton of a source file from a GitHub/GitLab/Codeberg repo — every function, type, and method with their line ranges but without body code.","exampleAgentPrompt":"Give me a skeleton of the file `src/parser/lexer.py` in the repo `pallets/jinja` — I want to see all the functions, types, and methods with their line ranges, but not the actual code bodies.","exampleUseCases":[{"title":"Code review prep for large file","prompt":"Before I start reviewing the PR, show me a skeleton of `compiler/codegen.go` in `golang/go` on the `master` branch — just the function and type signatures with line numbers so I know what's in there."},{"title":"AI agent indexing repo structure","prompt":"List all the symbols defined in `src/index.ts` in `microsoft/TypeScript` — functions, types, interfaces, everything — with their line ranges so I can decide which ones to fetch in full."},{"title":"Onboarding to unfamiliar codebase","prompt":"I'm trying to understand the `requests/sessions.py` file in the `psf/requests` repo. Can you show me all the classes and methods defined there with their line numbers, but skip the actual implementation?"}],"resultDescription":"A structured skeleton of the specified source file listing every function, type, class, and method definition with their start and end line ranges, but without body/implementation code. Useful for understanding file layout and navigating to specific symbols.","failureModes":["Repository not found or is private — returns an error indicating the repo is inaccessible","File path does not exist in the repository at the given ref — returns a not-found error","Ref (branch/tag/commit) does not exist — returns a reference resolution error","File is not a recognized source code format — may return empty or partial results","Rate limits or payment failure — returns a 402 or rate-limit error","Malformed repo identifier — returns a validation error"],"whenToPreferThis":"Use this endpoint when you need a high-level structural overview of a source file before fetching individual symbol bodies. It is ideal for code navigation, pre-indexing a file before targeted symbol lookups, or understanding a large file's layout without incurring the cost of downloading full implementations. Prefer this over full-file fetch when token budget is a concern, and over semantic or name-based search when you want a complete inventory of all symbols in a specific file.","instructions":null,"reviewSummary":null,"reviewSummaryHighlights":null,"reviewSummaryConcerns":null,"reviewSummaryGeneratedAt":null,"activationCount":0,"lastUsedAt":null,"lastSuccessfullyRanAt":null,"lastHealthCheckAt":"2026-10-10T12:36:04.273Z","isFirstParty":false,"canonicalSlug":"s2ar-symbol-listing-file-skeleton-916e24bb"}