/sourceforge/projects

POST /api/sourceforge/projects

Price: 1 credit

Get SourceForge project metadata by shortname/slug or project URL

How to use it

Get full metadata of a SourceForge project by its shortname/slug or project URL. Returns id, name, description, summary, status, creation date, homepage, developers, social networks, tools/trackers, screenshots, license/language/OS/topic/audience/environment/translation/development-status categories, labels, and icon.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• project string required — Project shortname/slug or a SourceForge project URL (examples: "sevenzip", "https://sourceforge.net/projects/sevenzip/"; minLength: 1)

Response

• @type string (default: "SourceforgeProject")
• id string required
• alias string required
• name string (default: "")
• description string nullable
• summary string nullable
• status string (default: "")
• is_private boolean (default: false)
• created_at integer nullable
• homepage_url string nullable
• video_url string nullable
• moved_to_url string nullable
• preferred_support_url string nullable
• image string nullable
• labels array (default: [])
• developers array (default: [])
  • @type string (default: "SourceforgeDeveloper")
  • alias string (default: "")
  • name string (default: "")
  • web_url string (default: "")
• social_networks array (default: [])
  • @type string (default: "SourceforgeSocialNetwork")
  • network string (default: "")
  • web_url string nullable
• tools array (default: [])
  • @type string (default: "SourceforgeTool")
  • name string (default: "")
  • mount_point string (default: "")
  • mount_label string (default: "")
  • web_url string (default: "")
  • api_url string nullable
• screenshots array (default: [])
  • @type string (default: "SourceforgeScreenshot")
  • image string (default: "")
  • thumbnail string nullable
  • caption string nullable
• audiences array (default: [])
  • @type string (default: "SourceforgeCategoryItem")
  • id integer required
  • alias string (default: "")
  • name string (default: "")
  • fullpath string (default: "")
• development_status array (default: [])
  • @type string (default: "SourceforgeCategoryItem")
  • id integer required
  • alias string (default: "")
  • name string (default: "")
  • fullpath string (default: "")
• environments array (default: [])
  • @type string (default: "SourceforgeCategoryItem")
  • id integer required
  • alias string (default: "")
  • name string (default: "")
  • fullpath string (default: "")
• languages array (default: [])
  • @type string (default: "SourceforgeCategoryItem")
  • id integer required
  • alias string (default: "")
  • name string (default: "")
  • fullpath string (default: "")
• licenses array (default: [])
  • @type string (default: "SourceforgeCategoryItem")
  • id integer required
  • alias string (default: "")
  • name string (default: "")
  • fullpath string (default: "")
• translations array (default: [])
  • @type string (default: "SourceforgeCategoryItem")
  • id integer required
  • alias string (default: "")
  • name string (default: "")
  • fullpath string (default: "")
• operating_systems array (default: [])
  • @type string (default: "SourceforgeCategoryItem")
  • id integer required
  • alias string (default: "")
  • name string (default: "")
  • fullpath string (default: "")
• databases array (default: [])
  • @type string (default: "SourceforgeCategoryItem")
  • id integer required
  • alias string (default: "")
  • name string (default: "")
  • fullpath string (default: "")
• topics array (default: [])
  • @type string (default: "SourceforgeCategoryItem")
  • id integer required
  • alias string (default: "")
  • name string (default: "")
  • fullpath string (default: "")
• web_url string (default: "")

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — Project not found Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.